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 boolean Добавлен в 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. [сообщество]

Авторы

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.8/modules/sendgrid_module.html