ANSIBLE.MAIL(3)                 ANSIBLE MODULES                ANSIBLE.MAIL(3)



NAME
       mail - Send an email

DESCRIPTION
       This module is useful for sending emails from playbooks.

       One may wonder why automate sending emails?  In complex environments
       there are from time to time processes that cannot be automated, either
       because you lack the authority to make it so, or because not everyone
       agrees to a common approach.

       If you cannot automate a specific step, but the step is non-blocking,
       sending out an email to the responsible party to make him perform his
       part of the bargain is an elegant way to put the responsibility in
       someone else's lap.

       Of course sending out a mail can be equally useful as a way to notify
       one or more people in a team that a specific action has been
       (successfully) taken.

OPTIONS
       bcc    The email-address(es) the mail is being 'blind' copied to. This
              is a comma-separated list.

       body   The body of the email being sent. (default: $subject)

       cc     The email-address(es) the mail is being copied to. This is a
              comma-separated list.

       from   The email-address the mail is sent from. (default: root)

       subject
              The subject of the email being sent.(required)

       to     The email-address(es) the mail is being sent to. This is a
              comma-separated list. (default: root)."

EXAMPLES
       Example playbook sending mail to root

       local_action: mail msg='System ${ansible_hostname} has been sucessfully provisioned.'

AUTHOR
       Dag Wieers

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#mail



0.9                               2012-11-30                   ANSIBLE.MAIL(3)
