sendgrid - Отправка электронного письма с помощью API SendGrid
Новая версия с 2.0.
Обзор
- Отправляет электронное письмо с помощью учетной записи SendGrid через их API, а не через службу SMTP.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- библиотека sendgrid для Python
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key (добавлен в 2.2) | ключ API SendGrid для использования вместо имени пользователя/пароля | |
| attachments (добавлен в 2.2) | список относительных или полных путей к файлам, которые вы хотите прикрепить (предел 7 МБ, согласно документации SendGrid) | |
| bcc (добавлен в 2.2) | список адресов электронной почты для рассылки по слепому копированию (bcc) | |
| cc (добавлен в 2.2) | список адресов электронной почты для копии (cc) | |
| from_address обязательно | адрес в поле "от" для электронного письма | |
| from_name (добавлен в 2.2) | имя, которое вы хотите видеть в поле "от", например 'Иван Иванов' | |
| headers (добавлен в 2.2) | словарь для передачи в качестве заголовков | |
| html_body bool (добавлен в 2.2) |
| указывает, является ли тело содержимым 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. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. в разделе здесь.
Автор
- Мэтт Макай (@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.6/modules/sendgrid_module.html
