Метод для создания e-mail сообщения без отправки. Непосредственно отправка осуществляется с помощью другого метода — createCampaign.
Обратите внимание, что максимальный размер e-mail сообщения - 8мб.
Принцип использования
| Синтаксис и URL для вызова метода |
| createEmailMessage (string sender_name, string sender_email, string subject, string body, int list_id [, string tag, string array attachments, string lang, string wrap_type, string text_body, bool generate_text, string categories]) |
| https://api.unisender.com/ru/api/createEmailMessage?format=json&api_key=KEY&sender_name=FROMNAME&sender_email= FROMMAIL&subject=SUBJECT&body=HTMLBODY &list_id=X&tag= TAG&attachements=FILESARRAY&lang=LANG&wrap_type=STRING&text_body= TEXTBODY&generate_text=GENERATETEXT &categories=CATEGORIES |
| Аргументы | |
| api_key * | Ключ доступа к API. |
| sender_name * | Имя отправителя. Произвольная строка, не совпадающая с e-mail адресом (аргумент sender_email). |
| sender_email * | E-mail адрес отправителя. Этот e-mail должен быть проверен (для этого надо создать вручную хотя бы одно письмо с этим обратным адресом через веб-интерфейс, затем нажать на ссылку «отправьте запрос подтверждения» и перейти по ссылке из письма). |
| subject * | Строка с темой письма. Может включать поля подстановки. Параметр не обязателен, если указывается template_id |
| body * | Текст письма в формате HTML с возможностью добавлять поля подстановки. Вы можете вставить изображение, передав его как файл-вложение (см. описание аргумента attachments). Если вы передаёте текст HTML целиком, то тестируйте такие письма дополнительно – заголовки вне body могут быть подвергнуты модификациям. Параметр не обязателен, если указывается template_id или system_template_id |
| list_id * | Код списка, по которому будет произведена отправка e-mail рассылки. Коды всех списков можно получить с помощью вызова getLists. Отправка письма возможна только по одному списку. Для отправки по другому списку надо создавать новое письмо. |
| text_body | Текстовый вариант письма. По умолчанию отсутствует. Если вы не предоставляете текстовый вариант наряду с HTML-вариантом, рекомендуем установить параметер generate_text в 1 для автоматической генерации текстовой части письма. |
| generate_text | 0 или 1, по умолчанию 0. Значение 1 означает, что генерация текстовой части письма будет выполнена автоматически по HTML-части. Если вы не предоставляете текстовый вариант наряду с HTML-вариантом, рекомендуем установить параметер generate_text в 1 для автоматической генерации текстовой части письма. В случае, если с помощью параметра text_body предоставляется текстовый вариант письма, то параметр generate_text игнорируется. При этом, если значение generate_text было установлено в 1, отклик сервера будет содержать предупреждение (warning). |
| tag | Метка. Если задана, то отправка рассылки письма будет производиться не по всему списку, а только по тем адресатам, которым присвоена заданная метка. |
| attachments | Ассоциативный массив файлов-вложений. В качестве ключа указывается имя файла, в качестве значения - бинарное содержимое файла (base64 использовать нельзя!), например:
|
| lang | Двухбуквенный код языка для автоматически добавляемой в каждое письмо строки со ссылкой отписки. Если не указан, то используется код языка из URL-обращения к API. Кроме собственно строки со ссылкой отписки, этот язык также влияет на интрефейс страницы отписки. Полностью поддерживаются языки ru, it, ua и en, для нескольких других языков (da, de, es, fr, nl, pl, pt, tr) будет переведена строка со ссылкой, а интерфейс управления будет на английском. |
| template_id | id пользовательского шаблона письма, созданного ранее, на основе которого можно создать письмо. Значение можно получить с помощью getTemplates или listTemplates. Передав этот параметр, можно не заполнять обязательные параметры subject, body, а также text_body и lang. Эти значения будут подтянуты из соответствующих параметров шаблона, id которого был указан. Если любой из указанных параметров все же будет передан, то система проигнорирует подтянутый из параметров шаблона параметр и будет использован параметр, переданный явно в данном методе. |
| system_template_id | id системного шаблона письма, на основе которого можно создать письмо. Значение можно получить с помощью getTemplates или listTemplates. Передав этот параметр, можно не заполнять обязательные параметры subject, body, а также text_body и lang. Эти значения будут подтянуты из соответствующих параметров шаблона, id которого был указан. Если ни один из параметров template_id или system_template_id не указан, для создания письма не будут использованы шаблоны. |
| wrap_type | Выравнивание текста сообщения по заданному краю. Если аргумент отсутствует, то выравнивание производиться не будет. Может иметь значения: skip (не применять), right (выравнивание по правому краю), left (выравнивание по левому краю), center (выравнивание по центру). |
| Возвращаемое значение |
| JSON-объект с одним полем message_id, в котором содержится уникальный код сообщения – целое положительное 31-битное число. Используется для отправки сообщения методом createCampaign. Пример возвращаемого значения: {"result":{"message_id":357088}}
{"error":"unchecked sender email","code":"invalid_arg","result":""}
|
