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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.sendgrid.

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

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

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

Требования

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

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

Параметры

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

Атрибуты

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

Примечания

Примечание

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

Примеры

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