Метод SendEmail
Отправляет электронное письмо с адреса в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Альтернативный способ отправки почты — с помощью протокола SMTP.
Запрос
POST /v2/email/outbound-emails HTTP/2
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"FromEmailAddress": "<адрес_отправителя>",
"FromEmailAddressIdentityArn": "<параметр_для_совместимости>",
"Destination": {
"ToAddresses": [
"<адрес_получателя>"
],
"CcAddresses": [
"<адрес_получателя_копии>"
],
"BccAddresses": [
"<адрес_получателя_скрытой_копии>"
]
},
"Content": {
"Simple": {
"Subject": {
"Data": "<текст_темы>",
"Charset": "<кодировка>"
},
"Body": {
"Text": {
"Data": "<текст_письма>",
"Charset": "<кодировка>"
},
"Html": {
"Data": "<текст_письма>",
"Charset": "<кодировка>"
}
}
},
"Raw": {
"Data": "<все_содержимое_письма>"
}
}
}
Параметр |
Описание |
|
Тип: string. Адрес, с которого отправляется письмо. Он должен быть верифицирован. |
|
Тип: string. Используется только для совместимости с AWS. |
|
Тип: object. Объект, который содержит параметры, описывающие письмо. |
|
Тип: object. Простой тип. Нельзя использовать вместе с |
|
Тип: object. Описывает тему:
|
|
Тип: object. Описывает содержимое:
|
|
Тип: object. Необработанный тип. Нельзя использовать вместе с
Письмо целиком размещается в параметре |
Ответы
200 OK
{
"MessageId": "<идентификатор_письма>"
}
Параметр |
Описание |
|
Тип: string. Уникальный идентификатор письма. |
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException
.
Возможные ошибки:
Код ошибки |
Описание |
|
В запросе неправильно указаны заголовки или параметры. |
|
Для этого сервисного аккаунта возможность отправлять почту ограничена навсегда. |
|
Для этого сервисного аккаунта возможность отправлять почту временно ограничена. |
|
Письмо содержит некорректные данные. |
|
Адрес, с которого отправляется письмо, не верифицирован. |
|
Запрошенный ресурс не найден. |
|
При вызове запроса превышена квота. |
|
При вызове запроса превышен лимит. |