summaryrefslogtreecommitdiff
path: root/includes/mail.inc
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2012-12-26 18:48:06 -0800
committerwebchick <webchick@24967.no-reply.drupal.org>2012-12-26 18:48:06 -0800
commit5911444e9a555770a037279a080674a8fea3086d (patch)
treee38e234d67e43196c8d32212eded65cabe7c227d /includes/mail.inc
parentd6db96cba19d2e6d3cd728391c33f71359ae3282 (diff)
downloadbrdo-5911444e9a555770a037279a080674a8fea3086d.tar.gz
brdo-5911444e9a555770a037279a080674a8fea3086d.tar.bz2
Issue #1629994 by Aron Novak, oadaeh, yurtboy, jhodgdon, kingandy: Fixed Mail functions reference obsolete RFC.
Diffstat (limited to 'includes/mail.inc')
-rw-r--r--includes/mail.inc24
1 files changed, 14 insertions, 10 deletions
diff --git a/includes/mail.inc b/includes/mail.inc
index 630494ae5..bbb55357d 100644
--- a/includes/mail.inc
+++ b/includes/mail.inc
@@ -93,7 +93,9 @@ define('MAIL_LINE_ENDINGS', isset($_SERVER['WINDIR']) || strpos($_SERVER['SERVER
* will be {$module}_{$key}.
* @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:
+ * formatting of this string will be validated with the
+ * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
+ * Some examples are:
* - user@example.com
* - user@example.com, anotheruser@example.com
* - User <user@example.com>
@@ -307,19 +309,21 @@ interface MailSystemInterface {
* - 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:
+ * The formatting of this string will be validated with the
+ * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
+ * Some examples are:
* - user@example.com
* - user@example.com, anotheruser@example.com
* - User <user@example.com>
* - User <user@example.com>, Another User <anotheruser@example.com>
- * - 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.
+ * - 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.