class ForwardMail in Forward 4.x

Defines a custom mail interface so that Forward emails can be sent as HTML.

Plugin annotation

@Mail(
  id = "forward_mail",
  label = @Translation("Forward HTML mailer"),
  description = @Translation("Sends the message as HTML, using PHP's native mail() function.")
)

Hierarchy

• class \Drupal\Core\Mail\Plugin\Mail\PhpMail implements MailInterface
  • class \Drupal\forward\Plugin\Mail\ForwardMail

File

src/Plugin/Mail/ForwardMail.php, line 17

Namespace

Drupal\forward\Plugin\Mail

class ForwardMail extends PhpMail {

  /**
   * Concatenates and wraps the email body for HTML mails.
   *
   * Unlike PHPMail, the message is not coverted to plain text by default.
   *
   * @param array $message
   *   A message array, as described in hook_mail_alter(). If the 'params'
   *   subarray defines a 'plain_text' key with a TRUE value, the message will
   *   be converted from HTML into plain text before sending.
   *
   * @return array
   *   The formatted $message.
   */
  public function format(array $message) {

    // Join the body array into one string.
    $message['body'] = implode("\n\n", $message['body']);
    if (!empty($message['params']['plain_text'])) {
      $message['body'] = MailFormatHelper::htmlToText($message['body']);
      $message['body'] = MailFormatHelper::wrapMail($message['body']);
    }
    return $message;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ForwardMail::format	public	function	Concatenates and wraps the email body for HTML mails. Overrides PhpMail::format
PhpMail::$configFactory	protected	property	The configuration factory.
PhpMail::mail	public	function	Sends an email message. Overrides MailInterface::mail	2
PhpMail::MAILBOX_LIST_HEADERS	private	constant	A list of headers that can contain multiple email addresses.
PhpMail::_isShellSafe	protected static	function	Disallows potentially unsafe shell characters.
PhpMail::__construct	public	function	PhpMail constructor.