Метод SendEmail
Отправляет электронное письмо с адреса в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Альтернативный способ отправки почты — с помощью протокола SMTP.
Запрос
POST /v2/email/outbound-emails HTTP/2
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"ConfigurationSetName": "string",
"FromEmailAddress": "<адрес_отправителя>",
"FromEmailAddressIdentityArn": "<параметр_для_совместимости>",
"Destination": {
"ToAddresses": [
"<адрес_получателя>"
],
"CcAddresses": [
"<адрес_получателя_копии>"
],
"BccAddresses": [
"<адрес_получателя_скрытой_копии>"
]
},
"Content": {
"Simple": {
"Subject": {
"Data": "<текст_темы>",
"Charset": "<кодировка>"
},
"Headers": [
{
"Name": "<заголовок>",
"Value": "<значение>"
}
],
"Body": {
"Text": {
"Data": "<текст_письма>",
"Charset": "<кодировка>"
},
"Html": {
"Data": "<текст_письма>",
"Charset": "<кодировка>"
}
},
"Attachments": [
{
"FileName": "<имя_файла>",
"RawContent": "<содержимое_в_Base64>",
"ContentType": "<MIME-тип>",
"ContentDescription": "<описание_вложения>",
"ContentDisposition": "<способ_отображения>",
"ContentId": "<идентификатор_вложения>",
"ContentTransferEncoding": "base64"
}
]
},
"Template": {
"Headers": [
{
"Name": "<заголовок>",
"Value": "<значение>"
}
],
"TemplateContent": {
"Html": "<шаблон_HTML>",
"Subject": "<шаблон_темы>",
"Text": "<шаблон_текста>"
},
"TemplateData": "<данные_для_подстановки_в_шаблоны>",
"Attachments": [
{
"FileName": "<имя_файла>",
"RawContent": "<содержимое_в_Base64>",
"ContentType": "<MIME-тип>",
"ContentDescription": "<описание_вложения>",
"ContentDisposition": "<способ_отображения>",
"ContentId": "<идентификатор_вложения>",
"ContentTransferEncoding": "base64"
}
]
},
"Raw": {
"Data": "<все_содержимое_письма>"
}
},
"ListManagementOptions": {
"ContactListName": "<имя_списка_контактов>",
"TopicName": "<имя_темы>"
}
}
|
Параметр |
Описание |
|
|
Тип: string. Имя конфигурации, которая используется для отправки письма. Если не указано, используется конфигурация, привязанная к адресу Yandex Cloud Postbox. |
|
|
Тип: string. Адрес, с которого отправляется письмо. Он должен быть верифицирован. |
|
|
Тип: string. Параметр не используется. Предназначен для совместимости с AWS. |
|
|
Тип: object. Объект, который содержит адреса для доставки письма.
|
|
|
Тип: object. Параметры для управления механизмом отписки от рассылок.
|
|
|
Тип: object. Простой тип. Нельзя использовать вместе с |
|
|
Тип: object. Описывает тему:
|
|
|
Тип: array.
|
|
|
Тип: object. Описывает содержимое:
|
|
|
Тип: array. Список вложений в письме. Доступен в содержимом типов
Подробнее об ограничениях на вложения в разделе Ограничения на вложения в письмах. |
|
|
Тип: object. Шаблонный тип. Нельзя использовать вместе с |
|
|
Тип: object. Содержит шаблон письма:
|
|
|
Тип: string. Данные, которые используются для заполнения шаблона. JSON-объект, сериализованный в строку. |
|
|
Тип: object. Необработанный тип. Нельзя использовать вместе с
Письмо целиком размещается в параметре |
Ответы
200 OK
{
"MessageId": "<идентификатор_письма>"
}
|
Параметр |
Описание |
|
|
Тип: string. Уникальный идентификатор письма. |
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе неправильно указаны заголовки или параметры. |
|
|
Отправитель не входит в список разрешенных отправителей, которые указаны в настройках адреса. |
|
|
Возможность отправлять почту для сервисного аккаунта, от имени которого выполняется запрос, навсегда ограничена. |
|
|
Возможность отправлять почту для сервисного аккаунта, от имени которого выполняется запрос, временно ограничена. |
|
|
Письмо содержит некорректные данные. |
|
|
Адрес, с которого отправляется письмо, не верифицирован. |
|
|
Запрошенный ресурс не найден. |
|
|
При вызове запроса превышена квота. |
|
|
При вызове запроса превышен лимит. |