mail

Collection: community.general

Full Name: parallax.community.general.mail

Aliases: community.general.mail, mail

Synopsis

Send an email from the playbook

Parameters

Name	Type	Required	Default	Description
host	string		`localhost`	SMTP server hostname
port	int		`25`	SMTP server port
to	string	yes		Recipient email address(es), comma-separated
cc	string			CC email address(es), comma-separated
bcc	string			BCC email address(es), comma-separated
subject	string	yes		Email subject line
body	string			Email body content
from	string		`root`	Sender email address
secure	string		`try`	Security mode (always, never, try, starttls)
username	string			SMTP authentication username
password	string			SMTP authentication password
headers	string			Additional email headers as key=value pairs
charset	string		`utf-8`	Character set for the email
subtype	string		`plain`	MIME subtype (plain, html)
timeout	int		`20`	SMTP connection timeout in seconds
attach	string			File path(s) to attach, comma-separated

Example

- name: Notify the on-call address that the deploy finished
  mail:
    host: smtp.example.com
    port: 587
    to: oncall@example.com
    subject: "Deploy of {{ app_version }} complete"
    body: "{{ inventory_hostname }} finished without errors."
    from: parallax@example.com