Отправка писем

Отправьте POST запрос на URL http://api.mailhandler.ru/message/send/. Тело запроса должно представлять собой JSON структуру.

Запрос может содержать следующие параметры:

Название Описание Обязателен Пример
type Тип. Возможные значения: TRANSACTIONAL (транзакционное письмо, значение по умолчанию), BULK (массовая рассылка). Нет TRANSACTIONAL
from Верифицированный адрес отправителя. Должен совпадать с одним из адресов отправителей в рамах конкретного проекта. См. раздел базы знаний “Настройка проекта”. Да ["bob@example.com", "alice@example.com"]
to Список адресов получателей. Да ["test@mailhandler.ru"]
subject Тема письма. Если вы передали параметр template_unique_id , в качестве темы письма будет использовано название созданного вами шаблона. Обязателен, если вы не передали параметр template_unique_id Hello world!
text_body Текстовая версия тела письма. Обязателен, если вы не передали параметры html_body и template_unique_id Test
html_body HTML версия тела письма. Обязателен, если вы не передали параметры template_unique_id и text_body <html><body>Test</body></html>
template_unique_id Уникальный идентификатор шаблона письма. Обязателен, если вы не передали параметры html_body и text_body 6916b912-0e42-414d-8471-29f6991a4252
reply_to Список Reply-To адресов. Нет ["bob@example.com", "alice@example.com"]
сс Список адресов для отправки копии письма. Нет ["bob@example.com", "alice@example.com"]
bсс Список адресов для отправки скрытой копии письма. Нет ["bob@example.com", "alice@example.com"]
headers Дополнительные заголовки письма. Нет {"Header-One": "HeaderOneValue", "Header-Two": "HeaderTwoValue"}
disable_inline Передайте true, если хотите отключить инлайлинг CSS в письме. Нет true
context Контекстные переменные письма (см. раздел "Контекстные переменные"). Нет {"username": "John Doe", "balance": "1000 RUB"}

Пример данных запроса:

{
    "type":"BULK",
    "from":"hello@mailhandler.ru",
    "to":["bob@example.com"],
    "subject":"Hello world!",
    "html_body":"Hello dear #username#. How are you? Please click on this link! <a href=\"http://mailhandler.ru\">Click click</a>. To unsubscribe from these emails, click here - <a href=\"#unsubscribe_url#\">unsubscribe</a>.",
    "reply_to":["test@example.com"],
    "cc":["alice@example.com"],
    "bcc":["john@example.com"],
    "tag":"Sample tag",
    "headers":{"Foo":"Bar"},
    "context":{"username":"Bob"},
    "disable_inline":true
}

Пример отправки письма с помощью curl:

curl 'http://api.mailhandler.ru/message/send/' \ 
-X POST \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
-d '{"from": "hello@example.com", "to": ["user@example.com"], "subject": "Hello world!", "html_body": "<html><body>Hello dear user.</body></html>"}'

Пример отправки письма на python:

import requests 

def send_email():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }     
    data = {         
        'from': 'hello@example.com',         
        'to': ['user@example.com'],         
        'subject': 'Hello world!',         
        'html_body': '<html><body>Hello dear user.</body></html>'     
    }     
    response = requests.post('http://api.mailhandler.ru/message/send/',                              
                  json=data, 
                  headers=headers)     
    return response.json()

В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK

{
    "messages":[
        {"to":"hello@mailhandler.ru","id":"4a85d923-e05b-455e-b036-c7af33bf6b92"}
    ],
    "result": true,
    "messages_created": 1
}

results matching ""

    No results matching ""