Spec-Zone.ru › Ansible 2.9

mail – Отправка электронного письма

  • Обзор
  • Параметры
  • Примеры
  • Статус

Обзор

  • Этот модуль полезен для отправки электронных писем из плейбуков.
  • Можно задаться вопросом, зачем автоматизировать отправку писем? В сложных средах время от времени возникают процессы, которые нельзя автоматизировать, либо потому, что у вас нет полномочий для этого, либо потому, что не все согласны с единым подходом.
  • Если вы не можете автоматизировать конкретный шаг, но шаг не блокирующий, отправка электронного письма ответственному лицу, чтобы он выполнил свою часть сделки, является элегантным способом возложить ответственность на кого-то другого.
  • Конечно, отправка письма также может быть полезной для уведомления одного или нескольких людей в команде о том, что определенное действие было (успешно) выполнено.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
attach
список
Значение по умолчанию:
[]
Список путей к файлам, которые необходимо прикрепить к сообщению.
Прикрепленным файлам будет назначен тип содержимого application/octet-stream.
bcc
список
Адрес(ы) электронной почты, получателям которых отправляется письмо в «слепом» копии.
Это список, который может содержать адреса и фразы.
body
строка
Значение по умолчанию:
"$subject"
Тело отправляемого электронного письма.
cc
список
Адрес(ы) электронной почты, получателям которых отправляется письмо в копии.
Это список, который может содержать адреса и фразы.
charset
строка
Значение по умолчанию:
"utf-8"
Кодировка символов отправляемого электронного письма.
from
строка
Значение по умолчанию:
"root"
Адрес электронной почты отправителя. Может содержать адрес и фразу.
headers
список
Значение по умолчанию:
[]
Список заголовков, которые нужно добавить к сообщению.
Каждый отдельный заголовок указывается как header=value (см. пример ниже).
host
строка
Значение по умолчанию:
"localhost"
Сервер электронной почты.
password
строка
Если SMTP требует пароль.
port
целое число
Значение по умолчанию:
25
Порт сервера электронной почты.
Должно быть целое число от 1 до 65534
secure
строка
    Варианты:
  • always
  • never
  • starttls
  • try ←
Если always, соединение будет отправлять электронную почту только при шифрованном соединении. Если сервер не поддерживает шифрованное соединение, произойдет ошибка.
Если try, соединение попытается установить защищенную сессию SSL/TLS перед отправкой.
Если never, соединение не попытается установить защищенную сессию SSL/TLS перед отправкой.
Если starttls, соединение попытается перейти к защищенному соединению SSL/TLS перед отправкой. Если это не удастся, произойдет ошибка.
subject
строка / обязательно
Тема отправляемого электронного письма.
subtype
строка
    Варианты:
  • html
  • plain ←
Дополнительный тип MIME, может быть plain или html.
Основной тип всегда text.
timeout
целое число
Значение по умолчанию:
20
Устанавливает таймаут в секундах для попыток подключения.
to
список
Значение по умолчанию:
"root"
Адрес(ы) электронной почты получателя(ей).
Это список, который может содержать адреса и фразы.

псевдонимы: получатели
username
строка
Если SMTP требует имя пользователя.

Примеры

- 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

Статус

  • Данный модуль гарантирует обратную совместимость при будущих изменениях интерфейса. [stableinterface]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/mail_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API