community.general.mail callback – Sends failure events via email

Note

This callback plugin is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.mail.

Synopsis

  • This callback will report failures via email.

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • whitelisting in configuration

Parameters

Parameter

Comments

bcc

list / elements=string

BCC’d recipients.

Configuration:

  • INI entry:

    [callback_mail]
bcc = None

cc

list / elements=string

CC’d recipients.

Configuration:

  • INI entry:

    [callback_mail]
cc = None

mta

string

Mail Transfer Agent, server that accepts SMTP.

Default: “localhost”

Configuration:

  • INI entry:

    [callback_mail]
smtphost = localhost

  • Environment variable: SMTPHOST

mtaport

integer

Mail Transfer Agent Port.

Port at which server SMTP.

Default: 25

Configuration:

  • INI entry:

    [callback_mail]
smtpport = 25

sender

string

Mail sender.

Note that this will be required from community.general 6.0.0 on.

Configuration:

  • INI entry:

    [callback_mail]
sender = None

to

list / elements=string

Mail recipient.

Default: [“root”]

Configuration:

  • INI entry:

    [callback_mail]
to = ['root']

Authors

  • Dag Wieers (@dagwieers)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.