Spec-Zone.ru › AWS CLI v2

[ aws . ses ]

send-email

Описание

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

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

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

Для каждого отправленного сообщения общее количество получателей (включая каждого получателя в полях «Кому», «Копия» и «Скрытая копия») учитывается в отношении максимального количества писем, которые вы можете отправить в течение 24 часов (ваш лимит отправки). Дополнительную информацию о лимитах отправки в Amazon SES см. в разделе Управление лимитами отправки в Amazon SES в руководстве разработчика Amazon SES.

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

Синтаксис

  send-email
[--destination <value>]
[--message <value>]
[--reply-to-addresses <value>]
[--return-path <value>]
[--source-arn <value>]
[--return-path-arn <value>]
[--tags <value>]
[--configuration-set-name <value>]
--from<value>
[--to <value>]
[--cc <value>]
[--bcc <value>]
[--subject <value>]
[--text <value>]
[--html <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]

Параметры

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

Получатели этого электронного письма, составленные из полей «Кому», «Копия» и «Скрытая копия».

ToAddresses -> (список)

Получатели для поля «Кому» в сообщении.

(строка)

CcAddresses -> (список)

Получатели для поля «Копия» в сообщении.

(строка)

BccAddresses -> (список)

Получатели для поля «Скрытая копия» в сообщении.

(строка)

Сокращенная форма:

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

Синтаксис JSON:

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

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

Сообщение, которое нужно отправить.

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

Тема сообщения: краткое изложение содержимого, которое отображается в почтовом ящике получателя.

Data -> (строка)

Текстовые данные содержимого.

Charset -> (строка)

Кодировка символов содержимого.

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

Тело сообщения.

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

Содержимое сообщения в текстовом формате. Используйте для текстовых почтовых клиентов или клиентов с высокой задержкой (например, мобильных устройств).

Data -> (строка)

Текстовые данные содержимого.

Charset -> (строка)

Кодировка символов содержимого.

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

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

Data -> (строка)

Текстовые данные содержимого.

Charset -> (строка)

Кодировка символов содержимого.

Сокращенная форма:

Subject={Data=string,Charset=string},Body={Text={Data=string,Charset=string},Html={Data=string,Charset=string}}

Синтаксис JSON:

{
  "Subject": {
    "Data": "string",
    "Charset": "string"
  },
  "Body": {
    "Text": {
      "Data": "string",
      "Charset": "string"
    },
    "Html": {
      "Data": "string",
      "Charset": "string"
    }
  }
}

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

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

(строка)

Синтаксис:

"string" "string" ...

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

Адрес электронной почты, на который перенаправляются сообщения об ошибках и жалобы при включенном перенаправлении обратной связи. Если сообщение не может быть доставлено получателю, от интернет-провайдера получателя возвращается сообщение об ошибке; это сообщение перенаправляется на адрес электронной почты, указанный в параметре 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 (список)

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

(структура)

Содержит имя и значение тега, который вы можете предоставить 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 (строка)

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

--from (строка)

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

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

Примечание

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

--to (строка) Адреса электронной почты основных получателей. Вы можете указать несколько получателей, разделив их пробелами

--cc (строка) Адреса электронной почты получателей копии (Cc). Вы можете указать несколько получателей, разделив их пробелами

--bcc (строка) Адреса электронной почты получателей скрытой копии (Bcc). Вы можете указать несколько получателей, разделив их пробелами

--subject (строка) Тема сообщения

--text (строка) Необработанное текстовое тело сообщения

--html (строка) HTML-тело сообщения

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

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

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. Дополнительную информацию см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.

Отправка отформатированного электронного письма с помощью Amazon SES

В следующем примере используется команда send-email для отправки отформатированного электронного письма:

aws ses send-email --fromsender@example.com --destination file://destination.json --message file://message.json

Вывод:

{
   "MessageId": "EXAMPLEf3a5efcd1-51adec81-d2a4-4e3f-9fe2-5d85c1b23783-000000"
}

Получатель и сообщение представляют собой JSON-структуры данных, сохраненные в файлах .json в текущем каталоге. Эти файлы таковы:

destination.json:

{
  "ToAddresses":  ["recipient1@example.com", "recipient2@example.com"],
  "CcAddresses":  ["recipient3@example.com"],
  "BccAddresses": []
}

message.json:

{
   "Subject": {
       "Data": "Test email sent using the AWS CLI",
       "Charset": "UTF-8"
   },
   "Body": {
       "Text": {
           "Data": "This is the message body in text format.",
           "Charset": "UTF-8"
       },
       "Html": {
           "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>.",
           "Charset": "UTF-8"
       }
   }
}

Замените адреса электронной почты отправителя и получателя на нужные вам адреса. Обратите внимание, что адрес электронной почты отправителя должен быть проверен в Amazon SES. До тех пор, пока вам не предоставлен доступ к Amazon SES, вы также должны проверить адрес электронной почты каждого получателя, если получатель не является симулятором почтового ящика Amazon SES. Дополнительную информацию о проверке см. в разделе Проверка адресов электронной почты и доменов в Amazon SES в руководстве разработчика Amazon Simple Email Service.

Идентификатор сообщения в выводе указывает, что вызов send-email был успешным.

Если вы не получаете электронное письмо, проверьте папку «Спам».

Дополнительную информацию об отправке отформатированного электронного письма см. в разделе Отправка отформатированного электронного письма с использованием API Amazon SES в руководстве разработчика Amazon Simple Email Service.

Вывод

MessageId -> (строка)

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

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

Spec-Zone.ru

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