sendgrid - Отправка электронного письма с помощью API SendGrid
Новая версия 2.0.
Описание
- Отправка электронного письма с учетной записью SendGrid через их API, а не через SMTP-сервис.
Требования (для хоста, на котором выполняется модуль)
- sendgrid библиотека Python
Параметры
| параметр | обязательно | значение по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| api_key (добавлен в 2.2)
| нет | ключ API SendGrid для использования вместо имени пользователя/пароля | ||
| attachments (добавлен в 2.2)
| нет | список относительных или полных путей к файлам, которые нужно добавить (ограничение 7 МБ согласно документации SendGrid) | ||
| bcc (добавлен в 2.2)
| нет | список адресов электронной почты для рассылки в скрытой копии | ||
| cc (добавлен в 2.2)
| нет | список адресов электронной почты для рассылки в копии | ||
| from_address | да | адрес в поле "от" для электронного письма | ||
| from_name (добавлен в 2.2)
| нет | имя, которое должно отображаться в поле "от", например 'Иван Иванов' | ||
| headers (добавлен в 2.2)
| нет | словарь для передачи в виде заголовков | ||
| html_body (добавлен в 2.2)
| нет | указывает, является ли тело содержимым HTML, которое нужно отобразить | ||
| password | нет | пароль, соответствующий имени пользователя Начиная с 2.2, он требуется только в том случае, если api_key не указан. | ||
| subject | да | желаемый предмет электронного письма | ||
| to_addresses | да | список с одним или несколькими адресами электронной почты получателей | ||
| username | нет | имя пользователя для входа в учетную запись SendGrid. Начиная с 2.2, он требуется только в том случае, если api_key не указан. |
Примеры
# send an email to a single recipient that the deployment was successful
- sendgrid:
username: "{{ sendgrid_username }}"
password: "{{ sendgrid_password }}"
from_address: "ansible@mycompany.com"
to_addresses:
- "ops@mycompany.com"
subject: "Deployment success."
body: "The most recent Ansible deployment was successful."
delegate_to: localhost
# send an email to more than one recipient that the build failed
- sendgrid:
username: "{{ sendgrid_username }}"
password: "{{ sendgrid_password }}"
from_address: "build@mycompany.com"
to_addresses:
- "ops@mycompany.com"
- "devteam@mycompany.com"
subject: "Build failure!."
body: "Unable to pull source repository from Git server."
delegate_to: localhost
Примечания
Примечание
- Этот модуль не идемпотентный, так как он отправляет электронное письмо через внешний API. Он идемпотентен только в том случае, если модуль завершается ошибкой.
- Как и другие модули уведомлений, этот требует внешней зависимости для работы. В данном случае вам понадобится активная учетная запись SendGrid.
- Для использования api_key, cc, bcc, attachments, from_name, html_body, headers необходимо установить sendgrid с помощью pip.
- Начиная с версии 2.2, имя пользователя и пароль не требуются, если вы укажете api_key.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Для получения помощи в разработке модулей, если вам это нужно, пожалуйста, ознакомьтесь с Справочной информацией по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/sendgrid_module.html
