class PostmarkMail in Postmark 8

Modify the Drupal mail system to use Postmark when sending emails.

Plugin annotation

@Mail(
  id = "postmark_mail",
  label = @Translation("Postmark mailer"),
  description = @Translation("Sends the message using Postmark.")
)

Hierarchy

• class \Drupal\postmark\Plugin\Mail\PostmarkMail implements MailInterface, ContainerFactoryPluginInterface

File

src/Plugin/Mail/PostmarkMail.php, line 23

Namespace

Drupal\postmark\Plugin\Mail

class PostmarkMail implements MailInterface, ContainerFactoryPluginInterface {

  /**
   * Configuration object.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * Logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Postmark handler.
   *
   * @var \Drupal\postmark\PostmarkHandler
   */
  protected $postmarkHandler;

  /**
   * Constructs a Postmark mailer.
   *
   * @param \Drupal\Core\Config\ImmutableConfig $settings
   *   The configuration settings.
   * @param \Psr\Log\LoggerInterface $logger
   *   The core logger service.
   * @param \Drupal\postmark\PostmarkHandler $postmark_handler
   *   The Postmark handler.
   */
  public function __construct(ImmutableConfig $settings, LoggerInterface $logger, PostmarkHandler $postmark_handler) {
    $this->config = $settings;
    $this->logger = $logger;
    $this->postmarkHandler = $postmark_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('config.factory')
      ->get('postmark.settings'), $container
      ->get('logger.factory')
      ->get('postmark'), $container
      ->get('postmark.mail_handler'));
  }

  /**
   * Concatenate and wrap the e-mail body for either plain-text or HTML e-mails.
   *
   * @param array $message
   *   A message array, as described in hook_mail_alter().
   *
   * @return array
   *   The formatted $message.
   */
  public function format(array $message) {

    // Join the body array into one string.
    if (is_array($message['body'])) {
      $message['body'] = implode("\n\n", $message['body']);
    }

    // If text format is specified in settings, run the message through it.
    $format = $this->config
      ->get('format_filter');
    if (!empty($format)) {
      $message['body'] = check_markup($message['body'], $format, $message['langcode']);
    }
    return $message;
  }

  /**
   * Send the e-mail message.
   *
   * @param array $message
   *   A message array, as described in hook_mail_alter().
   *   $message['params'] may contain additional parameters.
   *
   * @return bool
   *   TRUE if the mail was successfully accepted or queued, FALSE otherwise.
   *
   * @see drupal_mail()
   */
  public function mail(array $message) {

    // Build the Postmark message array.
    $postmark_message = [
      'from' => $message['from'],
      'to' => $message['to'],
      'subject' => $message['subject'],
      'html' => $message['body'],
    ];
    if (isset($message['plain'])) {
      $postmark_message['text'] = $message['plain'];
    }
    else {
      $converter = new Html2Text($message['body']);
      $postmark_message['text'] = $converter
        ->getText();
    }

    // Add Cc / Bcc headers.
    if (!empty($message['headers']['Cc'])) {
      $postmark_message['cc'] = $message['headers']['Cc'];
    }
    if (!empty($message['headers']['Bcc'])) {
      $postmark_message['bcc'] = $message['headers']['Bcc'];
    }

    // Add Reply-To as header according to Postmark API.
    if (!empty($message['reply-to'])) {
      $postmark_message['reply-to'] = $message['reply-to'];
    }

    // Make sure the files provided in the attachments array exist.
    if (!empty($message['params']['attachments'])) {
      $attachments = [];
      foreach ($message['params']['attachments'] as $attachment) {
        if (file_exists($attachment)) {
          $attachments[] = [
            'filePath' => $attachment,
          ];
        }
      }
      if (count($attachments) > 0) {
        $postmark_message['attachment'] = $attachments;
      }
    }
    return $this->postmarkHandler
      ->sendMail($postmark_message);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PostmarkMail::$config	protected	property	Configuration object.
PostmarkMail::$logger	protected	property	Logger.
PostmarkMail::$postmarkHandler	protected	property	Postmark handler.
PostmarkMail::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PostmarkMail::format	public	function	Concatenate and wrap the e-mail body for either plain-text or HTML e-mails. Overrides MailInterface::format
PostmarkMail::mail	public	function	Send the e-mail message. Overrides MailInterface::mail
PostmarkMail::__construct	public	function	Constructs a Postmark mailer.