class MailEntity in Simplenews 3.x

Default mail class for entities.

Hierarchy

• class \Drupal\simplenews\Mail\MailEntity implements MailInterface uses DependencySerializationTrait

1 file declares its use of MailEntity

SpoolList.php in src/Spool/SpoolList.php

File

src/Mail/MailEntity.php, line 16

Namespace

Drupal\simplenews\Mail

class MailEntity implements MailInterface {
  use DependencySerializationTrait;

  /**
   * The newsletter issue.
   *
   * @var \Drupal\Core\Entity\ContentEntityInterface
   */
  protected $issue;

  /**
   * The cached build render array.
   *
   * @var array
   */
  protected $build;

  /**
   * The newsletter.
   *
   * @var \Drupal\simplenews\NewsletterInterface
   */
  protected $newsletter;

  /**
   * The subscriber and therefore recipient of this mail.
   *
   * @var \Drupal\simplenews\SubscriberInterface
   */
  protected $subscriber;

  /**
   * The mail key used for mails.
   *
   * @var string
   */
  protected $key = 'test';

  /**
   * Cache implementation used for this mail.
   *
   * @var MailCacheInterface
   */
  protected $cache;

  /**
   * Constructs a MailEntity object.
   */
  public function __construct(ContentEntityInterface $issue, SubscriberInterface $subscriber, MailCacheInterface $mail_cache) {
    $this->subscriber = $subscriber;
    $this->issue = $issue;
    if ($this->issue
      ->hasTranslation($this
      ->getLanguage())) {
      $this->issue = $this->issue
        ->getTranslation($this
        ->getLanguage());
    }
    $this->cache = $mail_cache;
    $this->newsletter = $issue->simplenews_issue->entity;
  }

  /**
   * Returns the corresponding newsletter.
   *
   * @return \Drupal\simplenews\NewsletterInterface
   *   The newsletter.
   */
  public function getNewsletter() {
    return $this->newsletter;
  }

  /**
   * {@inheritdoc}
   */
  public function getSubscriber() {
    return $this->subscriber;
  }

  /**
   * {@inheritdoc}
   */
  public function getHeaders(array $headers) {

    // If receipt is requested, add headers.
    if ($this->newsletter->receipt) {
      $headers['Disposition-Notification-To'] = $this
        ->getFromAddress();
      $headers['X-Confirm-Reading-To'] = $this
        ->getFromAddress();
    }

    // Add priority if set.
    switch ($this->newsletter->priority) {
      case SIMPLENEWS_PRIORITY_HIGHEST:
        $headers['Priority'] = 'High';
        $headers['X-Priority'] = '1';
        $headers['X-MSMail-Priority'] = 'Highest';
        break;
      case SIMPLENEWS_PRIORITY_HIGH:
        $headers['Priority'] = 'urgent';
        $headers['X-Priority'] = '2';
        $headers['X-MSMail-Priority'] = 'High';
        break;
      case SIMPLENEWS_PRIORITY_NORMAL:
        $headers['Priority'] = 'normal';
        $headers['X-Priority'] = '3';
        $headers['X-MSMail-Priority'] = 'Normal';
        break;
      case SIMPLENEWS_PRIORITY_LOW:
        $headers['Priority'] = 'non-urgent';
        $headers['X-Priority'] = '4';
        $headers['X-MSMail-Priority'] = 'Low';
        break;
      case SIMPLENEWS_PRIORITY_LOWEST:
        $headers['Priority'] = 'non-urgent';
        $headers['X-Priority'] = '5';
        $headers['X-MSMail-Priority'] = 'Lowest';
        break;
    }

    // Add user specific header data.
    $headers['From'] = $this
      ->getFromFormatted();
    $headers['List-Unsubscribe'] = '<' . \Drupal::token()
      ->replace('[simplenews-subscriber:unsubscribe-url]', $this
      ->getTokenContext()) . '>';

    // Add general headers.
    $headers['Precedence'] = 'bulk';
    return $headers;
  }

  /**
   * {@inheritdoc}
   */
  public function getTokenContext() {
    return [
      'newsletter' => $this
        ->getNewsletter(),
      'simplenews_subscriber' => $this
        ->getSubscriber(),
      $this
        ->getIssue()
        ->getEntityTypeId() => $this
        ->getIssue(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function setKey($key) {
    $this->key = $key;
  }

  /**
   * {@inheritdoc}
   */
  public function getKey() {
    return $this->key;
  }

  /**
   * {@inheritdoc}
   */
  public function getFromFormatted() {

    // Windows based PHP systems don't accept formatted email addresses.
    if (mb_substr(PHP_OS, 0, 3) == 'WIN') {
      return $this
        ->getFromAddress();
    }
    return '"' . addslashes(Unicode::mimeHeaderEncode($this
      ->getNewsletter()->from_name)) . '" <' . $this
      ->getFromAddress() . '>';
  }

  /**
   * {@inheritdoc}
   */
  public function getFromAddress() {
    return $this
      ->getNewsletter()->from_address;
  }

  /**
   * {@inheritdoc}
   */
  public function getRecipient() {
    return $this
      ->getSubscriber()
      ->getMail();
  }

  /**
   * {@inheritdoc}
   */
  public function getFormat() {
    return $this
      ->getNewsletter()->format;
  }

  /**
   * {@inheritdoc}
   */
  public function getLanguage() {
    return $this
      ->getSubscriber()
      ->getLangcode();
  }

  /**
   * {@inheritdoc}
   */
  public function getIssue() {
    return $this->issue;
  }

  /**
   * {@inheritdoc}
   */
  public function getSubject() {

    // Build email subject and perform some sanitizing.
    // Use the requested language if enabled.
    $langcode = $this
      ->getLanguage();
    $subject = simplenews_token_replace_subject($this
      ->getNewsletter()->subject, $this
      ->getTokenContext(), [
      'langcode' => $langcode,
    ]);

    // Line breaks are removed from the email subject to prevent injection of
    // malicious data into the email header.
    $subject = str_replace([
      "\r",
      "\n",
    ], '', $subject);
    return $subject;
  }

  /**
   * Set up the necessary language and user context.
   */
  protected function setContext() {

    // Switch to the user.
    if ($this->uid = $this
      ->getSubscriber()
      ->getUserId()) {
      \Drupal::service('account_switcher')
        ->switchTo(User::load($this->uid));
    }

    // Change language if the requested language is enabled.
    // @codingStandardsIgnoreStart

    /*$language = $this->getLanguage();
      $languages = LanguageManagerInterface::getLanguages();
      if (isset($languages[$language])) {
        $this->original_language = \Drupal::languageManager()->getCurrentLanguage();
        $GLOBALS['language'] = $languages[$language];
        $GLOBALS['language_url'] = $languages[$language];
        // Overwrites the current content language for i18n_select.
        if (\Drupal::moduleHandler()->moduleExists('i18n_select')) {
          $GLOBALS['language_content'] = $languages[$language];
        }
      }*/

    // @codingStandardsIgnoreEnd
  }

  /**
   * Reset the context.
   */
  protected function resetContext() {

    // Switch back to the previous user.
    if ($this->uid) {
      \Drupal::service('account_switcher')
        ->switchBack();
    }

    // Switch language back.
    if (!empty($this->original_language)) {
      $GLOBALS['language'] = $this->original_language;
      $GLOBALS['language_url'] = $this->original_language;
      if (\Drupal::moduleHandler()
        ->moduleExists('i18n_select')) {
        $GLOBALS['language_content'] = $this->original_language;
      }
    }
  }

  /**
   * Build the entity object.
   *
   * The resulting build array is cached as it is used in multiple places.
   *
   * @param string|null $format
   *   (Optional) Override the default format. Defaults to getFormat().
   */
  protected function build($format = NULL) {
    if (empty($format)) {
      $format = $this
        ->getFormat();
    }
    if (!empty($this->build[$format])) {
      return $this->build[$format];
    }

    // Build message body
    // Supported view modes: 'email_plain', 'email_html'.
    $build = \Drupal::entityTypeManager()
      ->getViewBuilder($this
      ->getIssue()
      ->getEntityTypeId())
      ->view($this
      ->getIssue(), 'email_' . $format, $this
      ->getLanguage());
    $build['#entity_type'] = $this
      ->getIssue()
      ->getEntityTypeId();

    // @todo: Consider using render caching.
    unset($build['#cache']);

    // We need to prevent the standard theming hooks, but we do want to allow
    // modules such as panelizer that override it, so only clear the standard
    // entity hook and entity type hooks.
    if ($build['#theme'] == 'entity' || $build['#theme'] == $this
      ->getIssue()
      ->getEntityTypeId()) {
      unset($build['#theme']);
    }
    $this->build[$format] = $build;
    return $this->build[$format];
  }

  /**
   * Build the themed newsletter body.
   *
   * @param string|null $format
   *   (Optional) Override the default format. Defaults to getFormat().
   *
   * @return string
   *   The newsletter body.
   */
  protected function buildBody($format = NULL) {
    if (empty($format)) {
      $format = $this
        ->getFormat();
    }
    if ($cache = $this->cache
      ->get($this, 'build', 'body:' . $format)) {
      return $cache;
    }
    $body = $this
      ->build($format) + [
      '#theme' => 'simplenews_newsletter_body',
      '#newsletter' => $this
        ->getNewsletter(),
      '#language' => $this
        ->getLanguage(),
      '#simplenews_subscriber' => $this
        ->getSubscriber(),
      '#key' => $this
        ->getKey(),
      '#format' => $format,
    ];
    $markup = \Drupal::service('renderer')
      ->renderPlain($body);
    $this->cache
      ->set($this, 'build', 'body:' . $format, $markup);
    return $markup;
  }

  /**
   * {@inheritdoc}
   */
  public function getBody() {
    return $this
      ->getBodyWithFormat($this
      ->getFormat());
  }

  /**
   * {@inheritdoc}
   */
  public function getPlainBody() {
    return $this
      ->getBodyWithFormat('plain');
  }

  /**
   * Get the body with the requested format.
   *
   * @param string $format
   *   Either html or plain.
   *
   * @return string
   *   The rendered mail body as a string.
   */
  protected function getBodyWithFormat($format) {

    // Switch to correct user and language context.
    $this
      ->setContext();
    if ($cache = $this->cache
      ->get($this, 'final', 'body:' . $format)) {
      return $cache;
    }
    $body = $this
      ->buildBody($format);

    // Build message body, replace tokens.
    $body = \Drupal::token()
      ->replace($body, $this
      ->getTokenContext(), [
      'langcode' => $this
        ->getLanguage(),
    ]);
    if ($format == 'plain') {

      // Convert HTML to text if requested to do so.
      $body = MailFormatHelper::htmlToText($body, $this
        ->getNewsletter()->hyperlinks);
    }
    else {
      $body = Markup::create($body);
    }
    $this->cache
      ->set($this, 'final', 'body:' . $format, $body);
    $this
      ->resetContext();
    return $body;
  }

  /**
   * {@inheritdoc}
   */
  public function getAttachments() {
    if ($cache = $this->cache
      ->get($this, 'data', 'attachments')) {
      return $cache;
    }
    $attachments = [];
    $build = $this
      ->build();
    $fids = [];
    foreach ($this
      ->getIssue()
      ->getFieldDefinitions() as $field_name => $field_definition) {

      // @todo: Find a better way to support more field types.
      // Only add fields of type file which are enabled for the current view
      // mode as attachments.
      if ($field_definition
        ->getType() == 'file' && isset($build[$field_name])) {
        if ($items = $this
          ->getIssue()
          ->get($field_name)) {
          foreach ($items as $item) {
            $fids[] = $item->target_id;
          }
        }
      }
    }
    if (!empty($fids)) {
      $attachments = File::loadMultiple($fids);
    }
    $this->cache
      ->set($this, 'data', 'attachments', $attachments);
    return $attachments;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MailEntity::$build	protected	property	The cached build render array.
MailEntity::$cache	protected	property	Cache implementation used for this mail.
MailEntity::$issue	protected	property	The newsletter issue.
MailEntity::$key	protected	property	The mail key used for mails.
MailEntity::$newsletter	protected	property	The newsletter.
MailEntity::$subscriber	protected	property	The subscriber and therefore recipient of this mail.
MailEntity::build	protected	function	Build the entity object.
MailEntity::buildBody	protected	function	Build the themed newsletter body.
MailEntity::getAttachments	public	function	Returns an array of attachments for this newsletter mail. Overrides MailInterface::getAttachments
MailEntity::getBody	public	function	Returns the mail body. Overrides MailInterface::getBody
MailEntity::getBodyWithFormat	protected	function	Get the body with the requested format.
MailEntity::getFormat	public	function	Returns the mail format. Overrides MailInterface::getFormat
MailEntity::getFromAddress	public	function	Returns the plain mail address. Overrides MailInterface::getFromAddress
MailEntity::getFromFormatted	public	function	Returns the formatted from mail address. Overrides MailInterface::getFromFormatted
MailEntity::getHeaders	public	function	Returns the mail headers. Overrides MailInterface::getHeaders
MailEntity::getIssue	public	function	Returns the newsletter issue entity. Overrides MailInterface::getIssue
MailEntity::getKey	public	function	Returns the mail key to be used for mails. Overrides MailInterface::getKey
MailEntity::getLanguage	public	function	The language that should be used for this newsletter mail. Overrides MailInterface::getLanguage
MailEntity::getNewsletter	public	function	Returns the corresponding newsletter.
MailEntity::getPlainBody	public	function	Returns the plaintext body. Overrides MailInterface::getPlainBody
MailEntity::getRecipient	public	function	Returns the recipient of this newsletter mail. Overrides MailInterface::getRecipient
MailEntity::getSubject	public	function	Returns the mail subject. Overrides MailInterface::getSubject
MailEntity::getSubscriber	public	function	Returns the subscriber object. Overrides MailInterface::getSubscriber
MailEntity::getTokenContext	public	function	Returns the token context to be used with token replacements. Overrides MailInterface::getTokenContext
MailEntity::resetContext	protected	function	Reset the context.
MailEntity::setContext	protected	function	Set up the necessary language and user context.
MailEntity::setKey	public	function	Set the mail key. Overrides MailInterface::setKey
MailEntity::__construct	public	function	Constructs a MailEntity object.