Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

отправка-письма

Описание

Отправляет электронное письмо. С помощью API Amazon SES v2 можно отправлять следующие типы сообщений:

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

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

Синтаксис

  send-email
[--from-email-address <value>]
[--from-email-address-identity-arn <value>]
[--destination <value>]
[--reply-to-addresses <value>]
[--feedback-forwarding-email-address <value>]
[--feedback-forwarding-email-address-identity-arn <value>]
--content <value>
[--email-tags <value>]
[--configuration-set-name <value>]
[--endpoint-id <value>]
[--list-management-options <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 (строка)

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

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

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

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

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

Для необработанных писем значение FromEmailAddressIdentityArn переопределяет заголовки X-SES-SOURCE-ARN и X-SES-FROM-ARN, указанные в содержимом сообщения необработанного письма.

--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 (строка)

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

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

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

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

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

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

Объект, содержащий тело сообщения. Вы можете отправить простое сообщение, сообщение в формате Raw или шаблонизированное сообщение.

Простое -> (структура)

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

Тема -> (структура)

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

Данные -> (строка)

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

Кодировка -> (строка)

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

Тело -> (структура)

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

Текст -> (структура)

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

Данные -> (строка)

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

Кодировка -> (строка)

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

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

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

Данные -> (строка)

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

Кодировка -> (строка)

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

Заголовки -> (список)

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

(структура)

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

Имя -> (строка)

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

  • Может содержать любые печатаемые символы ASCII (33 - 126), кроме двоеточия (:).
  • Может содержать не более 126 символов.

Значение -> (строка)

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

  • Может содержать любые печатаемые символы ASCII.
  • Может содержать не более 870 символов.

Вложения -> (список)

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

(структура)

Содержит метаданные и содержимое вложения в сыром виде.

RawContent -> (бинарный файл)

Сырые данные вложения. Они должны быть закодированы в base64, если вы напрямую обращаетесь к Amazon SES через интерфейс HTTPS. Если вы обращаетесь к Amazon SES с помощью SDK Amazon Web Services, SDK позаботится о кодировании в base64 за вас.

ContentDisposition -> (строка)

Стандартное описание того, как вложение должно быть отображено в электронном письме. Поддерживаемые значения: ATTACHMENT или INLINE.

Имя файла -> (строка)

Имя файла вложения, которое будет отображаться в электронном письме. Amazon SES ограничивает определенные расширения файлов. Чтобы убедиться, что вложения принимаются, проверьте раздел Неподдерживаемые типы вложений в руководстве разработчика Amazon SES.

Описание содержимого -> (строка)

Краткое описание содержимого вложения.

Идентификатор содержимого -> (строка)

Уникальный идентификатор вложения, используемый для ссылки на вложения с расположением INLINE в HTML-содержимом.

Кодировка передачи содержимого -> (строка)

Указывает, как закодировано вложение. Поддерживаемые значения: BASE64 , QUOTED_PRINTABLE , SEVEN_BIT.

Тип содержимого -> (строка)

MIME-тип вложения.

Примечание

Пример: application/pdf , image/jpeg

Сырой -> (структура)

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

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

Данные -> (бинарный файл)

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

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

Шаблон -> (структура)

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

Имя шаблона -> (строка)

Имя шаблона. Вы будете ссылаться на это имя при отправке электронных писем с использованием операций SendTemplatedEmail или SendBulkTemplatedEmail.

TemplateArn -> (строка)

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

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

Содержимое шаблона.

Примечание

Amazon SES поддерживает только простые подстановки при отправке электронных писем с использованием операций SendEmail или SendBulkEmail и при предоставлении полного содержимого шаблона в запросе.

Тема -> (строка)

Заголовок электронного письма.

Текст -> (строка)

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

HTML -> (строка)

HTML-тело электронного письма.

TemplateData -> (строка)

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

Заголовки -> (список)

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

(структура)

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

Имя -> (строка)

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

  • Может содержать любые печатаемые символы ASCII (33 - 126), кроме двоеточия (:).
  • Может содержать не более 126 символов.

Значение -> (строка)

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

  • Может содержать любые печатаемые символы ASCII.
  • Может содержать не более 870 символов.

Вложения -> (список)

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

(структура)

Содержит метаданные и содержимое вложения в сыром виде.

RawContent -> (бинарный файл)

Сырые данные вложения. Они должны быть закодированы в base64, если вы напрямую обращаетесь к Amazon SES через интерфейс HTTPS. Если вы обращаетесь к Amazon SES с помощью SDK Amazon Web Services, SDK позаботится о кодировании в base64 за вас.

ContentDisposition -> (строка)

Стандартное описание того, как вложение должно быть отображено в электронном письме. Поддерживаемые значения: ATTACHMENT или INLINE.

Имя файла -> (строка)

Имя файла вложения, которое будет отображаться в электронном письме. Amazon SES ограничивает определенные расширения файлов. Чтобы убедиться, что вложения принимаются, проверьте раздел Неподдерживаемые типы вложений в руководстве разработчика Amazon SES.

Описание содержимого -> (строка)

Краткое описание содержимого вложения.

Идентификатор содержимого -> (строка)

Уникальный идентификатор вложения, используемый для ссылки на вложения с расположением INLINE в HTML-содержимом.

Кодировка передачи содержимого -> (строка)

Указывает, как закодировано вложение. Поддерживаемые значения: BASE64 , QUOTED_PRINTABLE , SEVEN_BIT.

Тип содержимого -> (строка)

MIME-тип вложения.

Примечание

Пример: application/pdf , image/jpeg

Синтаксис JSON:

{
  "Simple": {
    "Subject": {
      "Data": "string",
      "Charset": "string"
    },
    "Body": {
      "Text": {
        "Data": "string",
        "Charset": "string"
      },
      "Html": {
        "Data": "string",
        "Charset": "string"
      }
    },
    "Headers": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "Attachments": [
      {
        "RawContent": blob,
        "ContentDisposition": "ATTACHMENT"|"INLINE",
        "FileName": "string",
        "ContentDescription": "string",
        "ContentId": "string",
        "ContentTransferEncoding": "BASE64"|"QUOTED_PRINTABLE"|"SEVEN_BIT",
        "ContentType": "string"
      }
      ...
    ]
  },
  "Raw": {
    "Data": blob
  },
  "Template": {
    "TemplateName": "string",
    "TemplateArn": "string",
    "TemplateContent": {
      "Subject": "string",
      "Text": "string",
      "Html": "string"
    },
    "TemplateData": "string",
    "Headers": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "Attachments": [
      {
        "RawContent": blob,
        "ContentDisposition": "ATTACHMENT"|"INLINE",
        "FileName": "string",
        "ContentDescription": "string",
        "ContentId": "string",
        "ContentTransferEncoding": "BASE64"|"QUOTED_PRINTABLE"|"SEVEN_BIT",
        "ContentType": "string"
      }
      ...
    ]
  }
}

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

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

(структура)

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

Имя -> (строка)

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

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

Значение -> (строка)

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

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

Сокращенная синтаксическая форма:

Name=string,Value=string ...

Синтаксис JSON:

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

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

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

--endpoint-id (строка)

Идентификатор многорегионального конечного пункта (global-endpoint).

--list-management-options (структура)

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

Имя списка контактов -> (строка)

Имя списка контактов.

Имя темы -> (строка)

Имя темы.

Сокращенная синтаксическая форма:

ContactListName=string,TopicName=string

Синтаксис JSON:

{
  "ContactListName": "string",
  "TopicName": "string"
}

--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 (булево)

Включить отладочную запись журнала.

--endpoint-url (строка)

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

Включение/выключение цветного вывода.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (булево)

Отключить пагинатор cli для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

MessageId -> (строка)

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

Примечание

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

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

Spec-Zone.ru

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