amp-htmlstring
Часть сообщения AMP. Следуйте рекомендациям Google при создании и отправке AMP-писем.
attachmentstring[]
Вложение файла. Можно отправлять несколько значений attachment. Важно: для отправки вложений нужно использовать кодировку multipart/form-data.
bccstring[]
То же, что и to, но для получателей скрытой копии. Поддерживает формат дружественного имени.
ccstring[]
Аналогично to, но для получателей копии. Поддерживает формат friendly name.
domain_namestringобязательный
Доменное имя, используемое для отправки сообщения.
fromstringобязательный
Адрес электронной почты в заголовке From. Может содержать понятное имя в формате "Friendly Name <email@domain.com>". Примечание: не обязательно, если отправка идёт с шаблоном, у которого уже задан заголовок From, но переопределит заголовок From шаблона, если указан.
htmlstring
Тело сообщения (HTML-версия)
h_X-My-Headerstring
Добавляет пользовательские заголовки к письму. Используйте префикс 'h:', за которым следуют имя и значение заголовка. Пример: 'h:X-Custom-Header=my-value'
inlinestring[]
Вложение с типом inline. Используется для отправки встроенных изображений (см. пример). Можно отправлять несколько значений inline.
o_archive-tostring
Отправляет копию успешно доставленных сообщений на указанный URL через HTTP POST. Запрос использует Content-Type: application/mime и содержит точное сообщение, которое получил SMTP-сервер получателя. ПРИМЕЧАНИЕ: Они учитываются и тарифицируются как доставленные сообщения.
o_deliver-withinstring
Задает максимальное окно времени для доставки сообщения. Принимает значения в формате [0-9]+h[0-9]+m (например, 1h30m, 30m, 24h), с минимумом 5m и максимумом 24h. Для отложенных сообщений окно доставки отсчитывается от запланированного времени. В пределах этого окна действует стандартный график повторных попыток, поэтому более короткие интервалы могут привести к меньшему числу попыток доставки.
o_deliverytimestring
Задает время запланированной доставки в формате RFC-2822. В зависимости от вашего тарифного плана вы можете планировать отправку сообщений на 3 или 7 дней вперед. Если для вашего домена задана пользовательская настройка message_ttl (time-to-live), это значение определяет максимальную длительность планирования. Пример: 'Fri, 14 Oct 2011 12:00:00 +0000'
o_deliverytime-optimize-periodstring
Включает оптимизацию времени отправки (STO) для каждого сообщения отдельно. Значение задаётся строкой в формате [0-9]+h — количество часов, минимум 24h, максимум 72h. Это значение определяет временное окно, в котором Mailgun будет подбирать оптимальный момент отправки на основе данных о вовлечённости конкретного получателя. Подробнее — в документации по отправке сообщений с STO. Обратите внимание: STO доступна только на определённых тарифных планах. Актуальные условия — на www.mailgun.com/pricing.
o_dkimenum
Включает или отключает подписи DKIM для каждого отдельного сообщения. Переопределяет настройку DKIM на уровне домена для этого конкретного сообщения.
o_require-tlsenum
Когда установлено значение 'yes', сообщение должно отправляться только через TLS-соединение с провайдером электронной почты. Если TLS не может быть установлен, сообщение не будет доставлено. Когда установлено значение 'no' (по умолчанию), Mailgun пытается использовать TLS, но переключается на обычный SMTP, если это необходимо.
o_secondary-dkimstring
Укажите второй ключ домена для подписи письма. Значение задаётся в формате signing_domain/selector, например example.com/s1. Это говорит Mailgun, что нужно подписать сообщение доменом example.com с помощью селектора s1. Обратите внимание: указанный ключ домена должен быть создан и активирован заранее.
o_secondary-dkim-publicstring
Укажите псевдоним ключа домена, указанный в o:secondary-dkim. Также форматируется как public_signing_domain/selector. Опция o:secondary-dkim также должна быть предоставлена. Mailgun подпишет сообщение предоставленным ключом вторичного DKIM, но будет использовать публичное имя и селектор вторичного DKIM. Примечание: Мы выполним проверку DNS перед подписыванием сообщения, чтобы убедиться, что публичные ключи соответствуют вторичному DKIM.
o_sending-ipstring
Используется для указания IP-адреса, с которого будет отправлено письмо, принадлежащее вашему аккаунту.
o_sending-ip-poolstring
Если указан IP Pool ID, письмо будет доставлено с IP-адресом, принадлежащим этому пулу.
o_skip-verificationenum
Если true, сертификат и имя хоста разрешённого MX-хоста не будут проверяться при установке TLS-соединения. Если false, Mailgun будет проверять сертификат и имя хоста. Если что-то из этого не может быть проверено, TLS-соединение не будет установлено. Значение по умолчанию — false
o_suppress-headersstring
Удаляет указанные заголовки X-Mailgun из доставленного сообщения. Укажите названия заголовков через запятую (например, 'X-Mailgun-Variables,X-Mailgun-Tag') или используйте 'all', чтобы удалить все заголовки X-Mailgun.
Примечание: заголовок X-Mailgun-Sid в настоящее время используется для обработки жалоб, полученных через петли обратной связи.
o_tagstring[]
Строка тега. Подробнее см. в разделе Tagging.
o_testmodeenum
Включает отправку в тестовом режиме. Сообщения обрабатываются как обычно, но фактически не доставляются получателям. Полезно для тестирования без отправки реальных писем. См. Отправка в тестовом режиме
o_time-zone-localizestring
Переключает оптимизацию часового пояса (TZO) для каждого сообщения отдельно. Строка должна быть задана как предпочтительное время доставки в формате HH:mm или hh:mmaa, где HH:mm используется для 24-часового формата без AM/PM, а hh:mmaa для 12-часового формата с AM/PM. Подробнее см. Отправка сообщения с TZO. Обратите внимание: TZO доступна только на определённых тарифных планах. Подробнее см. www.mailgun.com/pricing
o_trackingenum
Включает и отключает отслеживание кликов и открытий для каждого отдельного сообщения.
o_tracking-clicksenum
Переключает отслеживание кликов на уровне отдельного сообщения, см. Отслеживание кликов. Это переопределяет настройку отслеживания кликов на уровне домена.
o_tracking-opensenum
Переключает отслеживание открытий для каждого отдельного сообщения, см. Отслеживание открытий. Имеет более высокий приоритет, чем настройка на уровне домена.
o_tracking-pixel-location-topenum
Размещает пиксель отслеживания в верхней части писем, а не в нижней. Это полезно для длинных писем, которые могут обрезаться или иметь проблемы с отображением, и гарантирует точную работу отслеживания открытий.
recipient-variablesstring
JSON-словарь для пакетной отправки с персонализированными переменными для каждого получателя. Каждый ключ - это email-адрес получателя, а каждое значение - словарь переменных для этого получателя. На переменные можно ссылаться в сообщении через %recipient.variablename%. Пример: '{"alice@example.com": {"name":"Alice", "id":1}, "bob@example.com": {"name":"Bob", "id":2}}'. Максимум 1000 получателей на одну пакетную отправку. Подробнее см. Batch Sending.
subjectstringобязательный
Тема сообщения. Примечание: необязательно, если отправка идёт с шаблоном, у которого уже задана тема, но если указана, она переопределит её.
templatestring
Название шаблона, сохранённого через Templates API, которое используется для рендеринга тела письма. Подробнее см. Templates
textstring
Тело сообщения (текстовая версия)
tostring[]обязательный
Электронный адрес получателя(ей). Поддерживается формат с отображаемым именем. Пример: "Bob <bob@host.com>". Несколько получателей разделяются запятыми. Дублирующиеся адреса автоматически игнорируются.
t_textenum
Создает текстовую версию шаблона вместе с HTML-версией при отправке писем на основе шаблонов. Если установлено значение 'yes', Mailgun создает текстовую MIME-часть на основе содержимого шаблона, что обеспечивает совместимость с почтовыми клиентами, которые не поддерживают HTML или у которых отключено отображение HTML. Это улучшает доставляемость писем и их доступность, предоставляя запасной текстовый вариант в многочастных письмах.
t_variablesstring
Допустимый JSON-словарь, используемый в качестве входных данных для подстановки переменных в шаблонах. См. Шаблоны для получения дополнительной информации.
t_versionstring
Рендерите конкретную версию шаблона, а не последнюю. Опцию template тоже нужно указать.
v_my-varstring
Прикрепляет пользовательские данные к сообщению, используя префикс 'v:' с последующим именем переменной. При отправке с шаблонами предоставляет значения для подстановки переменных шаблона (переопределяется 't:variables', если указаны оба). Если шаблоны не используются, обрабатывается как метаданные и включается в события/вебхуки. Переменные видны в заголовке X-Mailgun-Variables доставленного email. Пример: 'v:user-id=123'. ПРИМЕЧАНИЕ: Все, что превышает 4KB, будет усечено в событии/вебхуках.
