Install

Works with Drupal: 7.x

Using Composer to manage Drupal site dependencies

Downloads

Download mailsystem-7.x-2.21.tar.gztar.gz 15.74 KB
MD5: 8f10945c3a9c878613730ce132e55148
SHA-1: 062db9075ca8092cd9bf28ef936c175de78c2b4b
SHA-256: eb526514d47ee2f10c57fe1f739b6853c645ee496c6fdc937ca378030ba7862d
Download mailsystem-7.x-2.21.zipzip 18.76 KB
MD5: 708266f14123169610a8a01a9a63a5ad
SHA-1: 026d56b530df5062b5aa326fb3993900dfe52f69
SHA-256: 6ffeaf2b5048974b6445d4af2ad746ccae2b3391fc988f3b69b7a5856922374a

Release notes

Fixes:
#1172996-5: Track recent changes in #299138

Mail System

Provides an Administrative UI and Developers API for safely updating the mail_system configuration variable.

Administrative UI

The administrative interface is at admin/config/system/mailsystem. A screenshot is available.

Used by;

Developers API

A module example with a MailSystemInterface implementation called ExampleMailSystem should add the following in its example.install file:

/**
 * Implements hook_enable().
 */
function example_enable() {
  mailsystem_set(array('example' => 'ExampleMailSystem'));
}
/**
 * Implements hook_disable().
 */
function example_disable() {
  mailsystem_clear(array('example' => 'ExampleMailSystem'));
}

The above settings allow mail sent by example to use ExampleMailSystem. To make ExampleMailSystem the site-wide default for sending mail:

mailsystem_set(array(mailsystem_default_id() => 'ExampleMailSystem'));

To restore the default mail system:

mailsystem_set(array(mailsystem_default_id() => mailsystem_default_value()));

Or simply:

mailsystem_set(mailsystem_defaults());

If module example relies on dependency foo and its FooMailSystem class, then the example.install code should like like this:

/**
 * Implements hook_enable().
 */
function example_enable() {
  mailsystem_set(array('example' => 'FooMailSystem'));
}
/**
 * Implements hook_disable().
 */
function example_disable() {
  mailsystem_clear(array('example' => ''));
}

If module example only wants to use FooMailSystem when sending emails with a key of examail, then the example.install code should look like this:

/**
 * Implements hook_enable().
 */
function example_enable() {
  mailsystem_set(array('example_examail' => 'FooMailSystem'));
}
/**
 * Implements hook_disable().
 */
function example_disable() {
  mailsystem_clear(array('example_examail' => ''));
}

(New in 2.x branch)

To change the site-wide defaults to use the FooMailSystem for formatting messages and the BarMailSystem for sending them:

mailsystem_set(
  array(
    mailsystem_default_id() => array(
      'format' => 'FooMailSystem',
      'mail' => 'BarMailSystem',
    ),
  )
);

To change the site-wide defaults to use the FooMailSystem for sending messages, while continuing to use the current system for formatting them:

mailsystem_set(
  array(
    mailsystem_default_id() => array(
      'mail' => 'FooMailsystem',
    ),
  )
);

References

drupal_mail_system() API documentation:

api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/7

MailSystemInterface API documentation:

api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/7

Creating HTML formatted mails in Drupal 7

drupal.org/node/900794

Created by: pillarsdotnet
Created on: 3 Jun 2011 at 18:12 UTC
Last updated: 3 Jun 2011 at 18:17 UTC
Bug fixes

Other releases