This example demonstrates how to use the mail API.
This module provides two different examples of the Backdrop email API:
- Defines a simple contact form and shows how to use backdrop_mail() to send an e-mail (defined in hook_mail()) when the form is submitted.
- Shows how modules can alter emails defined by other modules, using hook_mail_alter(), to attach a custom signature before they are sent.
Parent topics
File
- modules/
examples/ email_example/ email_example.module, line 7 - Hook implementations for the Email Example module.
Functions
Name | Location | Description |
---|---|---|
email_example_mail |
modules/ |
Implements hook_mail(). |
email_example_mail_send |
modules/ |
Sends an e-mail. |
email_example_mail_alter |
modules/ |
Implements hook_mail_alter(). |
email_example_menu |
modules/ |
Implements hook_menu(). |
email_example_form |
modules/ |
The contact form. |
email_example_form_validate |
modules/ |
Form validation logic for the contact form. |
email_example_form_submit |
modules/ |
Form submission logic for the contact form. |
Classes
Name | Location | Description |
---|---|---|
EmailExampleTestCase |
modules/ |
Functionality tests for email example module. |