class MailBuilder in Simplenews 8

Default mail builder.

Hierarchy

• class \Drupal\simplenews\Mail\MailBuilder implements MailBuilderInterface

1 string reference to 'MailBuilder'

simplenews.services.yml in ./simplenews.services.yml

simplenews.services.yml

1 service uses MailBuilder

simplenews.mail_builder in ./simplenews.services.yml

Drupal\simplenews\Mail\MailBuilder

File

src/Mail/MailBuilder.php, line 13

Namespace

Drupal\simplenews\Mail

class MailBuilder implements MailBuilderInterface {

  /**
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

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

  /**
   * @var \Drupal\simplenews\Subscription\SubscriptionManagerInterface
   */
  protected $subscriptionManager;

  /**
   * Constructs a MailBuilder.
   *
   * @param \Drupal\Core\Utility\Token $token
   *   The token service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\simplenews\Subscription\SubscriptionManagerInterface $subscription_manager
   *   The subscription manager.
   */
  public function __construct(Token $token, ConfigFactoryInterface $config_factory, SubscriptionManagerInterface $subscription_manager) {
    $this->token = $token;
    $this->config = $config_factory
      ->get('simplenews.settings');
    $this->subscriptionManager = $subscription_manager;
  }

  /**
   * {@inheritdoc}
   */
  function buildNewsletterMail(array &$message, MailInterface $mail) {

    // Get message data from the mail.
    $message['headers'] = $mail
      ->getHeaders($message['headers']);
    $message['subject'] = $mail
      ->getSubject();
    $message['body']['body'] = $mail
      ->getBody();
    if ($mail
      ->getFormat() == 'html') {

      // Set the necessary headers to detect this as an HTML mail. Set both the
      // Content-Type header, and the format (Swiftmailer) and plain (Mime Mail)
      // params.
      $message['headers']['Content-Type'] = 'text/html; charset=UTF-8';
      $message['params']['format'] = 'text/html';
      $message['params']['plain'] = NULL;

      // Provide a plain text version, both in params][plaintext (Mime Mail) and
      // plain (Swiftmailer).
      $message['params']['plaintext'] = $mail
        ->getPlainBody();
      $message['plain'] = $message['params']['plaintext'];

      // Add attachments, again, both for the attachments key (Mime Mail) and
      // files (Swiftmailer).
      $message['params']['attachments'] = $mail
        ->getAttachments();
      $message['params']['files'] = $message['params']['attachments'];
    }
    else {

      // This is a plain text email, explicitly mark it as such, the default
      // Content-Type header already defaults to that.
      $message['params']['plain'] = TRUE;
      $message['params']['format'] = 'text/plain';
    }
  }

  /**
   * {@inheritdoc}
   */
  function buildSubscribeMail(array &$message, array $params) {
    $context = $params['context'];

    // Use formatted from address "name" <mail_address>
    $message['headers']['From'] = $params['from']['formatted'];
    $message['subject'] = $this->config
      ->get('subscription.confirm_subscribe_subject');
    $message['subject'] = $this->token
      ->replace($message['subject'], $context, array(
      'sanitize' => FALSE,
    ));
    if ($context['simplenews_subscriber']
      ->isSubscribed($context['newsletter']
      ->id())) {
      $body = $this->config
        ->get('subscription.confirm_subscribe_subscribed');
    }
    else {
      $body = $this->config
        ->get('subscription.confirm_subscribe_unsubscribed');
    }
    $message['body'][] = $this->token
      ->replace($body, $context, array(
      'sanitize' => FALSE,
    ));
  }

  /**
   * {@inheritdoc}
   */
  function buildCombinedMail(&$message, $params) {
    $context = $params['context'];
    $subscriber = $context['simplenews_subscriber'];
    $langcode = $message['langcode'];

    // Use formatted from address "name" <mail_address>
    $message['headers']['From'] = $params['from']['formatted'];
    $message['subject'] = $this->config
      ->get('subscription.confirm_combined_subject');
    $message['subject'] = $this->token
      ->replace($message['subject'], $context, array(
      'sanitize' => FALSE,
    ));
    $changes_list = '';
    $actual_changes = 0;
    foreach ($this->subscriptionManager
      ->getChangesList($context['simplenews_subscriber'], $subscriber
      ->getChanges(), $langcode) as $newsletter_id => $change) {
      $changes_list .= ' - ' . $change . "\n";

      // Count the actual changes.
      $subscribed = $context['simplenews_subscriber']
        ->isSubscribed($newsletter_id);
      $changes = $subscriber
        ->getChanges();
      if ($changes[$newsletter_id] == 'subscribe' && !$subscribed || $changes[$newsletter_id] == 'unsubscribe' && $subscribed) {
        $actual_changes++;
      }
    }

    // If there are actual changes, use the combined_body key otherwise use the
    // one without a confirmation link.
    $body_key = $actual_changes ? 'combined_body' : 'combined_body_unchanged';
    $body = $this->config
      ->get('subscription.confirm_' . $body_key);

    // The changes list is not an actual token.
    $body = str_replace('[changes-list]', $changes_list, $body);
    $message['body'][] = $this->token
      ->replace($body, $context, array(
      'sanitize' => FALSE,
    ));
  }

  /**
   * {@inheritdoc}
   */
  function buildUnsubscribeMail(&$message, $params) {
    $context = $params['context'];

    // Use formatted from address "name" <mail_address>
    $message['headers']['From'] = $params['from']['formatted'];
    $message['subject'] = $this->config
      ->get('subscription.confirm_subscribe_subject');
    $message['subject'] = $this->token
      ->replace($message['subject'], $context, array(
      'sanitize' => FALSE,
    ));
    if ($context['simplenews_subscriber']
      ->isSubscribed($context['newsletter']
      ->id())) {
      $body = $this->config
        ->get('subscription.confirm_unsubscribe_subscribed');
      $message['body'][] = $this->token
        ->replace($body, $context, array(
        'sanitize' => FALSE,
      ));
    }
    else {
      $body = $this->config
        ->get('subscription.confirm_unsubscribe_unsubscribed');
      $message['body'][] = $this->token
        ->replace($body, $context, array(
        'sanitize' => FALSE,
      ));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MailBuilder::$config	protected	property
MailBuilder::$subscriptionManager	protected	property
MailBuilder::$token	protected	property
MailBuilder::buildCombinedMail		function	Build subject and body of the subscribe confirmation email. Overrides MailBuilderInterface::buildCombinedMail
MailBuilder::buildNewsletterMail		function	Build subject and body of the test and normal newsletter email. Overrides MailBuilderInterface::buildNewsletterMail
MailBuilder::buildSubscribeMail		function	Build subject and body of the subscribe confirmation email. Overrides MailBuilderInterface::buildSubscribeMail
MailBuilder::buildUnsubscribeMail		function	Build subject and body of the unsubscribe confirmation email. Overrides MailBuilderInterface::buildUnsubscribeMail
MailBuilder::__construct	public	function	Constructs a MailBuilder.