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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

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

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

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

Требования

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

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

Параметры

Параметр	Комментарии
api_key строка	Ключ API Sendgrid для использования вместо имени пользователя/пароля.
attachments список / elements=path	Список относительных или явных путей к файлам, которые вы хотите прикрепить (ограничение 7 МБ согласно документации SendGrid).
bcc список / elements=string	Список адресов электронной почты для скрытой копии.
body строка / обязательно	Текст тела электронного письма.
cc список / elements=string	Список адресов электронной почты для копии.
from_address строка / обязательно	Адрес в поле «от» для электронного письма.
from_name строка	Имя, которое должно отображаться в поле «от», например, «Иван Иванов».
headers словарь	Словарь для передачи в качестве заголовков.
html_body логическое	Является ли тело HTML-контентом, который должен быть обработан. Варианты: `false` ← (по умолчанию) `true`
password строка	Пароль, соответствующий имени пользователя. Требуется только, если `api_key` не указан.
subject строка / обязательно	Требуемый заголовок для электронного письма.
to_addresses список / elements=string / обязательно	Список одного или нескольких адресов электронной почты получателей.
username строка	Имя пользователя для входа в учетную запись SendGrid. Требуется только, если `api_key` не указан.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения цели.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, должно быть изменено в режиме `check_mode`), когда находится в режиме diff.

Примечания

Примечание

Этот модуль не является идемпотентным, поскольку он отправляет электронное письмо через внешний API. Он идемпотентен только в том случае, если модуль завершается с ошибкой.
Как и другие модули уведомлений, этот требует внешней зависимости для работы. В данном случае вам потребуется активная учетная запись SendGrid.
Для использования api_key, cc, bcc, attachments, from_name, html_body, headers необходимо установить sendgrid с помощью pip

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/sendgrid_module.html