sendgrid – Отправка электронного письма с помощью API SendGrid
Описание
- Отправляет электронное письмо с помощью учетной записи SendGrid через их API, а не через SMTP-сервис.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- sendgrid python библиотека
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key - |
Ключ API SendGrid для использования вместо имени пользователя/пароля |
|
| attachments - |
Список относительных или полных путей к файлам, которые нужно прикрепить (ограничение 7 МБ, см. документацию SendGrid) |
|
| bcc - |
Список адресов электронной почты для скрытой рассылки (bcc) |
|
| cc - |
Список адресов электронной почты для копии (cc) |
|
| from_address - / обязательно |
Адрес в поле "от" для электронного письма |
|
| from_name - |
Имя, которое должно отображаться в поле "от", например 'Иван Иванов' |
|
| headers - |
Словарь для передачи в качестве заголовков |
|
| html_body boolean |
|
Является ли тело содержимым HTML, которое должно быть отображено |
| password - |
Пароль, соответствующий имени пользователя
С версии 2.2 требуется только если не указан api_key. |
|
| subject - / обязательно |
Желаемый предмет электронного письма |
|
| to_addresses - / обязательно |
Список с одним или несколькими адресами электронной почты получателя |
|
| username - |
Имя пользователя для входа в учетную запись 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
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Matt Makai (@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.9/modules/sendgrid_module.html
