? 0 ? 443154-fatal-errors_20.patch ? a ? empty-parens-376408-1.patch.1 ? es ? foo.php ? handlet-comments.txt ? placeholders-test.php ? pluggable-smtp-331180-56.patch ? r.diff ? registry_rip-token.patch ? registry_rip.patch ? slash.php ? test.html ? xhtml-rdfa-1.dtd ? xxx.php ? modules/user/user.password.inc ? sites/all/modules ? sites/default/files ? sites/default/settings.php Index: includes/mail.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/mail.inc,v retrieving revision 1.23 diff -u -p -r1.23 mail.inc --- includes/mail.inc 24 Aug 2009 00:14:18 -0000 1.23 +++ includes/mail.inc 26 Aug 2009 13:31:42 -0000 @@ -2,6 +2,11 @@ // $Id: mail.inc,v 1.23 2009/08/24 00:14:18 webchick Exp $ /** + * @file + * API functions for processing and sending e-mail. + */ + +/** * Compose and optionally send an e-mail message. * * Sending an e-mail works with defining an e-mail template (subject, text @@ -61,10 +66,10 @@ * @param $to * The e-mail address or addresses where the message will be sent to. The * formatting of this string must comply with RFC 2822. Some examples are: - * user@example.com - * user@example.com, anotheruser@example.com - * User - * User , Another User + * - user@example.com + * - user@example.com, anotheruser@example.com + * - User + * - User , Another User * @param $language * Language object to use to compose the e-mail. * @param $params @@ -127,7 +132,7 @@ function drupal_mail($module, $key, $to, // Optionally send e-mail. if ($send) { - $message['result'] = drupal_mail_send($message); + $message['result'] = drupal_mail_sending_system($module, $key)->mail($message); // Log errors if (!$message['result']) { @@ -140,58 +145,113 @@ function drupal_mail($module, $key, $to, } /** - * Send an e-mail message, using Drupal variables and default settings. - * More information in the - * PHP function reference for mail(). See drupal_mail() for information on - * how $message is composed. - * - * @param $message - * Message array with at least the following elements: - * - id - * A unique identifier of the e-mail type. Examples: 'contact_user_copy', - * 'user_password_reset'. - * - to - * The mail address or addresses where the message will be sent to. The - * formatting of this string must comply with RFC 2822. Some examples are: - * user@example.com - * user@example.com, anotheruser@example.com - * User - * User , Another User - * - subject - * Subject of the e-mail to be sent. This must not contain any newline - * characters, or the mail may not be sent properly. - * - body - * Message to be sent. Accepts both CRLF and LF line-endings. - * E-mail bodies must be wrapped. You can use drupal_wrap_mail() for - * smart plain text wrapping. - * - headers - * Associative array containing all mail headers. - * @return - * Returns TRUE if the mail was successfully accepted for delivery, - * FALSE otherwise. + * Returns an object that implements DrupalMailSendingInterface. + * + * Allows for one or more custom mail backends to send mail messages + * composed using drupal_mail(). + * + * The selection of a particular implementation is controlled via the variable + * 'mail_sending_system', which is a keyed array. The default implementation + * is the class whose name is the value of 'default-system' key. A more specific + * match first to key and then to module will be used in preference to the + * default. To specificy a different class for all mail sent by one module, set + * the class name as the value for the key corresponding to the module name. To + * specificy a class for a particular message sent by one module, set the class + * name as the value for the array key that is the message id, which is + * "${module}_${key}". + * + * For example to debug all mail sent by the user module by logging it to a + * file, you might set the variable as something like: + * + * @code + * array( + * 'default-system' => 'DrupalMailSend', + * 'user' => 'DevelMailLog', + * ); + * @endcode + * + * Finally, a different system can be specified for a specific e-mail ID (see + * the $key param), such as one of the keys used by the contact module: + * + * @code + * array( + * 'default-system' => 'DrupalMailSend', + * 'user' => 'DevelMailLog', + * 'contact_page_autoreply' => 'DrupalDevNullMailSend', + * ); + * @endcode + * + * Other possible uses for system include a mail-sending class that actually + * sends (or duplicates) each message to SMS, Twitter, instant message, etc, or + * a class that queues up a large number of messages for more efficient bulk + * sending or for sending via a remote gateway so as to reduce the load + * on the local server. + * + * @param $module + * The module name which was used by drupal_mail() to invoke hook_mail(). + * @param $key + * A key to identify the e-mail sent. The final e-mail ID for the e-mail + * alter hook in drupal_mail() would have been {$module}_{$key}. */ -function drupal_mail_send($message) { - // Allow for a custom mail backend. - if (variable_get('smtp_library', '') && file_exists(variable_get('smtp_library', ''))) { - include_once DRUPAL_ROOT . '/' . variable_get('smtp_library', ''); - return drupal_mail_wrapper($message); +function drupal_mail_sending_system($module, $key) { + $instances = &drupal_static(__FUNCTION__, array()); + + $id = $module . '_' . $key; + $configuration = variable_get('mail_sending_system', array('default-system' => 'DrupalMailSend')); + + // Look for overrides for the default class, starting from the most specific + // id, and falling back to the module name. + if (isset($configuration[$id])) { + $class = $configuration[$id]; + } + elseif (isset($configuration[$module])) { + $class = $configuration[$module]; } else { - $mimeheaders = array(); - foreach ($message['headers'] as $name => $value) { - $mimeheaders[] = $name . ': ' . mime_header_encode($value); + $class = $configuration['default-system']; + } + + if (empty($instances[$class])) { + $interfaces = class_implements($class); + if (isset($interfaces['DrupalMailSendingInterface'])) { + $instances[$class] = new $class; + } + else { + throw new Exception(t('Class %class does not implement interface %interface', array('%class' => $class, '%interface' => 'DrupalMailSendingInterface'))); } - return mail( - $message['to'], - mime_header_encode($message['subject']), - // Note: e-mail uses CRLF for line-endings, but PHP's API requires LF. - // They will appear correctly in the actual e-mail that is sent. - str_replace("\r", '', $message['body']), - // For headers, PHP's API suggests that we use CRLF normally, - // but some MTAs incorrectly replace LF with CRLF. See #234403. - join("\n", $mimeheaders) - ); } + return $instances[$class]; +} + +/** + * An interface for pluggable mail back-ends. + */ +interface DrupalMailSendingInterface { + /** + * Send an e-mail message composed by drupal_mail(). + * + * @param $message + * Message array with at least the following elements: + * - id: A unique identifier of the e-mail type. Examples: 'contact_user_copy', + * 'user_password_reset'. + * - to: The mail address or addresses where the message will be sent to. + * The formatting of this string must comply with RFC 2822. Some examples: + * - user@example.com + * - user@example.com, anotheruser@example.com + * - User + * - User , Another User + * - subject: Subject of the e-mail to be sent. This must not contain any + * newline characters, or the mail may not be sent properly. + * - body: Message to be sent. Accepts both CRLF and LF line-endings. + * E-mail bodies must be wrapped. You can use drupal_wrap_mail() for + * smart plain text wrapping. + * - headers: Associative array containing all additional mail headers not + * defined by one of the other parameters. PHP's mail() looks for Cc + * and Bcc headers and sends the mail to addresses in these headers too. + * @return + * TRUE if the mail was successfully accepted for delivery, otherwise FALSE. + */ + public function mail($message); } /** Index: modules/simpletest/drupal_web_test_case.php =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/drupal_web_test_case.php,v retrieving revision 1.144 diff -u -p -r1.144 drupal_web_test_case.php --- modules/simpletest/drupal_web_test_case.php 24 Aug 2009 00:14:21 -0000 1.144 +++ modules/simpletest/drupal_web_test_case.php 26 Aug 2009 13:31:42 -0000 @@ -1110,9 +1110,8 @@ class DrupalWebTestCase extends DrupalTe unset($GLOBALS['conf']['language_default']); $language = language_default(); - // Make sure our drupal_mail_wrapper function is called instead of the - // default mail handler. - variable_set('smtp_library', drupal_get_path('module', 'simpletest') . '/drupal_web_test_case.php'); + // Use the test mail class instead of the default mail handler class. + variable_set('mail_sending_system', array('default-system' => 'DrupalTestMailSend')); // Use temporary files directory with the same prefix as the database. $public_files_directory = $this->originalFileDirectory . '/' . $db_prefix; @@ -1172,7 +1171,7 @@ class DrupalWebTestCase extends DrupalTe simpletest_log_read($this->testId, $db_prefix, get_class($this), TRUE); $db_prefix = $db_prefix_temp; - $emailCount = count(variable_get('simpletest_emails', array())); + $emailCount = count(variable_get('drupal_test_email_collector', array())); if ($emailCount) { $message = format_plural($emailCount, t('!count e-mail was sent during this test.'), t('!count e-mails were sent during this test.'), array('!count' => $emailCount)); $this->pass($message, t('E-mail')); @@ -1925,7 +1924,7 @@ class DrupalWebTestCase extends DrupalTe * An array containing e-mail messages captured during the current test. */ protected function drupalGetMails($filter = array()) { - $captured_emails = variable_get('simpletest_emails', array()); + $captured_emails = variable_get('drupal_test_email_collector', array()); $filtered_emails = array(); foreach ($captured_emails as $message) { @@ -2482,7 +2481,7 @@ class DrupalWebTestCase extends DrupalTe * TRUE on pass, FALSE on fail. */ protected function assertMail($name, $value = '', $message = '') { - $captured_emails = variable_get('simpletest_emails', array()); + $captured_emails = variable_get('drupal_test_email_collector', array()); $email = end($captured_emails); return $this->assertTrue($email && isset($email[$name]) && $email[$name] == $value, $message, t('E-mail')); } @@ -2502,22 +2501,7 @@ class DrupalWebTestCase extends DrupalTe $this->pass(l(t('Verbose message'), $this->originalFileDirectory . '/simpletest/verbose/' . get_class($this) . '-' . $id . '.html', array('attributes' => array('target' => '_blank'))), 'Debug'); } } -} - -/** - * Wrapper function to override the default mail handler function. - * - * @param $message - * An e-mail message. See drupal_mail() for information on how $message is composed. - * @return - * Returns TRUE to indicate that the e-mail was successfully accepted for delivery. - */ -function drupal_mail_wrapper($message) { - $captured_emails = variable_get('simpletest_emails', array()); - $captured_emails[] = $message; - variable_set('simpletest_emails', $captured_emails); - return TRUE; } /** Index: modules/simpletest/simpletest.info =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/simpletest.info,v retrieving revision 1.9 diff -u -p -r1.9 simpletest.info --- modules/simpletest/simpletest.info 17 Aug 2009 20:32:30 -0000 1.9 +++ modules/simpletest/simpletest.info 26 Aug 2009 13:31:42 -0000 @@ -25,6 +25,7 @@ files[] = tests/form.test files[] = tests/graph.test files[] = tests/image.test files[] = tests/lock.test +files[] = tests/mail.test files[] = tests/menu.test files[] = tests/module.test files[] = tests/registry.test Index: modules/simpletest/tests/mail.test =================================================================== RCS file: modules/simpletest/tests/mail.test diff -N modules/simpletest/tests/mail.test --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/simpletest/tests/mail.test 26 Aug 2009 13:31:42 -0000 @@ -0,0 +1,51 @@ + 'Mail system', + 'description' => 'Performs tests on the pluggable mailing framework.', + 'group' => 'System', + ); + } + + function setUp() { + parent::setUp(); + + // Set MailTestCase (i.e. this class) as the SMTP library + variable_set('mail_sending_system', array('default-system' => 'MailTestCase')); + } + + /** + * Assert that the pluggable mail system is functional. + */ + function testPluggableFramework() { + global $language; + + // Use MailTestCase for sending a message. + $message = drupal_mail('simpletest', 'mail_test', 'testing@drupal.org', $language); + + // Assert whether the message was sent through the send function. + $this->assertEqual(self::$sent_message['to'], 'testing@drupal.org', t('Pluggable mail system is extendable.')); + } + + /** + * Send function that is called through the mail system. + */ + public function mail($message) { + self::$sent_message = $message; + } +} + Index: modules/system/mail.sending.inc =================================================================== RCS file: modules/system/mail.sending.inc diff -N modules/system/mail.sending.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/system/mail.sending.inc 26 Aug 2009 13:31:42 -0000 @@ -0,0 +1,62 @@ + $value) { + $mimeheaders[] = $name . ': ' . mime_header_encode($value); + } + return mail( + $message['to'], + mime_header_encode($message['subject']), + // Note: e-mail uses CRLF for line-endings, but PHP's API requires LF. + // They will appear correctly in the actual e-mail that is sent. + str_replace("\r", '', $message['body']), + // For headers, PHP's API suggests that we use CRLF normally, + // but some MTAs incorrectly replace LF with CRLF. See #234403. + join("\n", $mimeheaders) + ); + } +} + +/** + * A mail sending implementation that captures sent messages to a variable. + * + * This class is for running tests or for development. + */ +class DrupalTestMailSend implements DrupalMailSendingInterface { + + /** + * Accept an e-mail message and store it in a variable. + * + * @param $message + * An e-mail message. + */ + public function mail(array $message) { + $captured_emails = variable_get('drupal_test_email_collector', array()); + $captured_emails[] = $message; + variable_set('drupal_test_email_collector', $captured_emails); + return TRUE; + } +} + Index: modules/system/system.info =================================================================== RCS file: /cvs/drupal/drupal/modules/system/system.info,v retrieving revision 1.15 diff -u -p -r1.15 system.info --- modules/system/system.info 19 Aug 2009 20:19:37 -0000 1.15 +++ modules/system/system.info 26 Aug 2009 13:31:42 -0000 @@ -12,4 +12,5 @@ files[] = system.install files[] = system.test files[] = system.tar.inc files[] = system.tokens.inc +files[] = mail.sending.inc required = TRUE