Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

send-email

Описание

Отправляет электронное сообщение. Можно использовать API Amazon Pinpoint Email для отправки двух типов сообщений:

  • Простой – Стандартное электронное сообщение. При создании этого типа сообщения указывается отправитель, получатель и тело сообщения, и Amazon Pinpoint собирает сообщение за вас.
  • Необработанный – Необработанное сообщение электронной почты в формате MIME. При отправке этого типа электронного письма необходимо указать все заголовки сообщения, а также тело сообщения. Этот тип сообщения можно использовать для отправки сообщений с вложениями. Указываемое сообщение должно быть корректным сообщением MIME.

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

Синтаксис

  send-email
[--from-email-address <value>]
--destination <value>
[--reply-to-addresses <value>]
[--feedback-forwarding-email-address <value>]
--content <value>
[--email-tags <value>]
[--configuration-set-name <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]

Параметры

--from-email-address (строка)

Адрес электронной почты, который нужно использовать в качестве адреса «От» для электронного письма. Указанный адрес должен быть подтвержден.

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

Объект, содержащий получателей электронного сообщения.

ToAddresses -> (список)

Массив, содержащий адреса электронной почты получателей «Кому» для электронного письма.

(строка)

CcAddresses -> (список)

Массив, содержащий адреса электронной почты получателей «Копия» для электронного письма.

(строка)

BccAddresses -> (список)

Массив, содержащий адреса электронной почты получателей «Скрытая копия» для электронного письма.

(строка)

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

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

Синтаксис JSON:

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

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

Адреса электронной почты «Ответ» для сообщения. При ответе на сообщение каждый адрес «Ответ» получает ответ.

(строка)

Синтаксис:

"string" "string" ...

--feedback-forwarding-email-address (строка)

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

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

Объект, содержащий тело сообщения. Можно отправить простое сообщение или необработанное сообщение.

Simple -> (структура)

Простое электронное письмо. Сообщение состоит из темы и тела сообщения.

Subject -> (структура)

Заголовок электронного письма. Заголовок может содержать только символы ASCII 7-битной кодировки. Однако можно указать несимволы ASCII в заголовке, используя синтаксис закодированных слов, как описано в RFC 2047.

Data -> (строка)

Само содержание сообщения.

Charset -> (строка)

Набор символов для содержимого. Из-за ограничений протокола SMTP Amazon Pinpoint по умолчанию использует 7-битную кодировку ASCII. Если текст содержит символы, выходящие за рамки ASCII, необходимо указать набор символов. Например, можно указать UTF-8 , ISO-8859-1 или Shift_JIS .

Body -> (структура)

Тело сообщения. Можно указать HTML-версию сообщения, текстовую версию или обе.

Text -> (структура)

Объект, представляющий версию сообщения, отображаемую в клиентах электронной почты, не поддерживающих HTML, или клиентах, где получатель отключил рендеринг HTML.

Data -> (строка)

Само содержание сообщения.

Charset -> (строка)

Набор символов для содержимого. Из-за ограничений протокола SMTP Amazon Pinpoint по умолчанию использует 7-битную кодировку ASCII. Если текст содержит символы, выходящие за рамки ASCII, необходимо указать набор символов. Например, можно указать UTF-8 , ISO-8859-1 или Shift_JIS .

Html -> (структура)

Объект, представляющий версию сообщения, отображаемую в клиентах электронной почты, поддерживающих HTML. HTML-сообщения могут включать форматированный текст, гиперссылки, изображения и многое другое.

Data -> (строка)

Само содержание сообщения.

Charset -> (строка)

Набор символов для содержимого. Из-за ограничений протокола SMTP Amazon Pinpoint по умолчанию использует 7-битную кодировку ASCII. Если текст содержит символы, выходящие за рамки ASCII, необходимо указать набор символов. Например, можно указать UTF-8 , ISO-8859-1 или Shift_JIS .

Raw -> (структура)

Необработанное сообщение электронной почты. Сообщение должно соответствовать следующим критериям:

  • Сообщение должно содержать заголовок и тело, разделенные одной пустой строкой.
  • Все необходимые поля заголовка должны присутствовать в сообщении.
  • Каждая часть сообщения MIME должна быть отформатирована должным образом.
  • Если включены вложения, они должны быть в поддерживаемом Amazon Pinpoint формате файла.
  • Все сообщение должно быть закодировано в Base64.
  • Если какие-либо части MIME в сообщении содержат содержимое, выходящее за пределы 7-битного набора символов ASCII, нужно закодировать это содержимое для корректного рендеринга сообщения клиентами электронной почты получателей.
  • Длина любой отдельной строки текста в сообщении не может превышать 1000 символов. Это ограничение определено в RFC 5321.

Data -> (двоичные данные)

Необработанное сообщение электронной почты. Сообщение должно соответствовать следующим критериям:

  • Сообщение должно содержать заголовок и тело, разделенные одной пустой строкой.
  • Все необходимые поля заголовка должны присутствовать в сообщении.
  • Каждая часть сообщения MIME должна быть отформатирована должным образом.
  • Вложения должны быть в формате файла, поддерживаемом Amazon Pinpoint.
  • Все сообщение должно быть закодировано в Base64.
  • Если какие-либо части MIME в сообщении содержат содержимое, выходящее за пределы 7-битного набора символов ASCII, нужно закодировать это содержимое для корректного рендеринга сообщения клиентами электронной почты получателей.
  • Длина любой отдельной строки текста в сообщении не может превышать 1000 символов. Это ограничение определено в RFC 5321.

Template -> (структура)

Шаблон для использования в электронном письме.

TemplateArn -> (строка)

Amazon Resource Name (ARN) шаблона.

TemplateData -> (строка)

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

Синтаксис JSON:

{
  "Simple": {
    "Subject": {
      "Data": "string",
      "Charset": "string"
    },
    "Body": {
      "Text": {
        "Data": "string",
        "Charset": "string"
      },
      "Html": {
        "Data": "string",
        "Charset": "string"
      }
    }
  },
  "Raw": {
    "Data": blob
  },
  "Template": {
    "TemplateArn": "string",
    "TemplateData": "string"
  }
}

--email-tags (список)

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

(структура)

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

Name -> (строка)

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

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

Value -> (строка)

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

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

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

Name=string,Value=string ...

Синтаксис JSON:

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

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

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

--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)

Уникальный идентификатор сообщения, сгенерированный Amazon Pinpoint при приеме сообщения.

Примечание

Возможна ситуация, когда Amazon Pinpoint принимает сообщение, но не отправляет его. Это может произойти, например, если отправляемое сообщение имеет вложение, которое не прошло проверку на вирусы, или если вы отправляете шаблонное электронное письмо с недопустимым содержанием персонализации.

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

Spec-Zone.ru

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