Sends a message composed by drupal_mail().
Parameters
array $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 will be validated with the
PHP e-mail validation filter.
Some examples:
- 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
bool
TRUE if the mail was successfully accepted for delivery, otherwise FALSE.
File
- drupal/core/lib/Drupal/Core/Mail/MailInterface.php, line 53
- Definition of Drupal\Core\Mail\MailInterface.
Class
- MailInterface
- Defines an interface for pluggable mail back-ends.
Namespace
Drupal\Core\Mail
Code
public function mail(array $message);