Parameter | Choices/Defaults | Comments |
---|---|---|
attach
list
|
Default: []
|
A list of pathnames of files to attach to the message.
Attached files will have their content-type set to
application/octet-stream . |
bcc
list
|
The email-address(es) the mail is being 'blind' copied to.
This is a list, which may contain address and phrase portions.
|
|
body
string
|
Default: "$subject"
|
The body of the email being sent.
|
cc
list
|
The email-address(es) the mail is being copied to.
This is a list, which may contain address and phrase portions.
|
|
charset
string
|
Default: "utf-8"
|
The character set of email being sent.
|
from
string
|
Default: "root"
|
The email-address the mail is sent from. May contain address and phrase.
|
headers
list
|
Default: []
|
A list of headers which should be added to the message.
Each individual header is specified as
header=value (see example below). |
host
string
|
Default: "localhost"
|
The mail server.
|
password
string
|
If SMTP requires password.
|
|
port
integer
|
Default: 25
|
The mail server port.
This must be a valid integer between 1 and 65534
|
secure
string
added in 2.3 |
|
If
always , the connection will only send email if the connection is Encrypted. If the server doesn't accept the encrypted connection it will fail.If
try , the connection will attempt to setup a secure SSL/TLS session, before trying to send.If
never , the connection will not attempt to setup a secure SSL/TLS session, before sendingIf
starttls , the connection will try to upgrade to a secure SSL/TLS connection, before sending. If it is unable to do so it will fail. |
subject
string
/ required
|
The subject of the email being sent.
|
|
subtype
string
added in 2.0 |
|
The minor mime type, can be either
plain or html .The major type is always
text . |
timeout
integer
added in 2.3 |
Default: 20
|
Sets the timeout in seconds for connection attempts.
|
to
list
|
Default: "root"
|
The email-address(es) the mail is being sent to.
This is a list, which may contain address and phrase portions.
aliases: recipients |
username
string
|
If SMTP requires username.
|
- name: Example playbook sending mail to root
mail:
subject: System {{ ansible_hostname }} has been successfully provisioned.
delegate_to: localhost
- name: Sending an e-mail using Gmail SMTP servers
mail:
host: smtp.gmail.com
port: 587
username: username@gmail.com
password: mysecret
to: John Smith <john.smith@example.com>
subject: Ansible-report
body: System {{ ansible_hostname }} has been successfully provisioned.
delegate_to: localhost
- name: Send e-mail to a bunch of users, attaching files
mail:
host: 127.0.0.1
port: 2025
subject: Ansible-report
body: Hello, this is an e-mail. I hope you like it ;-)
from: jane@example.net (Jane Jolie)
to:
- John Doe <j.d@example.org>
- Suzie Something <sue@example.com>
cc: Charlie Root <root@localhost>
attach:
- /etc/group
- /tmp/avatar2.png
headers:
- Reply-To=john@example.com
- X-Special="Something or other"
charset: us-ascii
delegate_to: localhost
- name: Sending an e-mail using the remote machine, not the Ansible controller node
mail:
host: localhost
port: 25
to: John Smith <john.smith@example.com>
subject: Ansible-report
body: System {{ ansible_hostname }} has been successfully provisioned.
- name: Sending an e-mail using Legacy SSL to the remote machine
mail:
host: localhost
port: 25
to: John Smith <john.smith@example.com>
subject: Ansible-report
body: System {{ ansible_hostname }} has been successfully provisioned.
secure: always
- name: Sending an e-mail using StartTLS to the remote machine
mail:
host: localhost
port: 25
to: John Smith <john.smith@example.com>
subject: Ansible-report
body: System {{ ansible_hostname }} has been successfully provisioned.
secure: starttls
Hint
If you notice any issues in this documentation you can edit this document to improve it.