Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Mail;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an interface for pluggable mail back-ends.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Annotation\Mail
Chris@0:  * @see \Drupal\Core\Mail\MailManager
Chris@0:  * @see plugin_api
Chris@0:  */
Chris@0: interface MailInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Formats a message prior to sending.
Chris@0:    *
Chris@0:    * Allows to preprocess, format, and postprocess a mail message before it is
Chris@0:    * passed to the sending system. By default, all messages may contain HTML and
Chris@0:    * are converted to plain-text by the Drupal\Core\Mail\Plugin\Mail\PhpMail
Chris@0:    * implementation. For example, an alternative implementation could override
Chris@0:    * the default implementation and also sanitize the HTML for usage in a MIME-
Chris@0:    * encoded email, but still invoking the Drupal\Core\Mail\Plugin\Mail\PhpMail
Chris@0:    * implementation to generate an alternate plain-text version for sending.
Chris@0:    *
Chris@0:    * @param array $message
Chris@0:    *   A message array, as described in hook_mail_alter().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The formatted $message.
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Mail\MailManagerInterface
Chris@0:    */
Chris@0:   public function format(array $message);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sends a message composed by \Drupal\Core\Mail\MailManagerInterface->mail().
Chris@0:    *
Chris@0:    * @param array $message
Chris@0:    *   Message array with at least the following elements:
Chris@0:    *   - id: A unique identifier of the email type. Examples: 'contact_user_copy',
Chris@0:    *     'user_password_reset'.
Chris@0:    *   - to: The mail address or addresses where the message will be sent to.
Chris@0:    *     The formatting of this string will be validated with the
Chris@0:    *     @link http://php.net/manual/filter.filters.validate.php PHP email validation filter. @endlink
Chris@0:    *     Some examples:
Chris@0:    *     - user@example.com
Chris@0:    *     - user@example.com, anotheruser@example.com
Chris@0:    *     - User <user@example.com>
Chris@0:    *     - User <user@example.com>, Another User <anotheruser@example.com>
Chris@0:    *   - subject: Subject of the email to be sent. This must not contain any
Chris@0:    *     newline characters, or the mail may not be sent properly. The subject
Chris@0:    *     is converted to plain text by the mail plugin manager.
Chris@0:    *   - body: Message to be sent. Accepts both CRLF and LF line-endings.
Chris@0:    *     Email bodies must be wrapped. For smart plain text wrapping you can use
Chris@0:    *     \Drupal\Core\Mail\MailFormatHelper::wrapMail() .
Chris@0:    *   - headers: Associative array containing all additional mail headers not
Chris@0:    *     defined by one of the other parameters.  PHP's mail() looks for Cc and
Chris@0:    *     Bcc headers and sends the mail to addresses in these headers too.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the mail was successfully accepted for delivery, otherwise FALSE.
Chris@0:    */
Chris@0:   public function mail(array $message);
Chris@0: 
Chris@0: }