public function MailSystemInterface::mail in Mail System 6
Same name and namespace in other branches
- 6.2 mailsystem.module \MailSystemInterface::mail()
Send a message composed by drupal_mail().
Parameters
$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@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.
Return value
TRUE if the mail was successfully accepted for delivery, otherwise FALSE.
1 method overrides MailSystemInterface::mail()
- DefaultMailSystem::mail in ./
mailsystem.module - Send an e-mail message, using Drupal variables and default settings.
File
- ./
mailsystem.module, line 290 - Provide UI for controlling the mail_system variable.
Class
- MailSystemInterface
- An interface for pluggable mail back-ends.
Code
public function mail(array $message);