Spec-Zone.ru › AWS CLI v2

[ aws . ses ]

send-templated-email

Описание

Составляет сообщение электронной почты, используя шаблон электронной почты, и незамедлительно помещает его в очередь отправки.

Чтобы отправить электронное письмо с помощью этой операции, ваш вызов должен соответствовать следующим требованиям:

  • Вызов должен ссылаться на существующий шаблон электронного письма. Вы можете создать шаблоны электронных писем с помощью операции CreateTemplate.
  • Сообщение должно отправляться с проверенного адреса или домена электронной почты.
  • Если ваш аккаунт всё ещё находится в песочнице Amazon SES, вы можете отправлять только проверенным адресам или доменам, или адресам электронной почты, связанным с Amazon SES Mailbox Simulator. Более подробную информацию см. в разделе «Проверка адресов и доменов электронной почты» в руководстве разработчика Amazon SES.
  • Максимальный размер сообщения — 10 МБ.
  • Вызовы операции SendTemplatedEmail могут содержать только один параметр Destination. Адресат — это набор получателей, которые получают одну и ту же версию электронного письма. Параметр Destination может содержать до 50 получателей по полям To:, CC: и BCC:.
  • Параметр Destination должен содержать по крайней мере один адрес электронной почты получателя. Адрес получателя может быть адресом To:, CC: или BCC:. Если адрес электронной почты получателя недействителен (то есть он не имеет формат ИмяПользователя@[СубДомен.]Домен.ДоменВерхнегоУровня ), всё сообщение отклоняется, даже если сообщение содержит других получателей, которые действительны.

Предупреждение

Если ваш вызов операции SendTemplatedEmail включает все необходимые параметры, Amazon SES принимает его и возвращает идентификатор сообщения. Однако, если Amazon SES не может отобразить электронное письмо из-за ошибок в шаблоне, оно не отправляет электронное письмо. Кроме того, поскольку оно уже приняло сообщение, Amazon SES не возвращает сообщение, указывающее, что оно не смогло отправить электронное письмо.

По этим причинам мы настоятельно рекомендуем настроить Amazon SES на отправку уведомлений при возникновении событий Rendering Failure. Более подробную информацию см. в разделе «Отправка персонализированных электронных писем с помощью API Amazon SES» в руководстве разработчика Amazon Simple Email Service.

См. также: Документация API AWS

Синтаксис

  send-templated-email
--source <value>
--destination <value>
[--reply-to-addresses <value>]
[--return-path <value>]
[--source-arn <value>]
[--return-path-arn <value>]
[--tags <value>]
[--configuration-set-name <value>]
--template <value>
[--template-arn <value>]
--template-data <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--source (строка)

Адрес электронной почты, отправляющий электронное письмо. Этот адрес электронной почты должен быть либо индивидуально проверен Amazon SES, либо принадлежать домену, который был проверен Amazon SES. Сведения о проверке идентификаторов см. в руководстве разработчика Amazon SES.

Если вы отправляете от имени другого пользователя и у вас есть разрешение на это в политике авторизации отправки, вам также необходимо указать параметр SourceArn. Более подробную информацию об авторизации отправки см. в руководстве разработчика Amazon SES.

Примечание

Amazon SES не поддерживает расширение SMTPUTF8, как описано в RFC6531 . По этой причине строка адреса электронной почты должна быть 7-битной ASCII. Если вы хотите отправлять или получать электронные письма, содержащие символы Юникода в доменной части адреса, вы должны закодировать домен с помощью Punycode. Punycode не допускается в локальной части адреса электронной почты (части перед знаком @) или в имени «дружественного отправителя». Если вы хотите использовать символы Юникода в имени «дружественного отправителя», вы должны закодировать имя «дружественного отправителя» с помощью синтаксиса MIME encoded-word, как описано в разделе Отправка необработанного электронного письма с помощью API Amazon SES. Более подробную информацию о Punycode см. в RFC 3492.

--destination (структура)

Получатель этого электронного письма, составленный из полей To:, CC: и BCC:. Адресат может содержать до 50 получателей по этим трём полям.

ToAddresses -> (список)

Получатели, которые должны быть помещены в строку To: сообщения.

(строка)

CcAddresses -> (список)

Получатели, которые должны быть помещены в строку CC: сообщения.

(строка)

BccAddresses -> (список)

Получатели, которые должны быть помещены в строку BCC: сообщения.

(строка)

Сокращенный синтаксис:

ToAddresses=string,string,CcAddresses=string,string,BccAddresses=string,string

Синтаксис JSON:

{
  "ToAddresses": ["string", ...],
  "CcAddresses": ["string", ...],
  "BccAddresses": ["string", ...]
}

--reply-to-addresses (список)

Адрес(ы) электронной почты ответного адреса для сообщения. Если получатель отвечает на сообщение, каждый ответный адрес получает ответ.

(строка)

Синтаксис:

"string" "string" ...

--return-path (строка)

Адрес электронной почты, на который будут перенаправляться возвраты и жалобы, когда включена переадресация обратной связи. Если сообщение не может быть доставлено получателю, от провайдера ISP получателя возвращается сообщение об ошибке; это сообщение пересылается на адрес электронной почты, указанный в параметре ReturnPath. Параметр ReturnPath никогда не перезаписывается. Этот адрес электронной почты должен быть либо индивидуально проверен Amazon SES, либо принадлежать домену, который был проверен Amazon SES.

--source-arn (строка)

Этот параметр используется только для авторизации отправки. Это ARN идентификатора, связанного с политикой авторизации отправки, которая разрешает вам отправлять от адреса электронной почты, указанного в параметре Source.

Например, если владелец example.com (у которого есть ARN arn:aws:ses:us-east-1:123456789012:identity/example.com ) прикрепляет к нему политику, разрешающую вам отправлять от user@example.com, то вы укажете SourceArn как arn:aws:ses:us-east-1:123456789012:identity/example.com, а Source как user@example.com.

Более подробную информацию об авторизации отправки см. в руководстве разработчика Amazon SES.

--return-path-arn (строка)

Этот параметр используется только для авторизации отправки. Это ARN идентификатора, связанного с политикой авторизации отправки, которая разрешает вам использовать адрес электронной почты, указанный в параметре ReturnPath.

Например, если владелец example.com (у которого есть ARN arn:aws:ses:us-east-1:123456789012:identity/example.com ) прикрепляет к нему политику, разрешающую вам использовать feedback@example.com, то вы укажете ReturnPathArn как arn:aws:ses:us-east-1:123456789012:identity/example.com, а ReturnPath как feedback@example.com.

Более подробную информацию об авторизации отправки см. в руководстве разработчика Amazon SES.

--tags (список)

Список тегов в формате пар «имя/значение», которые применяются к отправляемому вами электронному письму с помощью операции SendTemplatedEmail. Теги соответствуют характеристикам электронного письма, которые вы определяете, чтобы вы могли публиковать события отправки электронных писем.

(структура)

Содержит имя и значение тега, который вы можете предоставить операциям SendEmail или SendRawEmail, чтобы применить к электронному письму.

Теги сообщений, которые вы используете с наборами конфигураций, позволяют публиковать события отправки электронных писем. Сведения об использовании наборов конфигураций см. в руководстве разработчика Amazon SES.

Name -> (строка)

Имя тега. Имя должно соответствовать следующим требованиям:

  • Содержать только латинские буквы (a-z, A-Z), цифры (0-9), символы подчёркивания (_) или дефисы (-).
  • Содержать не более 256 символов.

Value -> (строка)

Значение тега. Значение должно соответствовать следующим требованиям:

  • Содержать только латинские буквы (a-z, A-Z), цифры (0-9), символы подчёркивания (_) или дефисы (-).
  • Содержать не более 256 символов.

Сокращенный синтаксис:

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--configuration-set-name (строка)

Имя набора конфигураций, используемого при отправке электронного письма с помощью операции SendTemplatedEmail.

--template (строка)

Шаблон, используемый при отправке этого электронного письма.

--template-arn (строка)

ARN шаблона, используемого при отправке этого электронного письма.

--template-data (строка)

Список значений замены, которые необходимо применить к шаблону. Этот параметр представляет собой JSON-объект, обычно состоящий из пар «ключ-значение», в которых ключи соответствуют тегам замены в шаблоне электронного письма.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это нельзя указывать вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, оно выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернёт JSON-выход для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладочный вывод.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использование определенного профиля из файла учетных данных.

--region (string)

Регион для использования. Переопределяет параметры конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить вывод в цвете.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет параметры конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка в кодировке base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного параметра cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

MessageId -> (string)

Уникальный идентификатор сообщения, возвращенный действием SendTemplatedEmail.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API