You are here

interface MailBuilderInterface in Simplenews 8

Same name and namespace in other branches
  1. 8.2 src/Mail/MailBuilderInterface.php \Drupal\simplenews\Mail\MailBuilderInterface
  2. 3.x src/Mail/MailBuilderInterface.php \Drupal\simplenews\Mail\MailBuilderInterface

Builds newsletter and confirmation mails.

Hierarchy

Expanded class hierarchy of MailBuilderInterface

All classes that implement MailBuilderInterface

File

src/Mail/MailBuilderInterface.php, line 8

Namespace

Drupal\simplenews\Mail
View source
interface MailBuilderInterface {

  /**
   * Build subject and body of the test and normal newsletter email.
   *
   * @param array $message
   *   Message array as used by hook_mail().
   * @param \Drupal\simplenews\Mail\MailInterface $mail
   *   The mail object.
   */
  function buildNewsletterMail(array &$message, MailInterface $mail);

  /**
   * Build subject and body of the subscribe confirmation email.
   *
   * @param array $message
   *   Message array as used by hook_mail().
   * @param array $params
   *   Parameter array as used by hook_mail().
   */
  function buildSubscribeMail(array &$message, array $params);

  /**
   * Build subject and body of the subscribe confirmation email.
   *
   * @param array $message
   *   Message array as used by hook_mail().
   * @param array $params
   *   Parameter array as used by hook_mail().
   */
  function buildCombinedMail(&$message, $params);

  /**
   * Build subject and body of the unsubscribe confirmation email.
   *
   * @param array $message
   *   Message array as used by hook_mail().
   * @param array $params
   *   Parameter array as used by hook_mail().
   */
  function buildUnsubscribeMail(&$message, $params);

}

Members

Namesort descending Modifiers Type Description Overrides
MailBuilderInterface::buildCombinedMail function Build subject and body of the subscribe confirmation email. 1
MailBuilderInterface::buildNewsletterMail function Build subject and body of the test and normal newsletter email. 1
MailBuilderInterface::buildSubscribeMail function Build subject and body of the subscribe confirmation email. 1
MailBuilderInterface::buildUnsubscribeMail function Build subject and body of the unsubscribe confirmation email. 1