You are here

Home » API reference » Swift Mailer 8.2

swiftmailer.api.php in Swift Mailer 8.2

Same filename and directory in other branches
  1. 8 swiftmailer.api.php

Hooks specific to the SwiftMailer module.

File

swiftmailer.api.php
View source 
<?php

/**
 * @file
 * Hooks specific to the SwiftMailer module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alter messages before sending it with SwiftMailer.
 *
 * @see \Drupal\swiftmailer\Plugin\Mail\SwiftMailer::mail
 */
function hook_swiftmailer_alter(Swift_Mailer &$swiftMailer, Swift_Message &$swiftMessage, $message) {

  // Set read receipt.
  $swiftMessage
    ->setReadReceiptTo([
    'your@address.com',
  ]);

  // Register a SwiftMailer Plugin.
  // @see https://swiftmailer.symfony.com/docs/plugins.html
  $replacements = [];
  $decorator = new Swift_Plugins_DecoratorPlugin($replacements);
  $swiftMailer
    ->registerPlugin($decorator);
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Namesort descending Description
hook_swiftmailer_alter Alter messages before sending it with SwiftMailer.