Example: Email

  1. drupal
    1. 8
    2. 6
    3. 7

Example of how to use Drupal's mail API.

This example module provides two different examples of the Drupal email API:

  • Defines a simple contact form and shows how to use drupal_mail() to send an e-mail (defined in hook_mail()) when the form is submitted.
  • Shows how modules can alter emails defined by other Drupal modules or Core using hook_mail_alter by attaching a custom signature before they are sent.

Functions & methods

NameDescription
email_example_formThe contact form.
email_example_form_submitForm submission logic for the contact form.
email_example_form_validateForm validation logic for the contact form.
email_example_mailImplement hook_mail().
email_example_mail_alterImplement hook_mail_alter().
email_example_mail_sendSends an e-mail.
email_example_menuImplement hook_menu().

examples/email_example/email_example.module, line 7