Book Image

Learning Drupal 6 Module Development

Book Image

Learning Drupal 6 Module Development

Overview of this book

Table of Contents (14 chapters)
Learning Drupal 6 Module Development
Credits
About the Author
About the Reviewers
Preface

Sending Mail with the Mail API


The Drupal 6 Mail API is used to provide mail-sending services to Drupal modules. In most cases, using the Mail API is a two-step process:

  1. 1. Implement hook_mail() in your module.

  2. 2. Elsewhere in your module, use the drupal_mail() function to invoke your hook_mail() implementation and also do additional formatting and sending.

In the previous section, we briefly glanced at the drupal_mail() function. Here, we will start by looking at the function in more detail. Inside emailusers_compose_form_submit(), we called drupal_mail() with the following parameters:

drupal_mail(
'emailusers',
'composemessage',
$account->mail,
user_preferred_language($account),
$form_values,
variable_get('site_mail', null),
true // Automatically send
);

Seven parameters! To get an idea as to what is going on here, let's look at each in turn.

The first parameter (emailusers) is the name of the module that contains an implementation of hook_mail(). Later, we will look at the emailusers_mail...