You are here

Home » API reference » Drupal 8 » MailInterface.php » MailInterface

public function MailInterface::mail in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Mail/MailInterface.php \Drupal\Core\Mail\MailInterface::mail()

Sends a message composed by \Drupal\Core\Mail\MailManagerInterface->mail().

Parameters

array $message: Message array with at least the following elements:

  • id: A unique identifier of the email 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 email validation filter. Some examples:

  • subject: Subject of the email to be sent. This must not contain any newline characters, or the mail may not be sent properly. The subject is converted to plain text by the mail plugin manager.
  • body: Message to be sent. Accepts both CRLF and LF line-endings. Email bodies must be wrapped. For smart plain text wrapping you can use \Drupal\Core\Mail\MailFormatHelper::wrapMail() .
  • 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.

1 method overrides MailInterface::mail()
PhpMail::mail in core/lib/Drupal/Core/Mail/Plugin/Mail/PhpMail.php
Sends an email message.

File

core/lib/Drupal/Core/Mail/MailInterface.php, line 71

Class

MailInterface
Defines an interface for pluggable mail back-ends.

Namespace

Drupal\Core\Mail

Code

public function mail(array $message);