interface MailBuilderInterface in Simplenews 8.2

Builds newsletter and confirmation mails.

Hierarchy

• interface \Drupal\simplenews\Mail\MailBuilderInterface

File

src/Mail/MailBuilderInterface.php, line 8

Namespace

Drupal\simplenews\Mail

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.
   */
  public 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().
   */
  public 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().
   */
  public function buildCombinedMail(array &$message, array $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().
   */
  public function buildUnsubscribeMail(array &$message, array $params);

}

Members

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