Drupal: Adding a footer to all of your system e-mail

Drupal’s hook system is making me almost as happy as Emacs’ hook system does. =)

There’s a hook_mail_alter function that allows you to modify any message your system sends. Example:

function mymodule_mail_alter($mailkey, &$to, &$subject, &$body, &$from, &$headers) {
   $body .= "\n\n" . t('This is a system-generated email, please do not reply to this message');
}

You gotta love developers who plan for extensibility and put all sorts of hooks into the code…

9 responses to “Drupal: Adding a footer to all of your system e-mail”

  1. Yeah, the hook system is pretty amazing, and it’s wild to see how much functionality has been added through hooks alone.

    By the way, did you ever meet or talk to my friend Rob Loach? I swear, he lives to write Drupal modules to integrate into every single other website out there.

  2. Seems that you are really impressed with the drupal’s hook system :-)

    BTW,
    is your example just for Drupal 5, or maybe Drupal 6?

    1. hook_mail_alter has existed since Drupal 5, but has different arguments in Drupal 6 and later. The example that Sacha posted is for Drupal 5.

      With Drupal 6, rather than passing in a bunch of parameters, a single structured array is passed in. Here’s the example from above, modified for Drupal 6:


      function mymodule_mail_alter(&$message) {
      $message['body'] .= "\n\n" . t('This is a system-generated email, please do not reply to this message');
      }

  3. Phil L. says:

    This is for Drupal 6 and beyond.

    I just want to warn users that implementing this will alter all emails sent from the server.

    Not necessarily a problem, unless you’re running Listhandler or another module that does email out posts/comments/forum posts to mailing lists (etc).

    Cheers.

    Phil L.

  4. Phil L. says:

    ;) You can scrub my “Drupal 6 and beyond” comment then ;).

  5. Beto says:

    Could I cancel an outgoing email with this function??? How? Thanks :)

  6. Anil says:

    Hi guys,

    I am trying to override the default hook_mail behavior in contact_mail since the message doesn’t send me the visitor’s email address.

    I’ve got the new contact_mail function written but I don’t really know how to override the default contact_mail function and have my function called instead.

    Maybe I need to override the form… not sure.

    Newbie here.

    Thanks,
    -Anil

  7. Sacha Chua says:

    You could cheat and just edit contact.module directly. =)

  8. Sacha Chua says:

    Actually, you could do a hook_mail_alter in your custom module. When you see a message with the mail ID contact-user-mail (or whatever it is; I’m looking at Drupal 5’s contact module), use the global $user variable and just tack the e-mail address from that $user onto the message. Hope that helps!

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>