bachir/popsu-d7
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

security upadtes

Browse Source
This commit is contained in:
Bachir Soussi Chiadmi
2017-09-25 15:16:35 +02:00
parent 650c6448e4
commit 8d8a60b615
240 changed files with 3022 additions and 1300 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
sites/all/modules/smtp/CHANGELOG.txt
View File

@@ -1,60 +0,0 @@
2009-11-12 Franz G Vanderlinde franz@chuva-inc.com
* bug report #132903 by johngriffin: definitive integration between Mimemail and SMTP
* feature request #132903 by mishhh,franz: Mimemail integration
* bug report #465750 from bbirtle,franz: Better parsing and handling of charsets
* bug report #207925 by Wim Leers,franz: Adds reply-to in case there are none.
* file sv.po was initially added on branch DRUPAL-6--1.
* file fr.po was initially added on branch DRUPAL-6--1.
2008-09-23 Jason Flatt drupal@oadaeh.net
* smtp.module: Added the final touch: a workaround for a multipart/mixed
logic error in PHPMailer.
* po/smtp.pot: Moved to translations/.
* class.phpmailer.php.2.0.2.patch, class.phpmailer.php.2.2.1.patch: Added
to apply a work around to a logic error in PHPMailer, which is reported
here:
http://sourceforge.net/tracker/index.php?func=detail&aid=2125119&group_id=26031&atid=385707
2008-09-18 Jason Flatt drupal@oadaeh.net
* smtp.module: After many hours of research, code refactoring and testing,
this module is hopefully MIME 1.0 compliant.
2008-08-26 Jason Flatt drupal@oadaeh.net
* smtp.module: Changed admin/reports/watchdog to admin/reports/dblog, per
greggles in IRC.
2008-07-17 Jason Flatt drupal@oadaeh.net
* po: Changed to translations (http://drupal.org/node/262455).
translations/de.po: Added (http://drupal.org/node/262455).
Added e-mail address validation check for the settings page.
Added additional from e-mail address validation checking during the
processing of the e-mail message (http://drupal.org/node/281599).
2008-07-12 Jason Flatt drupal@oadaeh.net
* smtp.module: Uncommented two functions that set the from name and e-mail
address, per jcwatson11 in http://drupal.org/node/281599.
Changed the way two wathcdog message were formatted.
po/smtp.pot: Added.
2008-07-11 Jason Flatt drupal@oadaeh.net
* smtp.module: Changed the encryption protocol variable name from
$mail->Protocol to $mail->SMTPSecure, per root_of_roots in
http://drupal.org/node/280081.
Added an administrative option for enabling debugging, per dennys in
http://drupal.org/node/199843.
Made the "On" and "Off" radio options translatable, per
rastatt@drupal.org in http://drupal.org/node/262455#comment-917055.
2008-07-06 Jason Flatt drupal@oadaeh.net
* smtp.module: Continued upgrade process to Drupal 6.x compatibility.
Tweaked the inline comments and documentation.
Removed _smtp_initialize_language().
2008-07-04 Jason Flatt drupal@oadaeh.net
* smtp.module: Continued upgrade process to Drupal 6.x compatibility.
Added $mail->ContentType = 'multipart/mixed';
2008-07-03 Jason Flatt drupal@oadaeh.net
* smtp.module: Began the upgrade process to Drupal 6.x compatibility.

20
sites/all/modules/smtp/README.txt
View File

@@ -1,4 +1,3 @@
SMTP Authentication Support module for Drupal 7.x.
This module adds SMTP functionality to Drupal.
@@ -16,10 +15,10 @@ INSTALLATION INSTRUCTIONS
1. Copy the files included in the tarball into a directory named "smtp" in
your Drupal sites/all/modules/ directory.
2. Login as site administrator.
3. Enable the SMTP Authentication Support module on the Administer -> Site
building -> Modules page.
4. Fill in required settings on the Administer -> Site configuration -> SMTP
Authentication Support page.
3. Enable the SMTP Authentication Support module on the Administer -> Modules
page.
4. Fill in required settings on the Administer -> Configuration -> System ->
SMTP Authentication Support page.
5. Enjoy.
NOTES
@@ -27,10 +26,10 @@ NOTES
This module sends email by connecting to an SMTP server. Therefore, you need
to have access to an SMTP server for this module to work.
Drupal will often use the email address entered into Administrator -> Site
configuration -> E-mail address as the from address. It is important for
this to be the correct address and some ISPs will block email that comes from
an invalid address.
Drupal will often use the email address entered into Administrator ->
Configuration -> Site information -> E-mail address as the from address. It is
important for this to be the correct address and some ISPs will block email that
comes from an invalid address.
This module no longer uses the PHPMailer package as an external library, instead
a slimmed down version of the library have been relicensed and integrated with the
@@ -41,3 +40,6 @@ extension is working. If the SMTP module detects openssl is available it
will display the options in the modules settings page.
Sending mail to Gmail requires SSL or TLS.
If the Maillog module (https://www.drupal.org/project/maillog) is installed, it
can be used to keep copies of all messages sent through the site.

215
sites/all/modules/smtp/smtp.admin.inc
View File

@@ -1,40 +1,23 @@
<?php
/**
* @file
* Administrative page code for the smtp module.
*
*/
/**
* Administrative settings.
*
* @return
* An array containing form items to place on the module settings page.
*/
function smtp_admin_settings() {
// Override the smtp_library variable.
if (module_exists('mimemail') &&
strpos(variable_get('smtp_library', ''), 'mimemail')) {
// don't touch smtp_library
if (variable_get('smtp_on', 0)) {
drupal_set_message(t('SMTP.module is active.'));
}
else {
if (variable_get('smtp_on', 0)) {
$smtp_path = drupal_get_filename('module', 'smtp');
if ($smtp_path) {
variable_set('smtp_library', $smtp_path);
drupal_set_message(t('SMTP.module is active.'));
}
// If drupal can't find the path to the module, display an error.
else {
drupal_set_message(t("SMTP.module error: Can't find file."), 'error');
}
}
// If this module is turned off, delete the variable.
else {
variable_del('smtp_library');
drupal_set_message(t('SMTP.module is INACTIVE.'));
}
drupal_set_message(t('SMTP.module is INACTIVE.'));
}
$logging = variable_get('smtp_debugging', SMTP_LOGGING_ERRORS);
$form['onoff'] = array(
'#type' => 'fieldset',
'#title' => t('Install options'),
@@ -42,10 +25,29 @@ function smtp_admin_settings() {
$form['onoff']['smtp_on'] = array(
'#type' => 'radios',
'#title' => t('Turn this module on or off'),
'#default_value' => variable_get('smtp_on', 0),
'#default_value' => variable_get('smtp_on', FALSE),
'#options' => array(1 => t('On'), 0 => t('Off')),
'#description' => t('To uninstall this module you must turn it off here first.'),
);
$form['onoff']['smtp_deliver'] = array(
'#type' => 'radios',
'#title' => t('Turn on delivery of emails'),
'#default_value' => variable_get('smtp_deliver', TRUE),
'#options' => array(1 => t('On'), 0 => t('Off')),
'#description' => t('With this option turned off, email messages will be queued up and processed as normal, but not actually delivered. This option should only be used for testing purposes.'),
);
$form['onoff']['smtp_queue'] = array(
'#type' => 'checkbox',
'#title' => t('Send mail by queue'),
'#default_value' => variable_get('smtp_queue', FALSE),
'#description' => t('Mails will be sent by drupal queue api.'),
);
$form['onoff']['smtp_queue_fail'] = array(
'#type' => 'checkbox',
'#title' => t('Retry sending mail on error.'),
'#default_value' => variable_get('smtp_queue_fail', FALSE),
'#description' => t('Mails will be added to the queue and sent by drupal queue api.'),
);
$form['server'] = array(
'#type' => 'fieldset',
@@ -71,6 +73,7 @@ function smtp_admin_settings() {
'#default_value' => variable_get('smtp_port', '25'),
'#description' => t('The default SMTP port is 25, if that is being blocked try 80. Gmail uses 465. See !url for more information on configuring for use with Gmail.', array('!url' => l(t('this page'), 'http://gmail.google.com/support/bin/answer.py?answer=13287'))),
);
// Only display the option if openssl is installed.
if (function_exists('openssl_open')) {
$encryption_options = array(
@@ -78,7 +81,7 @@ function smtp_admin_settings() {
'ssl' => t('Use SSL'),
'tls' => t('Use TLS'),
);
$encryption_description = t('This allows connection to an SMTP server that requires SSL encryption such as Gmail.');
$encryption_description = t('This allows connection to a SMTP server that requires SSL encryption such as Gmail.');
}
// If openssl is not installed, use normal protocol.
else {
@@ -109,7 +112,10 @@ function smtp_admin_settings() {
'#type' => 'password',
'#title' => t('Password'),
'#default_value' => variable_get('smtp_password', ''),
'#description' => t('SMTP password. Leave blank if you don\'t wish to change it.'),
'#description' => t('SMTP password. If you have already entered your password before, you should leave this field blank, unless you want to change the stored password.'),
'#attributes' => array(
'autocomplete' => 'off',
),
);
$form['email_options'] = array(
@@ -130,22 +136,28 @@ function smtp_admin_settings() {
);
$form['email_options']['smtp_allowhtml'] = array(
'#type' => 'checkbox',
'#title' => t('Allow to send e-mails formated as Html'),
'#title' => t('Allow to send e-mails formatted as Html'),
'#default_value' => variable_get('smtp_allowhtml', 0),
'#description' => t('Cheking this box will allow Html formated e-mails to be sent with the SMTP protocol.'),
'#description' => t('Checking this box will allow Html formatted e-mails to be sent with the SMTP protocol.'),
);
$form['client'] = array(
'#type' => 'fieldset',
'#title' => t('SMTP client settings'),
);
$form['client']['smtp_client_hostname'] = array(
'#type' => 'textfield',
'#title' => t('Hostname'),
'#default_value' => variable_get('smtp_client_hostname', ''),
'#description' => t('The hostname to use in the Message-Id and Received headers, and as the default HELO string. Leave blank for using %server_name.', array('%server_name' => isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : 'localhost.localdomain')),
);
$form['client']['smtp_client_helo'] = array(
'#type' => 'textfield',
'#title' => t('HELO'),
'#default_value' => variable_get('smtp_client_helo', ''),
'#description' => t('The SMTP HELO/EHLO of the message. Defaults to hostname (see above).'),
);
// If an address was given, send a test e-mail message.
$test_address = variable_get('smtp_test_address', '');
if ($test_address != '') {
// Clear the variable so only one message is sent.
variable_del('smtp_test_address');
global $language;
$params['subject'] = t('Drupal SMTP test e-mail');
$params['body'] = array(t('If you receive this message it means your site is capable of using SMTP to send e-mail.'));
drupal_mail('smtp', 'smtp-test', $test_address, $language, $params);
drupal_set_message(t('A test e-mail has been sent to @email. You may want to !check for any error messages.', array('@email' => $test_address, '!check' => l(t('check the logs'), 'admin/reports/dblog'))));
}
$form['email_test'] = array(
'#type' => 'fieldset',
'#title' => t('Send test e-mail'),
@@ -157,47 +169,132 @@ function smtp_admin_settings() {
'#description' => t('Type in an address to have a test e-mail sent there.'),
);
$form['smtp_debugging'] = array(
'#type' => 'checkbox',
'#title' => t('Enable debugging'),
'#default_value' => variable_get('smtp_debugging', 0),
'#description' => t('Checking this box will print SMTP messages from the server for every e-mail that is sent.'),
$form['debugging'] = array(
'#type' => 'fieldset',
'#title' => t('Debugging and logging'),
);
return system_settings_form($form);
} // End of smtp_admin_settings().
$logging_options = array(
SMTP_LOGGING_ALL => t('Log everything'),
SMTP_LOGGING_ERRORS => t('Errors only'),
SMTP_LOGGING_NONE => t('No logging'),
);
$form['debugging']['smtp_debugging'] = array(
'#type' => 'select',
'#title' => t('Logging'),
'#options' => $logging_options,
'#default_value' => $logging,
'#description' => t('Choose the appropriate log level. "Log everything" will log errors and informational messages when an email is sent. "Errors only" will only create a log entry when sending failed. "No logging" will disable all logging for this module.'),
);
$form['email_test']['smtp_reroute_address'] = array(
'#type' => 'textfield',
'#title' => t('E-mail address to reroute all emails to'),
'#default_value' => variable_get('smtp_reroute_address', ''),
'#description' => t('All emails sent by the site will be rerouted to this email address; use with caution.'),
);
$form['debugging']['maillog'] = array(
'#type' => 'fieldset',
'#title' => t('Maillog integration'),
);
if (!module_exists('maillog')) {
$form['debugging']['maillog']['#description'] = t('Installing the <a href="@url">Maillog module</a> also allows keeping copies of all emails sent through the site.', array('@url' => 'https://www.drupal.org/project/maillog'));
}
else {
$form['debugging']['maillog']['#description'] = t('The <a href="@url">Maillog module</a> is installed, it can also be used to keep copies of all emails sent through the site.', array('@url' => url('admin/config/development/maillog')));
$form['debugging']['maillog']['maillog_log'] = array(
'#type' => 'checkbox',
'#title' => t("Create table entries in maillog table for each e-mail."),
'#default_value' => variable_get('maillog_log', TRUE),
);
$form['debugging']['maillog']['maillog_devel'] = array(
'#type' => 'checkbox',
'#title' => t("Display the e-mails on page using devel module (if enabled)."),
'#default_value' => variable_get('maillog_devel', TRUE),
'#disabled' => !module_exists('devel'),
);
}
$form['#submit'][] = 'smtp_admin_settings_form_submit';
$form = system_settings_form($form);
$form['#submit'][] = 'smtp_admin_settings_submit_post_system_settings';
return $form;
}
/**
* Validation for the administrative settings form.
*
* @param form
* An associative array containing the structure of the form.
* @param form_state
* A keyed array containing the current state of the form.
*/
function smtp_admin_settings_validate($form, &$form_state) {
if ($form_state['values']['smtp_on'] == 1 && $form_state['values']['smtp_host'] == '') {
form_set_error('smtp_host', t('You must enter an SMTP server address.'));
form_set_error('smtp_host', t('You must enter a SMTP server address.'));
}
if ($form_state['values']['smtp_on'] == 1 && $form_state['values']['smtp_port'] == '') {
form_set_error('smtp_port', t('You must enter an SMTP port number.'));
form_set_error('smtp_port', t('You must enter a SMTP port number.'));
}
if ($form_state['values']['smtp_from'] && !valid_email_address($form_state['values']['smtp_from'])) {
form_set_error('smtp_from', t('The provided from e-mail address is not valid.'));
}
// If username is set empty, we must set both username/password empty as
// as well.
} // End of smtp_admin_settings_validate().
/**
* Submit handler().
*/
function smtp_admin_settings_form_submit($form, &$form_state) {
// Check if SMTP status has been changed.
if (
(!variable_get('smtp_on', FALSE) && $form_state['values']['smtp_on']) ||
(variable_get('smtp_on', FALSE) && !$form_state['values']['smtp_on'])
) {
$mail_modes = variable_get('mail_system', array('default-system' => 'DefaultMailSystem'));
// Turning on.
if ($form_state['values']['smtp_on']) {
variable_set('smtp_previous_mail_system', $mail_modes['default-system']);
$mail_modes['default-system'] = 'SmtpMailSystem';
}
// Turning off.
else {
$mail_modes['default-system'] = variable_get('smtp_previous_mail_system', 'DefaultMailSystem');
}
variable_set('mail_system', $mail_modes);
}
// If username is set empty, we must set both username/password empty as well.
if (empty($form_state['values']['smtp_username'])) {
$form_state['values']['smtp_password'] = '';
}
// A little hack. When form is presentend, the password is not shown (Drupal way of doing).
// So, if user submits the form without changing the password, we must prevent it from being reset.
// A little hack. When form is presentend, the password is not shown (Drupal
// way of doing). So, if user submits the form without changing the password,
// we must prevent it from being reset.
elseif (empty($form_state['values']['smtp_password'])) {
unset($form_state['values']['smtp_password']);
}
} // End of smtp_admin_settings_validate().
// Save the test address to send an email after all the settings have been
// updated.
$form_state['storage']['smtp']['smtp_test_address'] = $form_state['values']['smtp_test_address'];
unset($form_state['values']['smtp_test_address']);
}
/**
* Submit handler for the administrative settings form containing all
* functionality to be run after system_settings_form_submit.
*/
function smtp_admin_settings_submit_post_system_settings($form, &$form_state) {
// If an address was given, send a test e-mail message.
$test_address = $form_state['storage']['smtp']['smtp_test_address'];
if ($test_address != '') {
$language = language_default();
$params['subject'] = t('Drupal SMTP test e-mail');
$params['body'] = array(t('If you receive this message it means your site is capable of using SMTP to send e-mail.'));
drupal_mail('smtp', 'smtp-test', $test_address, $language, $params);
drupal_set_message(t('A test e-mail has been sent to @email. You may want to !check for any error messages.', array('@email' => $test_address, '!check' => l(t('check the logs'), 'admin/reports/dblog'))));
}
}

14
sites/all/modules/smtp/smtp.info
View File

@@ -3,15 +3,19 @@ description = "Allow for site emails to be sent through an SMTP server of your c
core = 7.x
package = Mail
configure = admin/config/system/smtp
files[] = smtp.module
files[] = smtp.admin.inc
files[] = smtp.mail.inc
files[] = smtp.phpmailer.inc
files[] = smtp.transport.inc
; Information added by drupal.org packaging script on 2012-09-21
version = "7.x-1.0-beta2"
; Test suite.
files[] = tests/smtp.unit.test
; For the tests the Maillog module is also required.
test_dependencies[] = maillog
; Information added by Drupal.org packaging script on 2017-06-27
version = "7.x-1.7"
core = "7.x"
project = "smtp"
datestamp = "1348254500"
datestamp = "1498593247"

112
sites/all/modules/smtp/smtp.install
View File

@@ -6,20 +6,45 @@
*/
/**
* Implementation of hook_install().
* Implements hook_requirements().
*/
function smtp_requirements($phase) {
$requirements = array();
if ($phase == 'runtime') {
if (variable_get('smtp_queue', FALSE) || variable_get('smtp_queue_fail', FALSE)) {
$count = db_query("SELECT count('name') FROM {queue} WHERE name='smtp_send_queue'")->fetchField();
$requirements['smtp_queue'] = array(
'title' => t('SMTP Queue'),
'value' => '',
'severity' => REQUIREMENT_INFO,
);
if ($count > 0) {
$requirements['smtp_queue']['value'] = format_plural($count, 'There is 1 message queued for delivery.', 'There are @count messages queued for delivery.', array('@count' => $count))
. ' '
. t('Delivery of the message(s) will be attempted the next time cron runs.');
}
else {
$requirements['smtp_queue']['value'] = t('There are no messages queued for delivery.');
}
}
}
return $requirements;
}
/**
* Implements hook_install().
*/
function smtp_install() {
variable_set('smtp_on', 0);
}
/**
* @file
* The uninstallation instructions for the SMTP Authentication Support.
*/
/**
* Implementation of hook_uninstall().
* Implements hook_uninstall().
*/
function smtp_uninstall() {
variable_del('smtp_allowhtml');
variable_del('smtp_from');
variable_del('smtp_fromname');
variable_del('smtp_host');
@@ -28,24 +53,79 @@ function smtp_uninstall() {
variable_del('smtp_password');
variable_del('smtp_port');
variable_del('smtp_protocol');
variable_del('smtp_test_address');
variable_del('smtp_queue');
variable_del('smtp_queue_fail');
variable_del('smtp_username');
if (variable_get('smtp_library', '') == drupal_get_path('module', 'smtp') . '/smtp.module') {
variable_del('smtp_library');
}
} // End of contact_attach_uninstall().
function smtp_enable() {
variable_set('mail_system', array('default-system' => 'SmtpMailSystem'));
variable_del('smtp_debugging');
variable_del('smtp_client_hostname');
variable_del('smtp_client_helo');
variable_del('smtp_deliver');
variable_del('smtp_reroute_address');
}
/**
* Implements hook_disable().
*/
function smtp_disable() {
variable_set('mail_system', array('default-system' => 'DefaultMailSystem'));
$mail_modes = variable_get('mail_system');
$mail_modes['default-system'] = 'DefaultMailSystem';
variable_set('mail_system', $mail_modes);
}
/**
* Implementations of hook_update_N().
*/
/**
* Upgrade to Drupal 7.x
*/
function smtp_update_7000() {
if (variable_get('smtp_on', 0) != 0) {
variable_set('mail_system', array('default-system' => 'SmtpMailSystem'));
}
// Not used any more in D7.
variable_del('smtp_library');
}
/**
* Back to default mail system if the status flag is off.
*/
function smtp_update_7100() {
$mail_modes = variable_get('mail_system', array('default-system' => 'DefaultMailSystem'));
if ($mail_modes['default-system'] == 'SmtpMailSystem' && !variable_get('smtp_on', FALSE)) {
$mail_modes['default-system'] = 'DefaultMailSystem';
variable_set('mail_system', $mail_modes);
}
}
/**
* Updating variable value now that new SMTP logging behavior has been
* implemented.
*/
function smtp_update_7101() {
$old_debugging_value = variable_get('smtp_debugging', 0);
$logging = SMTP_LOGGING_NONE;
if ($old_debugging_value == 1) {
$logging = SMTP_LOGGING_ERRORS;
}
variable_set('smtp_debugging', $logging);
}
/**
* Remove the unused 'smtp_library' variable.
*/
function smtp_update_7102() {
variable_del('smtp_library');
}
/**
* Delete the variable "smtp_test_address". It is unlikely that this would
* actually be set in the normal course of events, and it's no longer needed as
* it was replaced with a form submit handler.
*/
function smtp_update_7103() {
variable_del('smtp_test_address');
}

458
sites/all/modules/smtp/smtp.mail.inc
View File

@@ -46,35 +46,84 @@ class SmtpMailSystem implements MailSystemInterface {
* TRUE if the mail was successfully accepted, otherwise FALSE.
*/
public function mail(array $message) {
$id = $message['id'];
$to = $message['to'];
$from = $message['from'];
$subject = $message['subject'];
$body = $message['body'];
$headers = $message['headers'];
if (variable_get('smtp_queue', FALSE)
&& (!isset($message['params']['skip_queue']) || !$message['params']['skip_queue'])) {
smtp_send_queue($message);
if (variable_get('smtp_debugging', SMTP_LOGGING_ERRORS) == SMTP_LOGGING_ALL) {
watchdog('smtp', 'Queue sending mail to: @to', array('@to' => $message['to']));
}
return TRUE;
}
else {
return $this->mailWithoutQueue($message);
}
}
public function mailWithoutQueue(array $message) {
$to = $message['to'];
$from = $message['from'];
$body = $message['body'];
$headers = $message['headers'];
$subject = $message['subject'];
// Optionally reroute all emails to a single address.
$reroute_address = variable_get('smtp_reroute_address', '');
if (!empty($reroute_address)) {
$to = $reroute_address;
// Remove any CC and BCC headers that might have been set.
unset($headers['cc']);
unset($headers['bcc']);
}
// Create a new PHPMailer object - autoloaded from registry.
$mailer = new PHPMailer();
$logging = variable_get('smtp_debugging', SMTP_LOGGING_ERRORS);
// Turn on debugging, if requested.
if (variable_get('smtp_debugging', 0) == 1) {
if ($logging == SMTP_LOGGING_ALL && user_access('administer smtp module')) {
$mailer->SMTPDebug = TRUE;
}
// Set the from name and e-mail address.
if (variable_get('smtp_fromname', '') != '') {
$from_name = variable_get('smtp_fromname', '');
// Set the from name. First we try to get the name from i18n, in the case
// that it has been translated. The name is set according to the language
// of the email being sent.
$from_name = FALSE;
if (function_exists('i18n_variable_get')) {
// The 'language' value may be stored as an object.
$langcode = $message['language'];
if (is_object($langcode)) {
$langcode = $langcode->language;
}
if (i18n_variable_get('smtp_fromname', $langcode, '') != '') {
$from_name = i18n_variable_get('smtp_fromname', $langcode, '');
}
else {
// If value is not defined in settings, use site_name.
$from_name = i18n_variable_get('site_name', $langcode, '');
}
}
else {
// If value is not defined in settings, use site_name.
$from_name = variable_get('site_name', '');
if (variable_get('smtp_client_hostname', '') != '') {
$mailer->Hostname = variable_get('smtp_client_hostname', '');
}
if (variable_get('smtp_client_helo', '') != '') {
$mailer->Helo = variable_get('smtp_client_helo', '');
}
// If i18n is not enabled, we get the From Name through normal variables
if (!$from_name) {
if (variable_get('smtp_fromname', '') != '') {
$from_name = variable_get('smtp_fromname', '');
}
else {
// If value is not defined in settings, use site_name.
$from_name = variable_get('site_name', '');
}
}
//Hack to fix reply-to issue.
$properfrom = variable_get('site_mail', '');
if (!empty($properfrom)) {
$headers['From'] = $properfrom;
}
if (!isset($headers['Reply-To']) || empty($headers['Reply-To'])) {
if (strpos($from, '<')) {
$reply = preg_replace('/>.*/', '', preg_replace('/.*</', '', $from));
@@ -84,6 +133,11 @@ class SmtpMailSystem implements MailSystemInterface {
}
$headers['Reply-To'] = $reply;
}
$properfrom = variable_get('smtp_from', '');
if (!empty($properfrom)) {
$headers['From'] = $properfrom;
$from = $properfrom;
}
// Blank value will let the e-mail address appear.
@@ -93,42 +147,34 @@ class SmtpMailSystem implements MailSystemInterface {
// If smtp_from config option is blank, use site_email.
if (($from = variable_get('site_mail', '')) == '') {
drupal_set_message(t('There is no submitted from address.'), 'error');
watchdog('smtp', 'There is no submitted from address.', array(), WATCHDOG_ERROR);
if ($logging) {
watchdog('smtp', 'There is no submitted from address.', array(), WATCHDOG_ERROR);
}
return FALSE;
}
}
}
if (preg_match('/^"?.*"?\s*<.*>$/', $from)) {
// . == Matches any single character except line break characters \r and \n.
// * == Repeats the previous item zero or more times.
$from_name = preg_replace('/"?([^("\t\n)]*)"?.*$/', '$1', $from); // It gives: Name
$from = preg_replace("/(.*)\<(.*)\>/i", '$2', $from); // It gives: name@domain.tld
}
elseif (!valid_email_address($from)) {
drupal_set_message(t('The submitted from address (@from) is not valid.', array('@from' => $from)), 'error');
watchdog('smtp', 'The submitted from address (@from) is not valid.', array('@from' => $from), WATCHDOG_ERROR);
$from_comp = $this->_get_components($from);
if (!valid_email_address($from_comp['email'])) {
drupal_set_message(t('The submitted from address (@from) is not valid.', array('@from' => $from_comp['email'])), 'error');
if ($logging) {
watchdog('smtp', 'The submitted from address (@from) is not valid.', array('@from' => $from_comp['email']), WATCHDOG_ERROR);
}
return FALSE;
}
// Defines the From value to what we expect.
$mailer->From = $from;
$mailer->FromName = $from_name;
$mailer->Sender = $from;
$mailer->From = $from_comp['email'];
$mailer->FromName = empty($from_comp['name']) ? $from_name : $from_comp['name'];
$mailer->Sender = $from_comp['email'];
// Create the list of 'To:' recipients.
$torecipients = explode(',', $to);
foreach ($torecipients as $torecipient) {
if (strpos($torecipient, '<') !== FALSE) {
$toparts = explode(' <', $torecipient);
$toname = $toparts[0];
$toaddr = rtrim($toparts[1], '>');
}
else {
$toname = '';
$toaddr = $torecipient;
}
$mailer->AddAddress($toaddr, $toname);
$to_comp = $this->_get_components($torecipient);
$mailer->AddAddress($to_comp['email'], $to_comp['name']);
}
@@ -163,6 +209,8 @@ class SmtpMailSystem implements MailSystemInterface {
}
// Set the charset based on the provided value, otherwise set it to UTF-8 (which is Drupals internal default).
$mailer->CharSet = isset($vars['charset']) ? $vars['charset'] : 'UTF-8';
// If $vars is empty then set an empty value at index 0 to avoid a PHP warning in the next statement
$vars[0] = isset($vars[0])?$vars[0]:'';
switch ($vars[0]) {
case 'text/plain':
@@ -199,8 +247,9 @@ class SmtpMailSystem implements MailSystemInterface {
default:
// Everything else is unsuppored by PHPMailer.
drupal_set_message(t('The %header of your message is not supported by PHPMailer and will be sent as text/plain instead.', array('%header' => "Content-Type: $value")), 'error');
watchdog('smtp', 'The %header of your message is not supported by PHPMailer and will be sent as text/plain instead.', array('%header' => "Content-Type: $value"), WATCHDOG_ERROR);
if ($logging) {
watchdog('smtp', 'The %header of your message is not supported by PHPMailer and will be sent as text/plain instead.', array('%header' => "Content-Type: $value"), WATCHDOG_ERROR);
}
// Force the Content-Type to be text/plain.
$mailer->IsHTML(FALSE);
$content_type = 'text/plain';
@@ -210,16 +259,8 @@ class SmtpMailSystem implements MailSystemInterface {
case 'reply-to':
// Only add a "reply-to" if it's not the same as "return-path".
if ($value != $headers['Return-Path']) {
if (strpos($value, '<') !== FALSE) {
$replyToParts = explode('<', $value);
$replyToName = trim($replyToParts[0]);
$replyToName = trim($replyToName, '"');
$replyToAddr = rtrim($replyToParts[1], '>');
$mailer->AddReplyTo($replyToAddr, $replyToName);
}
else {
$mailer->AddReplyTo($value);
}
$replyto_comp = $this->_get_components($value);
$mailer->AddReplyTo($replyto_comp['email'], $replyto_comp['name']);
}
break;
@@ -228,6 +269,10 @@ class SmtpMailSystem implements MailSystemInterface {
break;
case 'return-path':
$returnpath_comp = $this->_get_components($value);
$mailer->Sender = $returnpath_comp['email'];
break;
case 'mime-version':
case 'x-mailer':
// Let PHPMailer specify these.
@@ -240,73 +285,52 @@ class SmtpMailSystem implements MailSystemInterface {
case 'cc':
$ccrecipients = explode(',', $value);
foreach ($ccrecipients as $ccrecipient) {
if (strpos($ccrecipient, '<') !== FALSE) {
$ccparts = explode(' <', $ccrecipient);
$ccname = $ccparts[0];
$ccaddr = rtrim($ccparts[1], '>');
}
else {
$ccname = '';
$ccaddr = $ccrecipient;
}
$mailer->AddBCC($ccaddr, $ccname);
$cc_comp = $this->_get_components($ccrecipient);
$mailer->AddCC($cc_comp['email'], $cc_comp['name']);
}
break;
case 'bcc':
$bccrecipients = explode(',', $value);
foreach ($bccrecipients as $bccrecipient) {
if (strpos($bccrecipient, '<') !== FALSE) {
$bccparts = explode(' <', $bccrecipient);
$bccname = $bccparts[0];
$bccaddr = rtrim($bccparts[1], '>');
}
else {
$bccname = '';
$bccaddr = $bccrecipient;
}
$mailer->AddBCC($bccaddr, $bccname);
$bcc_comp = $this->_get_components($bccrecipient);
$mailer->AddBCC($bcc_comp['email'], $bcc_comp['name']);
}
break;
case 'message-id':
$mailer->MessageID = $value;
break;
default:
// The header key is not special - add it as is.
$mailer->AddCustomHeader($key . ': ' . $value);
}
}
/**
* TODO
* Need to figure out the following.
// Add one last header item, but not if it has already been added.
$errors_to = FALSE;
foreach ($mailer->CustomHeader as $custom_header) {
if ($custom_header[0] = '') {
$errors_to = TRUE;
}
}
if ($errors_to) {
$mailer->AddCustomHeader('Errors-To: '. $from);
}
*/
/**
* TODO
* Need to figure out the following.
*
* Add one last header item, but not if it has already been added.
* $errors_to = FALSE;
* foreach ($mailer->CustomHeader as $custom_header) {
* if ($custom_header[0] = '') {
* $errors_to = TRUE;
* }
* }
* if ($errors_to) {
* $mailer->AddCustomHeader('Errors-To: '. $from);
* }
*/
// Add the message's subject.
$mailer->Subject = $subject;
// Processes the message's body.
switch ($content_type) {
case 'multipart/related':
$mailer->Body = $body;
/**
* TODO
* Firgure out if there is anything more to handling this type.
*/
// TODO: Figure out if there is anything more to handling this type.
break;
case 'multipart/alternative':
@@ -351,10 +375,10 @@ class SmtpMailSystem implements MailSystemInterface {
// $mailer->AltBody or $mailer->Body, depending on whether there is
// also a text/html part ot not.
if (strpos($body_part, 'multipart/alternative')) {
// Clean up the text.
$body_part = trim($this->_remove_headers(trim($body_part)));
// Get boundary ID from the Content-Type header.
$boundary2 = $this->_get_substring($body_part, 'boundary', '"', '"');
// Clean up the text.
$body_part = trim($this->_remove_headers(trim($body_part)));
// Split the body based on the boundary ID.
$body_parts2 = $this->_boundary_split($body_part, $boundary2);
@@ -369,10 +393,21 @@ class SmtpMailSystem implements MailSystemInterface {
}
// If plain/html within the body part, add it to $mailer->Body.
elseif (strpos($body_part2, 'text/html')) {
// Get the encoding.
$body_part2_encoding = trim($this->_get_substring($body_part2, 'Content-Transfer-Encoding', ':', "\n"));
// Clean up the text.
$body_part2 = trim($this->_remove_headers(trim($body_part2)));
// Include it as part of the mail object.
$mailer->Body = $body_part2;
// Check whether the encoding is base64, and if so, decode it.
if (drupal_strtolower($body_part2_encoding) == 'base64') {
// Include it as part of the mail object.
$mailer->Body = base64_decode($body_part2);
// Ensure the whole message is recoded in the base64 format.
$mailer->Encoding = 'base64';
}
else {
// Include it as part of the mail object.
$mailer->Body = $body_part2;
}
$mailer->ContentType = 'multipart/mixed';
}
}
@@ -403,14 +438,14 @@ class SmtpMailSystem implements MailSystemInterface {
$mailer->ContentType = 'multipart/mixed';
}
// Add the attachment.
elseif (strpos($body_part, 'Content-Disposition: attachment;')) {
elseif (strpos($body_part, 'Content-Disposition: attachment;') && !isset($message['params']['attachments'])) {
$file_path = $this->_get_substring($body_part, 'filename=', '"', '"');
$file_name = $this->_get_substring($body_part, ' name=', '"', '"');
$file_encoding = $this->_get_substring($body_part, 'Content-Transfer-Encoding', ' ', "\n");
$file_type = $this->_get_substring($body_part, 'Content-Type', ' ', ';');
if (file_exists($file_path)) {
if (!$mailer->AddAttachment($file_path, $file_name, $file_encoding, $filetype)) {
if (!$mailer->AddAttachment($file_path, $file_name, $file_encoding, $file_type)) {
drupal_set_message(t('Attahment could not be found or accessed.'));
}
}
@@ -428,10 +463,11 @@ class SmtpMailSystem implements MailSystemInterface {
$attachment = $body_part;
}
$attachment_new_filename = tempnam(realpath(file_directory_temp()), 'smtp');
$file_path = file_save_data($attachment, $attachment_new_filename, FILE_EXISTS_RENAME);
$attachment_new_filename = drupal_tempnam('temporary://', 'smtp');
$file_path = file_save_data($attachment, $attachment_new_filename, FILE_EXISTS_REPLACE);
$real_path = drupal_realpath($file_path->uri);
if (!$mailer->AddAttachment($file_path, $file_name)) { // , $file_encoding, $filetype);
if (!$mailer->AddAttachment($real_path, $file_name)) {
drupal_set_message(t('Attachment could not be found or accessed.'));
}
}
@@ -444,6 +480,19 @@ class SmtpMailSystem implements MailSystemInterface {
break;
}
// Process mimemail attachments, which are prepared in mimemail_mail().
if (isset($message['params']['attachments'])) {
foreach ($message['params']['attachments'] as $attachment) {
if (isset($attachment['filecontent'])) {
$mailer->AddStringAttachment($attachment['filecontent'], $attachment['filename'], 'base64', $attachment['filemime']);
}
if (isset($attachment['filepath'])) {
$filename = isset($attachment['filename']) ? $attachment['filename'] : basename($attachment['filepath']);
$filemime = isset($attachment['filemime']) ? $attachment['filemime'] : file_get_mimetype($attachment['filepath']);
$mailer->AddAttachment($attachment['filepath'], $filename, 'base64', $filemime);
}
}
}
// Set the authentication settings.
$username = variable_get('smtp_username', '');
@@ -473,23 +522,130 @@ class SmtpMailSystem implements MailSystemInterface {
// Set other connection settings.
$mailer->Host = variable_get('smtp_host', '') . ';' . variable_get('smtp_hostbackup', '');
$mailer->Port = variable_get('smtp_port', '25');
$mailer->Host = variable_get('smtp_host', '') . ';' . variable_get('smtp_hostbackup', '');
$mailer->Port = variable_get('smtp_port', '25');
$mailer->Mailer = 'smtp';
// Integration with the Maillog module.
if (module_exists('maillog')) {
if (variable_get('maillog_log', TRUE)) {
$record = new stdClass;
// Let the people know what is going on.
watchdog('smtp', 'Sending mail to: @to', array('@to' => $to));
// In case the subject/from/to is already encoded, decode with
// mime_header_decode.
$record->header_message_id = isset($mailer->MessageID) ? $mailer->MessageID : NULL;
$record->subject = drupal_substr(mime_header_decode($mailer->Subject), 0, 255);
$record->header_from = $from;
$record->header_to = $to;
$record->header_reply_to = isset($headers['Reply-To']) ? $headers['Reply-To'] : '';
$record->header_all = serialize($headers);
$record->sent_date = REQUEST_TIME;
// Try to send e-mail. If it fails, set watchdog entry.
if (!$mailer->Send()) {
watchdog('smtp', 'Error sending e-mail from @from to @to : !error_message', array('@from' => $from, '@to' => $to, '!error_message' => $mailer->ErrorInfo), WATCHDOG_ERROR);
return FALSE;
// Used to separate different portions of the body string.
$divider = str_repeat('-', 60) . "\n";
// Load the attachments.
$attachments = $mailer->GetAttachments();
$record->body = '';
// If there's more than one item to display, add a divider.
if (!empty($mailer->AltBody) || !empty($attachments)) {
$record->body .= t('Body') . ":\n";
$record->body .= $divider;
}
// Add the body field.
if (isset($mailer->Body)) {
$record->body .= $mailer->Body;
}
else {
$record->body .= t('*No message body*') . ":\n";
}
// The AltBody value is optional.
if (!empty($mailer->AltBody)) {
$record->body .= "\n";
$record->body .= $divider;
$record->body .= t('Alternative body') . ":\n";
$record->body .= $divider;
$record->body .= $mailer->AltBody;
}
// List the attachments.
if (!empty($attachments)) {
$record->body .= "\n";
$record->body .= $divider;
$record->body .= t('Attachments') . ":\n";
$record->body .= $divider;
foreach ($attachments as $file) {
$record->body .= t('Filename') . ':' . $file[1] . "\n";
$record->body .= t('Name') . ':' . $file[2] . "\n";
$record->body .= t('Encoding') . ':' . $file[3] . "\n";
$record->body .= t('Type') . ':' . $file[4] . "\n";
$record->body .= "\n";
}
}
drupal_write_record('maillog', $record);
}
// Display the e-mail using Devel module.
if (variable_get('maillog_devel', TRUE) && function_exists('dpm')) {
$devel_msg = array();
$devel_msg[t('Subject')] = $mailer->Subject;
$devel_msg[t('From')] = $from;
$devel_msg[t('To')] = $to;
$devel_msg[t('Reply-To')] = isset($headers['Reply-To']) ? $headers['Reply-To'] : NULL;
$devel_msg[t('Headers')] = $headers;
$devel_msg[t('Body')] = $mailer->Body;
$devel_msg[t('Alternative body')] = $mailer->AltBody;
$devel_msg[t('Attachments')] = $mailer->GetAttachments();
dpm($devel_msg, 'maillog');
}
}
$error = FALSE;
// Email delivery was disabled.
if (!variable_get('smtp_deliver', TRUE)) {
if ($logging) {
$params = array(
'@from' => $from,
'@to' => $to,
);
watchdog('smtp', 'Email delivery is disabled, did not send email from @from to @to.', $params);
}
}
else {
if (!$mailer->send()) {
$params = array(
'@from' => $from,
'@to' => $to,
'!error_message' => $mailer->ErrorInfo
);
if (variable_get('smtp_queue_fail', FALSE)) {
if ($logging) {
watchdog('smtp', 'Error sending e-mail from @from to @to, will retry on cron run : !error_message.', $params, WATCHDOG_ERROR);
}
smtp_failed_messages($message);
}
elseif ($logging) {
$error = TRUE;
watchdog('smtp', 'Error sending e-mail from @from to @to : !error_message', $params, WATCHDOG_ERROR);
}
}
elseif (variable_get('smtp_debugging', SMTP_LOGGING_ERRORS) == SMTP_LOGGING_ALL) {
watchdog('smtp', 'Sent mail to: @to', array('@to' => $to));
}
}
$mailer->SmtpClose();
return TRUE;
return !$error;
}
/**
* Splits the input into parts based on the given boundary.
*
@@ -523,8 +679,6 @@ class SmtpMailSystem implements MailSystemInterface {
return $parts;
} // End of _smtp_boundary_split().
/**
* Strips the headers from the body part.
*
@@ -536,20 +690,29 @@ class SmtpMailSystem implements MailSystemInterface {
protected function _remove_headers($input) {
$part_array = explode("\n", $input);
if (strpos($part_array[0], 'Content') !== FALSE) {
if (strpos($part_array[1], 'Content') !== FALSE) {
if (strpos($part_array[2], 'Content') !== FALSE) {
array_shift($part_array);
array_shift($part_array);
array_shift($part_array);
}
else {
array_shift($part_array);
array_shift($part_array);
// will strip these headers according to RFC2045
$headers_to_strip = array( 'Content-Type', 'Content-Transfer-Encoding', 'Content-ID', 'Content-Disposition');
$pattern = '/^(' . implode('|', $headers_to_strip) . '):/';
while (count($part_array) > 0) {
// ignore trailing spaces/newlines
$line = rtrim($part_array[0]);
// if the line starts with a known header string
if (preg_match($pattern, $line)) {
$line = rtrim(array_shift($part_array));
// remove line containing matched header.
// if line ends in a ';' and the next line starts with four spaces, it's a continuation
// of the header split onto the next line. Continue removing lines while we have this condition.
while (substr($line, -1) == ';' && count($part_array) > 0 && substr($part_array[0], 0, 4) == ' ') {
$line = rtrim(array_shift($part_array));
}
}
else {
array_shift($part_array);
// no match header, must be past headers; stop searching.
break;
}
}
@@ -557,8 +720,6 @@ class SmtpMailSystem implements MailSystemInterface {
return $output;
} // End of _smtp_remove_headers().
/**
* Returns a string that is contained within another string.
*
@@ -588,6 +749,41 @@ class SmtpMailSystem implements MailSystemInterface {
$substring = drupal_substr($substring, 0, $string_length);
}
return $substring;
return trim($substring);
} // End of _smtp_get_substring().
/**
* Returns an array of name and email address from a string.
*
* @param $input
* A string that contains different possible combinations of names and
* email address.
* @return
* An array containing a name and an email address.
*/
protected function _get_components($input) {
$components = array(
'input' => $input,
'name' => '',
'email' => '',
);
// If the input is a valid email address in its entirety, then there is
// nothing to do, just return that.
if (valid_email_address($input)) {
$components['email'] = trim($input);
return $components;
}
// Check if $input has one of the following formats, extract what we can:
// some name <address@example.com>
// "another name" <address@example.com>
// <address@example.com>
if (preg_match('/^"?([^"\t\n]*)"?\s*<([^>\t\n]*)>$/', $input, $matches)) {
$components['name'] = trim($matches[1]);
$components['email'] = trim($matches[2]);
}
return $components;
}
}

112
sites/all/modules/smtp/smtp.module
View File

@@ -16,17 +16,33 @@
*/
/**
* Implementation of hook_help().
* SMTP logging -- logging is disabled
*/
define('SMTP_LOGGING_NONE', 0);
/**
* SMTP logging -- all messages are logged
*/
define('SMTP_LOGGING_ALL', 1);
/**
* SMTP logging -- only errors are logged
*/
define('SMTP_LOGGING_ERRORS', 2);
/**
* Implements hook_help().
*/
function smtp_help($path, $arg) {
switch ($path) {
case 'admin/help#smtp':
return t('Allow for site emails to be sent through an SMTP server of your choice.');
}
} // End of smtp_help().
}
/**
* Implementation of hook_menu().
* Implements hook_menu().
*/
function smtp_menu() {
$items['admin/config/system/smtp'] = array(
@@ -38,10 +54,10 @@ function smtp_menu() {
'file' => 'smtp.admin.inc',
);
return $items;
} // End of smtp_menu().
}
/**
* Implementation of hook_permission().
* Implements hook_permission().
*/
function smtp_permission() {
return array(
@@ -49,15 +65,93 @@ function smtp_permission() {
'title' => t('Administer SMTP Authentication Support module'),
'description' => t('Perform administration tasks for SMTP Authentication Support module.'))
);
} // End of smtp_permission().
}
/**
* Implementation of hook_mail().
* Implements hook_mail().
*/
function smtp_mail($key, &$message, $params) {
if ($key == 'smtp-test') {
$message['subject'] = $params['subject'];
$message['body'] = $params['body'];
$message['body'] = $params['body'];
}
} // End of smtp_mail().
}
/**
* Implementation of hook_cron_queue_info().
*/
function smtp_cron_queue_info() {
$queues['smtp_send_queue'] = array(
'worker callback' => 'smtp_send_queue_runner',
'time' => 60,
);
$queues['smtp_failure_queue'] = array(
'worker callback' => 'smtp_failure_queue_runner',
'time' => 30,
);
return $queues;
}
/**
* smtp_send_queue queuer.
*/
function smtp_send_queue($mailerObj) {
$queue = DrupalQueue::get('smtp_send_queue');
$queue->createItem($mailerObj);
}
function smtp_send_queue_runner($message) {
$logging = variable_get('smtp_debugging', SMTP_LOGGING_ERRORS);
// Legacy for mails queued before 7.x-v1.3
// What was passed to the runner used to be a PHPMailer object, not a message array.
if (!empty($message['mailer']) && is_object($message['mailer'])) {
if (!$message['mailer']->Send()) {
if ($logging == SMTP_LOGGING_ALL || $logging == SMTP_LOGGING_ERRORS) {
watchdog('smtp', 'Error sending e-mail from @from to @to, will retry on cron run : !error_message.',
array(
'@from' => $message['from'],
'@to' => $message['to'],
'!error_message' => $message['mailer']->ErrorInfo,
), WATCHDOG_ERROR);
}
}
return;
}
// Let the people know what is going on.
if ($logging == SMTP_LOGGING_ALL) {
watchdog('smtp', 'Sending mail to: @to', array('@to' => $message['to']));
}
// Send the message.
$mail_system = new SmtpMailSystem();
$mail_system->mailWithoutQueue($message);
}
/**
* Store failed messages for later.
*
* @param array $new_message
*
* @return array
* All messages that have been saved.
*/
function smtp_failed_messages($message) {
$queue = DrupalQueue::get('smtp_failure_queue');
$queue->createItem($message);
}
/**
* Queue runner for smtp_failure_queue.
*
* @param $message
* A drupal_mail-formatted message.
*/
function smtp_failure_queue_runner($message) {
$queue = DrupalQueue::get('smtp_send_queue');
$queue->createItem($message);
}

166
sites/all/modules/smtp/smtp.phpmailer.inc
View File

@@ -7,7 +7,7 @@
*/
/*~ class.phpmailer.php
Orginal release information:
Original release information:
.---------------------------------------------------------------------------.
| Software: PHPMailer - PHP email class |
| Version: 5.1 |
@@ -325,6 +325,7 @@ class PHPMailer {
private $sign_key_file = "";
private $sign_key_pass = "";
private $exceptions = FALSE;
private $logging;
/////////////////////////////////////////////////
// CONSTANTS
@@ -343,6 +344,7 @@ class PHPMailer {
* @param boolean $exceptions Should we throw external exceptions?
*/
public function __construct($exceptions = FALSE) {
$this->logging = variable_get('smtp_debugging', SMTP_LOGGING_ERRORS);
$this->exceptions = ($exceptions == TRUE);
}
@@ -455,7 +457,9 @@ class PHPMailer {
*/
private function AddAnAddress($kind, $address, $name = '') {
if (!preg_match('/^(to|cc|bcc|ReplyTo)$/', $kind)) {
echo 'Invalid recipient array: ' . kind;
if ($this->logging) {
watchdog('smtp', 'Invalid recipient array: %kind', array('%kind' => $kind), WATCHDOG_ERROR);
}
return FALSE;
}
$address = trim($address);
@@ -465,7 +469,9 @@ class PHPMailer {
if ($this->exceptions) {
throw new phpmailerException(t('Invalid address') . ': ' . $address);
}
echo t('Invalid address') . ': ' . $address;
if ($this->logging) {
watchdog('smtp', 'Invalid address: %address', array('%address' => $address), WATCHDOG_ERROR);
}
return FALSE;
}
if ($kind != 'ReplyTo') {
@@ -498,7 +504,9 @@ class PHPMailer {
if ($this->exceptions) {
throw new phpmailerException(t('Invalid address') . ': ' . $address);
}
echo t('Invalid address') . ': ' . $address;
if ($this->logging) {
watchdog('smtp', 'Invalid address: %address', array('%address' => $address), WATCHDOG_ERROR);
}
return FALSE;
}
$this->From = $address;
@@ -577,8 +585,6 @@ class PHPMailer {
// Choose the mailer and send through it
switch ($this->Mailer) {
case 'sendmail':
return $this->SendmailSend($header, $body);
case 'smtp':
return $this->SmtpSend($header, $body);
default:
@@ -590,59 +596,13 @@ class PHPMailer {
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage() . "\n";
if ($this->logging) {
watchdog_exception('smtp', $e);
}
return FALSE;
}
}
/**
* Sends mail using the $Sendmail program.
* @param string $header The message headers
* @param string $body The message body
* @access protected
* @return bool
*/
protected function SendmailSend($header, $body) {
if ($this->Sender != '') {
$sendmail = sprintf("%s -oi -f %s -t", escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
}
else {
$sendmail = sprintf("%s -oi -t", escapeshellcmd($this->Sendmail));
}
if ($this->SingleTo === TRUE) {
foreach ($this->SingleToArray as $key => $val) {
if (!@$mail = popen($sendmail, 'w')) {
throw new phpmailerException(t('Could not execute: !smail', array('!smail' => $this->Sendmail)), self::STOP_CRITICAL);
}
fputs($mail, "To: " . $val . "\n");
fputs($mail, $header);
fputs($mail, $body);
$result = pclose($mail);
// implement call back function if it exists
$isSent = ($result == 0) ? 1 : 0;
$this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body);
if ($result != 0) {
throw new phpmailerException(t('Could not execute: !smail', array('!smail' => $this->Sendmail)), self::STOP_CRITICAL);
}
}
}
else {
if (!@$mail = popen($sendmail, 'w')) {
throw new phpmailerException(t('Could not execute: !smail', array('!smail' => $this->Sendmail)), self::STOP_CRITICAL);
}
fputs($mail, $header);
fputs($mail, $body);
$result = pclose($mail);
// implement call back function if it exists
$isSent = ($result == 0) ? 1 : 0;
$this->doCallback($isSent, $this->to, $this->cc, $this->bcc, $this->Subject, $body);
if ($result != 0) {
throw new phpmailerException(t('Could not execute: !smail', array('!smail' => $this->Sendmail)), self::STOP_CRITICAL);
}
}
return TRUE;
}
/**
* Sends mail using the PHP mail() function.
* @param string $header The message headers
@@ -662,7 +622,7 @@ class PHPMailer {
$old_from = ini_get('sendmail_from');
ini_set('sendmail_from', $this->Sender);
if ($this->SingleTo === TRUE && count($toArr) > 1) {
foreach ($toArr as $key => $val) {
foreach ($toArr as $val) {
$rt = @mail($val, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params);
// implement call back function if it exists
$isSent = ($rt == 1) ? 1 : 0;
@@ -678,7 +638,7 @@ class PHPMailer {
}
else {
if ($this->SingleTo === TRUE && count($toArr) > 1) {
foreach ($toArr as $key => $val) {
foreach ($toArr as $val) {
$rt = @mail($val, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params);
// implement call back function if it exists
$isSent = ($rt == 1) ? 1 : 0;
@@ -792,10 +752,11 @@ class PHPMailer {
$hosts = explode(';', $this->Host);
$index = 0;
$connection = $this->smtp->Connected();
$lastexception = NULL;
// Retry while there is no connection
try {
while ($index < count($hosts) && !$connection) {
while ($index < count($hosts) && !$connection) {
try {
$hostinfo = array();
if (preg_match('/^(.+):([0-9]+)$/', $hosts[$index], $hostinfo)) {
$host = $hostinfo[1];
@@ -830,14 +791,24 @@ class PHPMailer {
}
}
}
$index++;
if (!$connection) {
throw new phpmailerException(t('SMTP Error: Could not connect to SMTP host.'));
} catch (phpmailerException $e) {
if ($connection) {
$this->SmtpClose();
$connection = FALSE;
}
$lastexception = $e;
}
$index++;
}
if (!$connection) {
if ($lastexception != NULL) {
throw $lastexception;
}
else {
throw new phpmailerException(t('SMTP Error: Could not connect to SMTP host.'));
}
} catch (phpmailerException $e) {
$this->smtp->Reset();
throw $e;
}
return TRUE;
}
@@ -1361,7 +1332,9 @@ class PHPMailer {
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage() . "\n";
if ($this->logging) {
watchdog_exception('smtp', $e);
}
if ( $e->getCode() == self::STOP_CRITICAL ) {
return FALSE;
}
@@ -1469,14 +1442,24 @@ class PHPMailer {
return FALSE;
}
}
if (PHP_VERSION < 6) {
$magic_quotes = get_magic_quotes_runtime();
set_magic_quotes_runtime(0);
$magic_quotes = get_magic_quotes_runtime();
if ($magic_quotes) {
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime(0);
}
else {
ini_set('magic_quotes_runtime', 0);
}
}
$file_buffer = file_get_contents($path);
$file_buffer = $this->EncodeString($file_buffer, $encoding);
if (PHP_VERSION < 6) {
set_magic_quotes_runtime($magic_quotes);
if ($magic_quotes) {
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime($magic_quotes);
}
else {
ini_set('magic_quotes_runtime', $magic_quotes);
}
}
return $file_buffer;
} catch (Exception $e) {
@@ -1731,27 +1714,41 @@ class PHPMailer {
*/
public function EncodeQ($str, $position = 'text') {
// There should not be any EOL in the string
$encoded = preg_replace('/[\r\n]*/', '', $str);
$pattern = '';
$encoded = str_replace(array("\r", "\n"), '', $str);
switch (strtolower($position)) {
case 'phrase':
$encoded = preg_replace("/([^A-Za-z0-9!*+\/ -])/e", "'='.sprintf('%02X', ord('\\1'))", $encoded);
// RFC 2047 section 5.3
$pattern = '^A-Za-z0-9!*+\/ -';
break;
/** @noinspection PhpMissingBreakStatementInspection */
case 'comment':
$encoded = preg_replace("/([\(\)\"])/e", "'='.sprintf('%02X', ord('\\1'))", $encoded);
// RFC 2047 section 5.2
$pattern = '\(\)"';
// intentional fall-through
// for this reason we build the $pattern without including delimiters and []
case 'text':
default:
// Replace every high ascii, control =, ? and _ characters
//TODO using /e (equivalent to eval()) is probably not a good idea
$encoded = preg_replace('/([\000-\011\013\014\016-\037\075\077\137\177-\377])/e',
"'='.sprintf('%02X', ord('\\1'))", $encoded);
// RFC 2047 section 5.1
// Replace every high ascii, control, =, ? and _ characters
$pattern = '\000-\011\013\014\016-\037\075\077\137\177-\377' . $pattern;
break;
}
$matches = array();
if (preg_match_all("/[{$pattern}]/", $encoded, $matches)) {
// If the string contains an '=', make sure it's the first thing we replace
// so as to avoid double-encoding
$s = array_search('=', $matches[0]);
if ($s !== false) {
unset($matches[0][$s]);
array_unshift($matches[0], '=');
}
foreach (array_unique($matches[0]) as $char) {
$encoded = str_replace($char, '=' . sprintf('%02X', ord($char)), $encoded);
}
}
// Replace every spaces to _ (more readable than =20)
$encoded = str_replace(' ', '_', $encoded);
return $encoded;
return str_replace(' ', '_', $encoded);
}
/**
@@ -2193,7 +2190,6 @@ class PHPMailer {
* @param string $key_pass Password for private key
*/
public function DKIM_QP($txt) {
$tmp="";
$line="";
for ($i=0;$i<strlen($txt);$i++) {
$ord=ord($txt[$i]);
@@ -2320,4 +2316,4 @@ class phpmailerException extends Exception {
$errorMsg = '<strong>' . $this->getMessage() . "</strong><br />\n";
return $errorMsg;
}
}
}

64
sites/all/modules/smtp/smtp.transport.inc
View File

@@ -6,7 +6,7 @@
*
*/
/*~ class.smtp.php
Orginal release information:
Original release information:
.---------------------------------------------------------------------------.
| Software: PHPMailer - PHP email class |
| Version: 5.1 |
@@ -141,7 +141,7 @@ class SMTP {
"errno" => $errno,
"errstr" => $errstr);
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": $errstr ($errno)" . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @errstr (@errno)", array("@error" => $this->error["error"], "@errstr" => $errstr, "@errno" => $errno)));
}
return FALSE;
}
@@ -155,7 +155,7 @@ class SMTP {
$announce = $this->get_lines();
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $announce . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @announce", array("@announce" => $announce)));
}
return TRUE;
@@ -184,7 +184,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 220) {
@@ -193,7 +193,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -225,7 +225,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -242,7 +242,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -259,7 +259,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -278,7 +278,7 @@ class SMTP {
if ($sock_status["eof"]) {
// the socket is valid but we are not connected
if ($this->do_debug >= 1) {
echo "SMTP -> NOTICE:" . $this->CRLF . "EOF caught while checking if connected";
drupal_set_message(t("SMTP -> NOTICE: EOF caught while checking if connected"));
}
$this->Close();
return FALSE;
@@ -314,7 +314,7 @@ class SMTP {
* finializing the mail transaction. $msg_data is the message
* that is to be send with the headers. Each header needs to be
* on a single line followed by a <CRLF> with the message headers
* and the message body being seperated by and additional <CRLF>.
* and the message body being separated by and additional <CRLF>.
*
* Implements rfc 821: DATA <CRLF>
*
@@ -343,7 +343,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 354) {
@@ -352,7 +352,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -437,7 +437,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 250) {
@@ -446,7 +446,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -502,7 +502,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER: " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 250) {
@@ -511,7 +511,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -551,7 +551,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 250) {
@@ -560,7 +560,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -594,7 +594,7 @@ class SMTP {
$byemsg = $this->get_lines();
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $byemsg . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @byemsg", array("@rply" => $byemsg)));
}
$rval = TRUE;
@@ -608,7 +608,7 @@ class SMTP {
"smtp_rply" => substr($byemsg, 4));
$rval = FALSE;
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $e["error"] . ": " . $byemsg . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
}
@@ -646,7 +646,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 250 && $code != 251) {
@@ -655,7 +655,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -689,7 +689,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 250) {
@@ -698,7 +698,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -736,7 +736,7 @@ class SMTP {
$code = substr($rply, 0, 3);
if ($this->do_debug >= 2) {
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> FROM SERVER: @rply", array("@rply" => $rply)));
}
if ($code != 250) {
@@ -745,7 +745,7 @@ class SMTP {
"smtp_code" => $code,
"smtp_msg" => substr($rply, 4));
if ($this->do_debug >= 1) {
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> ERROR: @error: @rply", array("@error" => $this->error["error"], "@rply" => $rply)));
}
return FALSE;
}
@@ -755,7 +755,7 @@ class SMTP {
/**
* This is an optional command for SMTP that this class does not
* support. This method is here to make the RFC821 Definition
* complete for this class and __may__ be implimented in the future
* complete for this class and __may__ be implemented in the future
*
* Implements from rfc 821: TURN <CRLF>
*
@@ -768,7 +768,7 @@ class SMTP {
public function Turn() {
$this->error = array("error" => "This method, TURN, of the SMTP is not implemented");
if ($this->do_debug >= 1) {
echo "SMTP -> NOTICE: " . $this->error["error"] . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> NOTICE: @error", array("@error" => $this->error["error"])));
}
return FALSE;
}
@@ -799,12 +799,12 @@ class SMTP {
$data = "";
while ($str = @fgets($this->smtp_conn, 515)) {
if ($this->do_debug >= 4) {
echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> get_lines(): \$data was \"@data\"", array("@data" => $data)));
drupal_set_message(t("SMTP -> get_lines(): \$str is \"@str\"", array("@str" => $str)));
}
$data .= $str;
if ($this->do_debug >= 4) {
echo "SMTP -> get_lines(): \$data is \"$data\"" . $this->CRLF . '<br />';
drupal_set_message(t("SMTP -> get_lines(): \$data was \"@data\"", array("@data" => $data)));
}
// if 4th character is a space, we are done reading, break the loop
if (substr($str, 3, 1) == " ") {
@@ -813,4 +813,4 @@ class SMTP {
}
return $data;
}
}
}

40
sites/all/modules/smtp/smtp.variable.inc Normal file
View File

@@ -0,0 +1,40 @@
<?php
/**
* @file
* Custom integration with the Variable module.
*/
/**
* Implements hook_variable_group_info().
*/
function smtp_variable_group_info() {
$groups['smtp'] = array(
'title' => t('SMTP Authentication Support'),
'access' => 'administer smtp module',
'description' => t('Configure SMTP server for site emails to be sent from different names.'),
);
return $groups;
}
/**
* Implements hook_variable_info().
*
* Allows for the SMTP from name to be translated if/when the Variable module is
* enabled.
*
* @link http://api.drupalhelp.net/api/variable/variable.api.php/function/hook_variable_info/7
* @param array $options
*/
function smtp_variable_info($options) {
$variable['smtp_fromname'] = array (
'title' => t('Email from name (SMTP module)'),
'type' => 'string',
'description' => t('Allow for site emails to be sent from a different name.'),
'group' => 'smtp',
'multidomain' => TRUE,
'localize' => TRUE,
);
return $variable;
}

200
sites/all/modules/smtp/tests/smtp.unit.test Normal file
View File

@@ -0,0 +1,200 @@
<?php
/**
* @file
* Some tests for the SMTP module.
*/
class SmtpUnitTest extends DrupalWebTestCase {
/**
* {@inheritdoc}
*/
public static function getInfo() {
return array(
'name' => 'SMTP unit tests',
'description' => 'Test the SMTP module.',
'group' => 'SMTP',
);
}
/**
* {@inheritdoc}
*/
function setUp(array $modules = array()) {
// Requirements.
$modules[] = 'smtp';
// Some extra logic for fully testing the module.
$modules[] = 'smtp_tests';
// This module is used to log all emails so that the delivery can be
// confirmed.
$modules[] = 'maillog';
parent::setUp($modules);
// Take over the email system.
variable_set('mail_system', array('default-system' => 'SmtpMailSystem'));
// Turn on the mail module.
variable_set('smtp_on', TRUE);
// Do not actually deliver the emails.
variable_set('smtp_deliver', FALSE);
// Use Maillog to log all emails.
variable_set('maillog_log', TRUE);
}
/**
* Confirm that SMTP has taken over the 'mail_system' variable.
*/
function testSetup() {
$enabled = variable_get('mail_system', array());
$should_be = array(
'default-system' => 'SmtpMailSystem',
);
$this->assertEqual($enabled, $should_be, 'SMTP is controlling mail delivery.');
$delivery = variable_get('smtp_on', TRUE);
$this->assertEqual($delivery, TRUE, 'SMTP is enabled.');
$delivery = variable_get('smtp_deliver', FALSE);
$this->assertEqual($delivery, FALSE, 'Email delivery is disabled.');
$logging = variable_get('maillog_log', TRUE);
$this->assertEqual($logging, TRUE, 'Email delivery is being logged.');
}
/**
* Tests logging mail with maillog module.
*/
public function testLogging() {
$langcode = language_default('language');
// This is automatically assigned by Simpletest.
$sender = 'simpletest@example.com';
// Send an email.
$to_email = 'to_test@example.com';
$reply_email = 'reply_test@example.com';
$params = array();
drupal_mail('smtp_tests', 'smtp_basic_test', $to_email, $langcode, $params);
// The SMTP module controls the 'from' address but defaults to using the
// site's system email address.
$from_email = variable_get('site_mail', '');
// Compare the maillog db entry with the sent mail.
$logged_email = $this->getLatestMaillogEntry();
$this->assertTrue(!empty($logged_email), 'The test email was captured.');
$this->assertEqual($to_email, $logged_email['header_to']);//, 'Email "to" address is correct.');
$this->assertEqual($from_email, $logged_email['header_from']);//, 'Email "from" address is correct.');
$this->assertEqual($from_email, $logged_email['header_all']['From']);//, 'Email "from" header is correct.');
$this->assertEqual($sender, $logged_email['header_all']['Sender']);//, 'Email "sender" header is correct.');
$this->assertEqual($sender, $logged_email['header_all']['Return-Path']);//, 'Email "return-path" header is correct.');
$this->assertEqual('Drupal', $logged_email['header_all']['X-Mailer']);//, 'Email "x-mailer" header is correct.');
$this->assertEqual(t('Test email subject'), $logged_email['subject']);//, 'Email subject is correct.');
$this->assertEqual(t('Test email body.') . "\n", $logged_email['body']);//, 'Email body is correct.');
}
/**
* Confirm the queue works.
*/
public function testQueue() {
// Turn on the queue.
variable_set('smtp_queue', TRUE);
// Send a test message.
$langcode = language_default('language');
$sender = 'simpletest@example.com';
$to_email = 'to_test@example.com';
$reply_email = 'reply_test@example.com';
$params = array();
drupal_mail('smtp_tests', 'smtp_basic_test', $to_email, $langcode, $params);
// Check the queue for messages.
$queue_count = $this->getQueueCount();
$this->assertEqual($queue_count, 1, 'An email was found in the send queue.');
}
/**
* Confirm the queue works.
*/
public function testFailQueue() {
// Turn on the queue failover.
variable_set('smtp_queue_fail', TRUE);
// Make sure the queue is disabled.
variable_set('smtp_queue', FALSE);
// Turn on email delivery.
variable_set('smtp_deliver', TRUE);
// Set some fake values for the delivery, it should fail and then cause the
// email to go in to the queue.
variable_set('smtp_from', 'drupal@example.com');
variable_set('smtp_fromname', 'Drupal Simpletest');
variable_set('smtp_host', 'smtp.gmail.com');
variable_set('smtp_hostbackup', '');
variable_set('smtp_password', 'THIS WILL NOT WORK!');
variable_set('smtp_port', '465');
variable_set('smtp_protocol', 'ssl');
variable_set('smtp_username', 'hello@example.com');
// Send a test message.
$langcode = language_default('language');
$sender = 'simpletest@example.com';
$to_email = 'to_test@example.com';
$reply_email = 'reply_test@example.com';
$params = array();
drupal_mail('smtp_tests', 'smtp_basic_test', $to_email, $langcode, $params);
// Check the queue for messages.
$queue_count = $this->getQueueCount('smtp_failure_queue');
$this->assertEqual($queue_count, 1, 'An email was found in the failure queue.');
$queue_count = $this->getQueueCount();
$this->assertEqual($queue_count, 0, 'An email was not found in the regular email queue.');
// Run the queue so that messages can be moved to the normal email queue.
drupal_cron_run();
// Check the queue for messages.
$queue_count = $this->getQueueCount();
$this->assertEqual($queue_count, 1, 'An email was found in the regular email queue.');
$queue_count = $this->getQueueCount('smtp_failure_queue');
$this->assertEqual($queue_count, 0, 'An email was not found in the failure queue.');
}
/**
* Gets the latest Maillog entry.
*
* @return array
* Maillog entry.
*/
protected function getLatestMaillogEntry() {
$query = 'SELECT idmaillog, header_from, header_to, header_reply_to, header_all, subject, body FROM {maillog} ORDER BY idmaillog DESC';
$result = db_query_range($query, 0, 1);
if ($maillog = $result->fetchAssoc()) {
// Unserialize values.
$maillog['header_all'] = unserialize($maillog['header_all']);
}
return $maillog;
}
/**
* Get the number of emails in a specific queue.
*
* @param string $queue
* The name of the queue to add the emails to.
*
* @return int
* The number of messages found in the requested queue.
*/
protected function getQueueCount($queue = 'smtp_send_queue') {
return db_query("SELECT count('name') FROM {queue} WHERE name = :queue",
array(':queue' => $queue))
->fetchField();
}
}

12
sites/all/modules/smtp/tests/smtp_tests.info Normal file
View File

@@ -0,0 +1,12 @@
name = SMTP tests
description = Contains helper logic for the SMTP tests.
package = Mail
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2017-06-27
version = "7.x-1.7"
core = "7.x"
project = "smtp"
datestamp = "1498593247"

16
sites/all/modules/smtp/tests/smtp_tests.module Normal file
View File

@@ -0,0 +1,16 @@
<?php
/**
* @file
* Primary hook implementations for the SMTP test helper module.
*/
/**
* Implements hook_mail().
*/
function smtp_tests_mail($key, &$message, $params) {
// A very rudimentary test.
if ($key == 'smtp_basic_test') {
$message['subject'] = t('Test email subject');
$message['body'][] = t('Test email body.');
}
}