Sam Optravil

Python библиотека для сервиса Sam Optravil.

Официальный сайт

Подробная документация REST API

Библиотека является оберткой для API методов

Установка

pip install samotpravil

Начало работы

from samotpravil import SamotpravilClient

# Инициализация
service = SamotpravilClient('*****************')

Запросите доступы, заполнив форму.

Методы

Отправить письмо. Описание в API документации

service.send_email(email_to='email@example.com',
                   subject='Hello from library',
                   message_text='Hello world',
                   email_from='info@samotpravil.ru')

Обязательные поля

• email_to - имейл получателя (str)
• subject - тема письма (str)
• message_text - текст письма с поддержкой HTML (str)
• email_from - имейл отправителя (str)

Необязательные поля

• params - массив собственных переменных (dict)
• x_track_id - ваш уникальный ID отправки (str)
• track_open - отслеживать открытия (bool)
• track_click - отслеживать клики (bool)
• track_domain - домен трекинга (str)
• check_stop_list - проверять по глобальному стоп-листу (bool)
• check_local_stop_list - проверять по клиентскому стоп-листу (bool)
• domain_for_dkim - домен для DKIM
• headers - свои заголовки (dict)

---

Получить статус доставки. Описание в API документации

service.get_status(message_id='1qBv3w-0007Ls-CS11')

Обязательные поля

• message_id - уникальный ID отправки системы (str)

или

• x_track_id - ваш ID отправки системы (str)

---

Получить статистику. Описание в API документации

service.get_statistics(date_from='2024-10-01',
                       date_to='2024-10-31')

Обязательные поля

• date_from - дата в формате YYYY-MM-DD (str)
• date_to - дата в формате YYYY-MM-DD (str)

Необязательные поля

• limit - лимит объектов в ответе, дефолт - 100 (int)
• cursor_next - пагинация (int)

---

Получить отчет о недоставках за период. Описание в API документации

service.get_non_delivery_by_date(date_from='2024-10-01',
                                 date_to='2024-10-31')

Обязательные поля

• date_from - дата в формате YYYY-MM-DD (str)
• date_to - дата в формате YYYY-MM-DD (str)

Необязательные поля

• limit - лимит объектов в ответе, дефолт - 100 (int)
• cursor_next - пагинация (int)

---

Получить отчет о недоставках по номеру выпуска. Описание в API документации

service.get_non_delivery_by_issue(issuen=12345)

Обязательные поля

• issuen - ID выпуска (int)

---

Получить отчет о жалобах за период. Описание в API документации

service.get_fbl_report_by_date(date_from='2024-10-01',
                               date_to='2024-10-31')

Обязательные поля

• date_from - дата в формате YYYY-MM-DD (str)
• date_to - дата в формате YYYY-MM-DD (str)

Необязательные поля

• limit - лимит объектов в ответе, дефолт - 100 (int)
• cursor_next - пагинация (int)

---

Получить отчет о жалобах по номеру выпуска. Описание в API документации

service.get_fbl_report_by_issue(issuen=12345)

Обязательные поля

• issuen - ID выпуска (int)

---

Искать имейл в стоп-листе. Описание в API документации

service.stop_list_search(email='example@mail.com')

Обязательные поля

• email - имейл, который нужно найти (str)

---

Добавить имейл в стоп-лист. Описание в API документации

service.stop_list_add(email='example@mail.com',
                      domain='samotpravil.ru')

Обязательные поля

• email - имейл, который нужно добавить (str)
• domain - домен, для которого нужно добавить в стоп-лист (str)

---

Удалить имейл из стоп-листа. Описание в API документации

service.stop_list_remove(email='example@mail.com',
                         domain='samotpravil.ru')

Обязательные поля

• email - имейл, который нужно удалить (str)
• domain - домен, для которого нужно удалить имейл из стоп-листа (str)

---

Получить список разрешенных доменов. Описание в API документации

service.get_domains()

---

Добавить домен в разрешенные. Описание в API документации

service.domain_add(domain='samotpravil.ru')

Обязательные поля

• domain - домен, который нужно добавить (str)

---

Удалить домен из разрешенных. Описание в API документации

service.domain_remove(domain='samotpravil.ru')

Обязательные поля

• domain - домен, который нужно удалить (str)

---

Проверить верификацию домена. Описание в API документации

service.domain_check_verification(domain='samotpravil.ru')

Обязательные поля

• domain - домен, который нужно проверить (str)

---

Массовая отправка писем. Описание в API документации

users = [
    {'emailto': 'user1@example.com'},
    {'emailto': 'user2@example.com', 'field1': 'Custom Value'}
]

service.send_package(email_from='info@samotpravil.ru',
                     name_from='Samotpravil',
                     subject='Newsletter',
                     message_text='<h1>Hello</h1><p>Newsletter content</p>',
                     users=users)

Обязательные поля

• email_from - имейл отправителя (str)
• name_from - имя отправителя (str)
• subject - тема письма (str)
• message_text - текст письма с поддержкой HTML (str)
• users - список получателей, каждый элемент - словарь с ключом emailto и опциональными полями для персонализации (list)

Необязательные поля

• message_text_amp - текст письма в формате AMP (str)
• check_local_stop_list - проверять по локальному стоп-листу (bool)
• check_global_stop_list - проверять по глобальному стоп-листу (bool)
• track_open - отслеживать открытия (bool)
• track_click - отслеживать клики (bool)
• track_domain - домен трекинга (str)
• headers - свои заголовки (dict)
• is_moderate - флаг для модерации письма (bool)
• html_prettify - автоматическое форматирование HTML письма (bool)