community.general.mail – Отправка электронного письма
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в книге задач укажите: community.general.mail
Описание
- Этот модуль полезен для отправки электронных писем из книг задач.
- Возникает вопрос: зачем автоматизировать отправку электронных писем? В сложных средах время от времени встречаются процессы, которые невозможно автоматизировать, либо из-за отсутствия полномочий, либо из-за отсутствия общего подхода.
- Если определенный шаг нельзя автоматизировать, но он не блокирующий, отправка электронного письма уполномоченному лицу, чтобы тот выполнил свою часть сделки, — элегантный способ возложить ответственность на другого.
- Конечно, отправка письма также может быть полезной для уведомления одного или нескольких людей в команде о том, что определенное действие было (успешно) выполнено.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| attach список / элементы=строка | Значение по умолчанию: [] | Список путей к файлам, которые должны быть прикреплены к сообщению. Прикрепленные файлы будут иметь тип содержимого, установленный на application/octet-stream |
| bcc список / элементы=строка | Адрес(ы) электронной почты, которому(ым) отправляется письмо «в скрытой копии». Это список, который может содержать адреса и фразы. | |
| body строка | Тело отправляемого электронного письма. | |
| cc список / элементы=строка | Адрес(ы) электронной почты, которому(ым) отправляется письмо в копии. Это список, который может содержать адреса и фразы. | |
| charset строка | Значение по умолчанию: "utf-8" | Кодировка символов отправляемого электронного письма. |
| headers список / элементы=строка | Значение по умолчанию: [] | Список заголовков, которые должны быть добавлены к сообщению. Каждый отдельный заголовок задается как header=value (см. пример ниже). |
| host строка | Значение по умолчанию: "localhost" | Сервер электронной почты. |
| password строка | Если SMTP требует пароль. | |
| port целое число | Значение по умолчанию: 25 | Порт сервера электронной почты. Это должно быть целое число от 1 до 65534 |
| secure строка |
| Если always, соединение будет отправлять электронное письмо только если соединение зашифровано. Если сервер не принимает зашифрованное соединение, произойдет ошибка.Если try, соединение попытается установить безопасное соединение SSL/TLS перед отправкой.Если never, соединение не будет пытаться установить безопасное соединение SSL/TLS перед отправкой.Если starttls, соединение попытается перейти к защищенному соединению SSL/TLS перед отправкой. Если это невозможно, произойдет ошибка. |
| sender строка | Значение по умолчанию: "root" | Адрес электронной почты, с которого отправляется письмо. Может содержать адрес и фразу. псевдонимы: от |
| subject строка / требуется | Тема отправляемого электронного письма. псевдонимы: сообщение | |
| subtype строка |
| Незначительный тип MIME, может быть plain или html. Основной тип всегда text. |
| timeout целое число | Значение по умолчанию: 20 | Устанавливает таймаут в секундах для попыток подключения. |
| to список / элементы=строка | Значение по умолчанию: "root" | Адрес(ы) электронной почты, которому(ым) отправляется письмо. Это список, который может содержать адреса и фразы. псевдонимы: получатели |
| username строка | Если SMTP требует имя пользователя. |
Примеры
- name: Example playbook sending mail to root
community.general.mail:
subject: System {{ ansible_hostname }} has been successfully provisioned.
delegate_to: localhost
- name: Sending an e-mail using Gmail SMTP servers
community.general.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
community.general.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
community.general.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
community.general.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
community.general.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
Авторы
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/mail_module.html