community.general.sendgrid – Отправка электронного письма с помощью API SendGrid

Примечание

Этот плагин входит в состав коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.sendgrid.

Описание
Требования
Параметры
Примечания
Примеры

Описание

Отправляет электронное письмо с учетной записью SendGrid через их API, а не через SMTP-сервис.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

библиотека sendgrid Python 1.6.22 или ниже (поддерживается API Sendgrid V2)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Ключ API SendGrid для использования вместо имени пользователя/пароля.
attachments список / элементы=строка		Список относительных или полных путей к файлам, которые необходимо прикрепить (предел 7 МБ, согласно документации SendGrid).
bcc список / элементы=строка		Список адресов электронной почты для скрытой рассылки.
body строка / обязательно		Содержание тела электронного письма.
cc список / элементы=строка		Список адресов электронной почты для копии.
from_address строка / обязательно		Адрес в поле "от" для электронного письма.
from_name строка		Имя, которое должно отображаться в поле "от", например 'Иван Иванов'.
headers словарь		Словарь для передачи в качестве заголовков.
html_body логическое значение	Варианты: нет ← да	Является ли тело содержимым 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, username и password не требуются, если вы предоставите api_key.

Примеры

- name: Send an email to a single recipient that the deployment was successful
  community.general.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

- name: Send an email to more than one recipient that the build failed
  community.general.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

Авторы

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.10/collections/community/general/sendgrid_module.html