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

Note

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

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. You need further requirements to be able to use this callback plugin, see Requirements for details.

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

Callback plugin

This plugin is a notification callback. It sends information for a playbook run to other applications, services, or systems. See Callback plugins for more information on callback plugins.

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 = VALUE

cc

list / elements=string

CC’d recipients.

Configuration:

  • INI entry:

    [callback_mail]
cc = VALUE

message_id_domain

string

added in community.general 8.2.0

The domain name to use for the Message-ID header.

The default is the hostname of the control node.

Configuration:

  • INI entry:

    [callback_mail]
message_id_domain = VALUE

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 / required

Mail sender.

This is required since community.general 6.0.0.

Configuration:

  • INI entry:

    [callback_mail]
sender = VALUE

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.