sendgrid - Отправка электронного письма с помощью API SendGrid
Новое в версии 2.0.
Обзор
- Отправляет электронное письмо с учетной записи SendGrid через их API, а не через SMTP-сервис.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- sendgrid python library
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key (добавлено в 2.2) | Значение по умолчанию: None | ключ API SendGrid для использования вместо имени пользователя/пароля |
| attachments (добавлено в 2.2) | Значение по умолчанию: None | список относительных или полных путей к файлам, которые нужно прикрепить (ограничение 7 МБ, согласно документации SendGrid) |
| bcc (добавлено в 2.2) | Значение по умолчанию: None | список адресов электронной почты для рассылки в скрытом списке адресатов |
| cc (добавлено в 2.2) | Значение по умолчанию: None | список адресов электронной почты для рассылки по списку копий |
| from_address обязательно | адрес в поле "от" для электронного письма | |
| from_name (добавлено в 2.2) | Значение по умолчанию: None | имя, которое должно отображаться в поле "от", например, "Иван Иванов" |
| headers (добавлено в 2.2) | Значение по умолчанию: None | словарь для передачи в качестве заголовков |
| html_body (добавлено в 2.2) | Значение по умолчанию: no | указывает, является ли тело содержимым HTML, которое должно быть отображено |
| password | Значение по умолчанию: None | пароль, соответствующий имени пользователя С версии 2.2 требуется только в том случае, если api_key не указан. |
| subject обязательно | желаемый предмет электронного письма | |
| to_addresses обязательно | список из одного или нескольких адресов электронной почты получателей | |
| username | Значение по умолчанию: None | имя пользователя для входа в учетную запись SendGrid. С версии 2.2 требуется только в том случае, если api_key не указан. |
Примечания
Примечание
- Этот модуль не идемпотентный, поскольку он отправляет электронное письмо через внешний API. Он идемпотентен только в случае ошибки модуля.
- Как и другие модули уведомлений, этот модуль требует внешней зависимости для работы. В этом случае вам понадобится активная учетная запись SendGrid.
- Для использования api_key, cc, bcc, attachments, from_name, html_body, headers необходимо установить sendgrid с помощью pip
- С версии 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
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Мэтт Макай (@makaimc)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/sendgrid_module.html
