Sendemail - спрощена відправка індивідуальних email-повідомлень - працює на kayako https

Повідомлення, відправлені через sendEmail, що не піддаються цензурі людиною, тому за замовчуванням кількість дозволених до відправки листів через цей метод на добу обмежена 1000 для нових користувачів (пізніше при позитивних показниках статистики доставки ліміт автоматично буде вище), а максимальний розмір листа обмежений 1 мегабайтом.

Оскільки повідомлення і так можуть бути зроблені максимально індивідуальними, підстановка полів в них не здійснюється, за винятком значення>.

Ви можете дізнатися статус доставки відправленого повідомлення за допомогою методу checkEmail. Для прискорення роботи методу sendEmail статуси доставки зберігаються обмежений час - тільки місяць.

принцип використання

Синтаксис і URL для виклику методу

sendEmail (mixed email, mixed sender_name, mixed sender_email, mixed subject, mixed body, mixed list_id [, mixed user_campaign_id, mixed attachments, mixed lang, mixed track_read, mixed track_links, bool attach_multi, string cc, array | string headers, string wrap_type, string images_as, bool error_checking, mixed metadata])

Ключ доступу до API

Доступно використання підстановки ToName для відображення імені одержувача в поле "To" його поштового клієнта. Для цього значення параметра можна передати як:

Текст листа в форматі HTML. Призначені для користувача поля підстановки практично не підтримуються для прискорення обробки (передбачається, що лист і так складено індивідуально для одержувача) - гарантується тільки наявність>.

Текст може включати і відносні посилання на зображення, які знаходяться в папці користувача на нашому сервері - такі зображення будуть включені в сам лист. Посилання на зображення на сервері повинні мати вигляд: "/ ru / user_file? Resource = imagesname = IMAGE". де замість IMAGE має бути ім'я файлу з вашої папки на сервері, наприклад image.jpg або folder / image.jpg.

Якщо ж зображення не зберігається на нашому сервері, то ви можете вставити картинку, передавши її як файл-вкладення (див. Опис аргументу attachments).

Якщо кількість елементів user_campaign_id менше кількості елементів масиву email, user_campaign_id присвоюються відповідній кількості перших елементів масиву email, інші листи залишаються без user_campaign_id.

Використовуючи скрипт PHP, вміст файлу можна отримати через функцію file_get_contents. Наприклад: $ api_query = array (. "Attachments [test.pdf]" => file_get_contents ( 'test.pdf').);

Передбачається, що HTML-текст містить тільки вміст тега body. Якщо ви передаєте текст HTML цілком, то тестируйте такі листи додатково - заголовки поза body можуть бути піддані модифікаціям. Крім того, щоб зменшити розбіжність у відображенні в різних поштових програмах, ми автоматично додаємо додаткову розмітку в кожен лист (таблиця з невидимими кордонами, яка також задає шрифт за замовчуванням і вирівнювання тексту по лівій межі). Ви можете попросити відключити це для ваших листів, звернувшись в техпідтримку або задавши вручну значення за замовчуванням при збереженні будь-якого листа через веб-інтерфейс.

Двобуквений код мови для автоматично додається в кожен лист рядки з посиланням відписки.

Якщо не вказано, то використовується код мови з URL-звернення до API.

Крім власне рядки з посиланням відписки, ця мова також впливає на інтерфейс сторінки відписки. Повністю підтримуються мови ru. ua. it і en. для кількох інших мов (da, de, es, fr, nl, pl, pt, tr) буде переведена рядок з посиланням, а інтерфейс управління буде англійською.

Текст зі списком заголовків, кожен заголовок - на окремому рядку в MIME-форматі. Поки підтримуються тільки два заголовка, Reply-To і Priority, інші будуть проігноровані. приклад:

Приміщення HTML-тексту листа в додаткову "обгортку" з HTML-коду з метою поліпшення сумісності з різними поштовими сервісами і для вирівнювання тексту повідомлення по заданому краю. Якщо аргумент відсутній. то обгортання буде проводитися. Так само, параметр може мати значення: skip (не застосовувати), right (вирівнювання по правому краю), left (вирівнювання по лівому краю), center (вирівнювання по центру).

Дозволяє змінювати режим обробки вкладених зображень в листі. Може мати значення: attachments (поведінка за умовчанням, коли параметр не заданий) - картинки будуть зберігатися всередині листи як вкладення, only_links - посилаються в запиті зображення будуть зберігатися на нашому сервісі, в листі ж будуть відображатися тільки посилання на них (це дозволить зменшити вагу листи), user_default - буде використовуватися один з вищевказаних режимів, встановлених для конкретного користувача службою підтримки або реселлером. Рухаючись в запиті параметр має більший пріоритет перед встановленим для вас в профілі.

Параметр може передаватися користувачем для присвоєння листа ключа-ідентифікатора. Прийняте значення ключа повинно бути унікальним.

Метадані, що відправляються в запиті, повертаються в Webhooks.

meta1, meta2 - ключі (максимальна кількість ключів - 10, максимальна довжина ключа - 64 символу);
value1, value2 - значення ключів (максимальна довжина значення ключа - 1024 символів).

Приклад нового формату повертається: Результат повертається в такому форматі при виклику з error_checking = 1, або при використанні синтаксису масиву для аргументу email / при використанні аргументу cc. Значення, що повертається є JSON-масивом об'єктів (кількість елементів дорівнює кількості переданих email, з урахуванням cc) з наступними полями:

Унікальний код повідомлення - рядок до 64 символів.
Якщо через помилку відправка неможлива - поле id відсутня. Ще треба враховувати, що не всі помилки виявляються в момент прийому запиту на відправку. У цьому випадку повідомлення приймається в обробку і отримує id, а про помилку можна дізнатися пізніше, за допомогою методу checkEmail.

Список можливих кодів помилок:

Унікальний код повідомлення. Може використовуватися для контролю доставки методом checkEmail.

Приклад формування URL-запиту

Приклади на PHP

Приклад з використанням POST-запиту