- Страница поиска
- Оглавление
API электронной почты
Библиотеки
На данный момент мы еще не выпустили никаких API-оболочек, но планируем сделать это в ближайшем будущем. Отправить электронное письмо на api@forwardemail.net если вы хотите получать уведомления о выпуске оболочки API определенного языка программирования. А пока вы можете использовать эти рекомендуемые библиотеки HTTP-запросов в своем приложении или просто использовать локон как в приведенных ниже примерах.
язык | Библиотека |
---|---|
Рубин | фарадей |
питон | Запросы |
Ява | ОкHttp |
PHP | пропивать |
JavaScript | SuperAgent (мы сопровождающие) |
Node.js | SuperAgent (мы сопровождающие) |
Идти | нетто / HTTP |
.NET | RestSharp |
Базовый URI
Текущий базовый путь URI HTTP: https://api.forwardemail.net
.
Аутентификация
Все конечные точки требуют вашего ключ API для установки в качестве значения "имя пользователя" запроса Базовая авторизация заголовок (за исключением Контакты псевдонима, Псевдонимы Календари, а также Псевдонимы почтовых ящиков которые используют сгенерированный псевдоним имени пользователя и пароля)..
Не волнуйтесь — ниже приведены примеры, если вы не уверены, что это такое.
ошибки
Если возникают какие-либо ошибки, тело ответа на запрос API будет содержать подробное сообщение об ошибке.
Код | имя |
---|---|
200 | OK |
400 | Неверный запрос |
401 | неразрешенный |
403 | запрещено |
404 | не обнаружена |
429 | Слишком много запросов |
500 | Внутренняя Ошибка Сервера |
501 | Не реализована |
502 | Плохой шлюз |
503 | Сервис недоступен |
504 | Время ожидания шлюза |
локализация
Наш сервис переведен более чем на 25 различных языков. Все ответные сообщения API переводятся в последний обнаруженный языковой стандарт пользователя, отправляющего запрос API. Вы можете переопределить это, передав пользовательский Accept-Language
заголовок. Не стесняйтесь попробовать его, используя раскрывающийся список языков внизу этой страницы.
пагинация
NOTE: По состоянию на 1 ноября 2024 года конечные точки API для Список доменов а также Список псевдонимов домена по умолчанию будет
1000
максимальное количество результатов на странице. Если вы хотите заранее подписаться на это поведение, вы можете передать?paginate=true
как дополнительный параметр строки запроса к URL-адресу для запроса конечной точки.
Пагинация поддерживается всеми конечными точками API, выводящими список результатов.
Просто укажите свойства строки запроса page
(и по желанию limit
).
Собственность page
должно быть числом большим или равным 1
. Если вы предоставите limit
(также число), то минимальное значение равно 10
и максимум - это 50
(если не указано иное).
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
page | нет | Число | Страница результатов для возврата. Если не указано, page значение будет 1 . Должно быть число больше или равное 1 . |
limit | нет | Число | Количество результатов для возврата на страницу. По умолчанию 10 если не указано. Должно быть число больше или равно 1 , и меньше или равно 50 . |
Чтобы определить, доступны ли дополнительные результаты, мы предоставляем следующие заголовки HTTP-ответа (которые можно проанализировать для программной разбивки на страницы):
Заголовок HTTP-ответа | Пример | Описание |
---|---|---|
X-Page-Count | X-Page-Count: 3 | Общее количество доступных страниц. |
X-Page-Current | X-Page-Current: 1 | Текущая страница результатов возвращается (например, на основе page параметры строки запроса). |
X-Page-Size | X-Page-Size: 10 | Общее количество результатов на возвращенной странице (например, на основе limit параметр строки запроса и фактические возвращаемые результаты). |
X-Item-Count | X-Item-Count: 30 | Общее количество элементов, доступных на всех страницах. |
Link | Link: <https://api.forwardemail.net/v1/emails?page=1>; rel="prev", <https://api.forwardemail.net/v1/emails?page=3>; rel="next", <https://api.forwardemail.net/v1/emails?page=3; rel="last", https://api.forwardemail.net/v1/emails?page=1; rel="first" | Мы предоставляем Link Заголовок ответа HTTP можно проанализировать, как показано в примере. Это похоже на GitHub (например, не все значения будут предоставлены, если они нерелевантны или недоступны, например "next" не будет предоставлен, если нет другой страницы). |
Пример запроса:
curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
-u API_TOKEN:
Журналы
Получить журналы
Наш API программно позволяет загружать журналы для вашей учетной записи. Отправка запроса на эту конечную точку обработает все журналы вашей учетной записи и отправит их вам по электронной почте в виде вложения (Gzip сжатый CSV файл электронной таблицы) после завершения.
Это позволяет создавать фоновые задания с задание Крон или используя наш Программное обеспечение для планирования заданий Node.js Bree получать журналы в любое время. Обратите внимание, что эта конечная точка ограничена 10
запросов в день.
Вложение представляет собой строчную форму email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz
а само электронное письмо содержит краткое описание полученных журналов. Вы также можете в любое время скачать журналы с Моя учетная запись → Журналы
GET /v1/logs/download
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
domain | нет | Строка (полное доменное имя) | Фильтрация журналов по полному домену («FQDN»). Если вы не предоставите это, будут получены все журналы всех доменов. |
q | нет | строка | Поиск журналов по электронной почте, домену, псевдониму, IP-адресу или дате (M/Y , M/D/YY , M-D , M-D-YY , или же M.D.YY формат). |
Пример запроса:
curl https://api.forwardemail.net/v1/logs/download \
-u API_TOKEN:
Пример задания Cron (ежедневно в полночь):
0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null
Обратите внимание, что вы можете использовать такие сервисы, как Crontab.guru для проверки синтаксиса выражения вашего задания cron.
Пример задания Cron (каждый день в полночь и с журналами за предыдущий день):
Для MacOS:
0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null
Для Linux и Ubuntu:
0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null
Счет
создать учетную запись
POST /v1/account
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | да | Строка (электронная почта) | Адрес электронной почты |
password | да | строка | пароль |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Получить аккаунт
GET /v1/account
Пример запроса:
curl https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Обновить аккаунт
PUT /v1/account
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | нет | Строка (электронная почта) | Адрес электронной почты |
given_name | нет | строка | Имя |
family_name | нет | строка | Фамилия |
avatar_url | нет | Строка (URL) | Ссылка на аватар |
Пример запроса:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Контакты псевдонима (CardDAV)
NOTE: В отличие от других конечных точек API, эти требуют Аутентификация «username» равно псевдониму имени пользователя, а «password» равно паролю, сгенерированному псевдонимом, в качестве заголовков базовой авторизации.
WIP: Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте, пожалуйста, клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.
NOTE: Поддержка CardDAV пока недоступна, следите за обновлениями в этом обсуждении на GitHub.
Список контактов
GET /v1/contacts
Скоро будет
Создать контакт
POST /v1/contacts
Скоро будет
Получить контакт
GET /v1/contacts/:id
Скоро будет
Обновить контакт
PUT /v1/contacts/:id
Скоро будет
Удалить контакт
DELETE /v1/contacts/:id
Скоро будет
Календари псевдонимов (CalDAV)
NOTE: В отличие от других конечных точек API, эти требуют Аутентификация «username» равно псевдониму имени пользователя, а «password» равно паролю, сгенерированному псевдонимом, в качестве заголовков базовой авторизации.
WIP: Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте, пожалуйста, клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.
Список календарей
GET /v1/calendars
Скоро будет
Создать календарь
POST /v1/calendars
Скоро будет
Получить календарь
GET /v1/calendars/:id
Скоро будет
Календарь обновлений
PUT /v1/calendars/:id
Скоро будет
Удалить календарь
DELETE /v1/calendars/:id
Скоро будет
Сообщения псевдонимов (IMAP/POP3)
NOTE: В отличие от других конечных точек API, эти требуют Аутентификация «username» равно псевдониму имени пользователя, а «password» равно паролю, сгенерированному псевдонимом, в качестве заголовков базовой авторизации.
WIP: Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте, пожалуйста, клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.
Убедитесь, что вы выполнили инструкции по настройке вашего домена.
Эти инструкции можно найти в разделе часто задаваемых вопросов. Поддерживаете ли вы получение электронной почты по протоколу IMAP?.
Список и поиск сообщений
GET /v1/messages
Скоро будет
Создать сообщение
NOTE: Это будет NOT отправить электронное письмо – оно просто добавит сообщение в папку вашего почтового ящика (например, это похоже на IMAP)
APPEND
Команда). Если вы хотите отправить электронное письмо, см. Создать исходящее SMTP-сообщение ниже. После создания исходящего SMTP-письма вы можете прикрепить его копию, используя эту конечную точку, к почтовому ящику вашего псевдонима для хранения.
POST /v1/messages
Скоро будет
Получить сообщение
GET /v1/messages/:id
Скоро будет
Обновить сообщение
PUT /v1/messages/:id
Скоро будет
Удалить сообщение
DELETE /v1/messages:id
Скоро будет
Псевдонимы папок (IMAP/POP3)
/v1/folders/:path
поскольку их конечная точка взаимозаменяема с идентификатором папки :id
. Это означает, что вы можете ссылаться на папку либо по ее имени, path
или id
ценность.
WIP: Этот раздел конечной точки находится в стадии разработки и будет выпущен (надеюсь) в 2024 году. В это время используйте, пожалуйста, клиент IMAP из раскрывающегося списка «Приложения» в навигации нашего веб-сайта.
Список папок
GET /v1/folders
Скоро будет
Создать папку
POST /v1/folders
Скоро будет
Восстановить папку
GET /v1/folders/:id
Скоро будет
Обновить папку
PUT /v1/folders/:id
Скоро будет
Удалить папку
DELETE /v1/folders/:id
Скоро будет
Копировать папку
POST /v1/folders/:id/copy
Скоро будет
Исходящие электронные письма
Убедитесь, что вы выполнили инструкции по настройке вашего домена.
Эти инструкции можно найти по адресу Моя учетная запись → Домены → Настройки → Конфигурация исходящего SMTP. Вам необходимо обеспечить настройку DKIM, Return-Path и DMARC для отправки исходящего SMTP с вашего домена.
Получить лимит исходящей электронной почты SMTP
Это простая конечная точка, которая возвращает объект JSON, содержащий count
а также limit
для количества ежедневных исходящих сообщений SMTP для каждой учетной записи.
GET /v1/emails/limit
Пример запроса:
curl https://api.forwardemail.net/v1/emails/limit \
-u API_TOKEN:
Список исходящих писем SMTP
Обратите внимание, что эта конечная точка не возвращает значения свойств для адреса электронной почты. message
, headers
, ни rejectedErrors
.
Чтобы вернуть эти свойства и их значения, используйте метод Получить электронную почту конечная точка с идентификатором электронной почты.
GET /v1/emails
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
q | нет | String (поддерживается RegExp) | Поиск писем по метаданным |
domain | нет | String (поддерживается RegExp) | Поиск писем по доменному имени |
sort | нет | строка | Сортировать по определенному полю (префикс с одним дефисом) - для сортировки в обратном направлении этого поля). По умолчанию created_at если не установлено. |
page | нет | Число | Видеть пагинация для более глубокого понимания |
limit | нет | Число | Видеть пагинация для более глубокого понимания |
Пример запроса:
curl https://api.forwardemail.net/v1/emails?limit=1 \
-u API_TOKEN:
Создать исходящее SMTP-сообщение
Наш API для создания электронной почты вдохновлен конфигурацией параметров сообщения Nodemailer и использует ее. Пожалуйста, отложите до Конфигурация сообщения Nodemailer для всех параметров тела ниже.
Обратите внимание, что за исключением envelope
а также dkim
(поскольку мы устанавливаем их автоматически), мы поддерживаем все параметры Nodemailer. Мы автоматически устанавливаем disableFileAccess
а также disableUrlAccess
варианты true
в целях безопасности.
Вы должны либо передать единственный вариант raw
с необработанным полным электронным письмом, включая заголовки или передать отдельные параметры тела ниже.
Эта конечная точка API будет автоматически кодировать для вас эмодзи, если они будут найдены в заголовках (например, в строке темы Subject: 🤓 Hello
преобразуется в Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello
автоматически). Нашей целью было создать чрезвычайно удобный для разработчиков и защищенный от «чайников» API электронной почты.
POST /v1/emails
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
from | нет | Строка (электронная почта) | Адрес электронной почты отправителя (должен существовать как псевдоним домена). |
to | нет | Строка или Массив | Список, разделенный запятыми, или массив получателей для заголовка «Кому». |
cc | нет | Строка или Массив | Список, разделенный запятыми, или массив получателей для заголовка «Копия». |
bcc | нет | Строка или Массив | Список, разделенный запятыми, или массив получателей для заголовка «Скрытая копия». |
subject | нет | строка | Тема письма. |
text | нет | Строка или буфер | Текстовая версия сообщения. |
html | нет | Строка или буфер | HTML-версия сообщения. |
attachments | нет | Множество | Массив объектов вложений (см. Общие поля Nodemailer). |
sender | нет | строка | Адрес электронной почты для заголовка «Отправитель» (см. Дополнительные поля Nodemailer). |
replyTo | нет | строка | Адрес электронной почты для заголовка «Reply-To». |
inReplyTo | нет | строка | Message-ID, на который отвечает сообщение. |
references | нет | Строка или Массив | Список, разделенный пробелами, или массив идентификаторов сообщений. |
attachDataUrls | нет | логический | Если true затем преобразует data: изображения в HTML-содержимом сообщения во встроенные вложения. |
watchHtml | нет | строка | HTML-версия сообщения для Apple Watch (согласно документам Nodemailer, последние часы не требуют его установки). |
amp | нет | строка | HTML-версия сообщения для AMP4EMAIL (см. Пример Nodemailer). |
icalEvent | нет | Объект | Событие iCalendar для использования в качестве альтернативного содержимого сообщения (см. События календаря Nodemailer). |
alternatives | нет | Множество | Массив альтернативного содержимого сообщения (см. Альтернативный контент Nodemailer). |
encoding | нет | строка | Кодировка текста и строк HTML (по умолчанию "utf-8" , но поддерживает "hex" а также "base64" также значения кодировки). |
raw | нет | Строка или буфер | Специально сгенерированное сообщение в формате RFC822 для использования (вместо сообщения, созданного Nodemailer — см. Пользовательский источник Nodemailer). |
textEncoding | нет | строка | Кодировка, которая принудительно используется для текстовых значений (либо "quoted-printable" или "base64" ). Значением по умолчанию является ближайшее обнаруженное значение (для использования ASCII). "quoted-printable" ). |
priority | нет | строка | Уровень приоритета для электронной почты (может быть либо "high" , "normal" (по умолчанию) или "low" ). Обратите внимание, что значение "normal" не устанавливает приоритетный заголовок (это поведение по умолчанию). Если значение "high" или "low" установлен, то X-Priority , X-MSMail-Priority , а также Importance заголовки будет установлено соответственно. |
headers | нет | Объект или массив | Объект или массив дополнительных полей заголовка для установки (см. Пользовательские заголовки Nodemailer). |
messageId | нет | строка | Необязательное значение Message-ID для заголовка «Message-ID» (значение по умолчанию будет создано автоматически, если оно не задано — обратите внимание, что значение должно придерживаться спецификации RFC2822). |
date | нет | Строка или дата | Необязательное значение даты, которое будет использоваться, если заголовок даты отсутствует после синтаксического анализа, в противном случае будет использоваться текущая строка UTC, если она не установлена. Заголовок даты не может опережать текущее время более чем на 30 дней. |
list | нет | Объект | Необязательный объект List-* заголовки (см. Заголовки списка Nodemailer). |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/emails \
-u API_TOKEN: \
-d "from=alias@example.com" \
-d "to=user%40gmail.com" \
-d "subject=test" \
-d "text=test"
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/emails \
-u API_TOKEN: \
-d "raw=`cat file.eml`"
Получить исходящую SMTP-почту
GET /v1/emails/:id
Пример запроса:
curl https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
Удалить исходящую SMTP-почту
Удаление электронной почты установит статус на "rejected"
(и впоследствии не обрабатывать его в очереди) тогда и только тогда, когда текущий статус является одним из "pending"
, "queued"
, или же "deferred"
. Мы можем автоматически удалять электронные письма через 30 дней после их создания и/или отправки, поэтому вы должны хранить копии исходящих SMTP-сообщений в своем клиенте, базе данных или приложении. При желании вы можете сослаться на наше значение идентификатора электронной почты в своей базе данных — это значение возвращается из обоих Создать электронную почту а также Получить электронную почту конечные точки.
DELETE /v1/emails/:id
Пример запроса:
curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
Домены
/v1/domains/:domain_name
поскольку их конечная точка взаимозаменяема с идентификатором домена :domain_id
. Это означает, что вы можете ссылаться на домен либо по его name
или id
ценность.
Список доменов
NOTE: По состоянию на 1 ноября 2024 года конечные точки API для Список доменов а также Список псевдонимов домена по умолчанию будет
1000
максимальное количество результатов на странице. Если вы хотите заранее подписаться на это поведение, вы можете передать?paginate=true
как дополнительный параметр строки запроса к URL для запроса конечной точки. См. пагинация для большего понимания.
GET /v1/domains
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
q | нет | String (поддерживается RegExp) | Поиск доменов по имени |
name | нет | String (поддерживается RegExp) | Поиск доменов по имени |
sort | нет | строка | Сортировать по определенному полю (префикс с одним дефисом) - для сортировки в обратном направлении этого поля). По умолчанию created_at если не установлено. |
page | нет | Число | Видеть пагинация для более глубокого понимания |
limit | нет | Число | Видеть пагинация для более глубокого понимания |
Пример запроса:
curl https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Создать домен
POST /v1/domains
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
domain | да | Строка (FQDN или IP) | Полное доменное имя («FQDN») или IP-адрес |
plan | нет | Строка (перечислимая) | Тип плана (должен быть "free" , "enhanced_protection" , или же "team" , по умолчанию "free" или текущий платный план пользователя, если он есть) |
catchall | нет | Строка (адреса электронной почты с разделителями) или логическое значение | Создайте универсальный псевдоним по умолчанию, по умолчанию true (если true он будет использовать адрес электронной почты пользователя API в качестве получателя, и если false универсального не будет). Если передается строка, то это список адресов электронной почты с разделителями для использования в качестве получателей (разделенных разрывом строки, пробелом и/или запятой). |
has_adult_content_protection | нет | логический | Включить ли защиту содержимого для взрослых с помощью Spam Scanner в этом домене |
has_phishing_protection | нет | логический | Включить ли защиту от фишинга Spam Scanner в этом домене |
has_executable_protection | нет | логический | Включить ли защиту исполняемого файла Spam Scanner в этом домене |
has_virus_protection | нет | логический | Включить ли защиту от вирусов Spam Scanner в этом домене |
has_recipient_verification | нет | логический | Глобальный домен по умолчанию для того, чтобы требовать, чтобы получатели псевдонимов щелкали ссылку подтверждения электронной почты для прохождения электронных писем. |
ignore_mx_check | нет | логический | Игнорировать ли проверку записи MX в домене для проверки. Это в основном предназначено для пользователей, у которых есть расширенные правила настройки обмена MX, которым необходимо сохранить существующий обмен MX и переслать его на наш. |
retention_days | нет | Число | Целое число между 0 а также 30 это соответствует количеству дней хранения исходящих сообщений электронной почты SMTP после успешной доставки или постоянной ошибки. По умолчанию 0 , что означает, что исходящие электронные письма SMTP немедленно очищаются и редактируются в целях вашей безопасности. |
bounce_webhook | нет | Строка (URL) или логическое значение (false) | http:// или https:// URL-адрес веб-перехватчика по вашему выбору для отправки веб-перехватчиков отказов. Мы отправим POST Запросите на этот URL-адрес информацию об исходящих сбоях SMTP (например, программные или аппаратные сбои, чтобы вы могли управлять своими подписчиками и программно управлять исходящей электронной почтой). |
max_quota_per_alias | нет | строка | Максимальная квота хранения для псевдонимов на этом доменном имени. Введите значение, например "1 ГБ", которое будет проанализировано байты. |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
Получить домен
GET /v1/domains/example.com
Пример запроса:
curl https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Проверить записи домена
GET /v1/domains/example.com/verify-records
Пример запроса:
curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Обновить домен
PUT /v1/domains/example.com
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
smtp_port | нет | Строка или номер | Пользовательский порт для настройки переадресации SMTP (по умолчанию "25" ) |
has_adult_content_protection | нет | логический | Включить ли защиту содержимого для взрослых с помощью Spam Scanner в этом домене |
has_phishing_protection | нет | логический | Включить ли защиту от фишинга Spam Scanner в этом домене |
has_executable_protection | нет | логический | Включить ли защиту исполняемого файла Spam Scanner в этом домене |
has_virus_protection | нет | логический | Включить ли защиту от вирусов Spam Scanner в этом домене |
has_recipient_verification | нет | логический | Глобальный домен по умолчанию для того, чтобы требовать, чтобы получатели псевдонимов щелкали ссылку подтверждения электронной почты для прохождения электронных писем. |
ignore_mx_check | нет | логический | Игнорировать ли проверку записи MX в домене для проверки. Это в основном предназначено для пользователей, у которых есть расширенные правила настройки обмена MX, которым необходимо сохранить существующий обмен MX и переслать его на наш. |
retention_days | нет | Число | Целое число между 0 а также 30 это соответствует количеству дней хранения исходящих сообщений электронной почты SMTP после успешной доставки или постоянной ошибки. По умолчанию 0 , что означает, что исходящие электронные письма SMTP немедленно очищаются и редактируются в целях вашей безопасности. |
bounce_webhook | нет | Строка (URL) или логическое значение (false) | http:// или https:// URL-адрес веб-перехватчика по вашему выбору для отправки веб-перехватчиков отказов. Мы отправим POST Запросите на этот URL-адрес информацию об исходящих сбоях SMTP (например, программные или аппаратные сбои, чтобы вы могли управлять своими подписчиками и программно управлять исходящей электронной почтой). |
max_quota_per_alias | нет | строка | Максимальная квота хранения для псевдонимов на этом доменном имени. Введите значение, например "1 ГБ", которое будет проанализировано байты. |
Пример запроса:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Удалить домен
DELETE /v1/domains/:domain_name
Пример запроса:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
Предлагает
Принять приглашение домена
GET /v1/domains/:domain_name/invites
Пример запроса:
curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Создать домен приглашение
POST /v1/domains/example.com/invites
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | да | Строка (электронная почта) | Адрес электронной почты для приглашения в список участников домена |
group | да | Строка (перечислимая) | Группа для добавления пользователя в членство в домене (может быть одним из "admin" или "user" ) |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
Удалить приглашение домена
DELETE /v1/domains/:domain_name/invites
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
email | да | Строка (электронная почта) | Адрес электронной почты для удаления из списка членов домена |
Пример запроса:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
члены
Обновить члена домена
PUT /v1/domains/example.com/members/:member_id
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
group | да | Строка (перечислимая) | Группа для обновления членства пользователя в домене (может быть одним из "admin" или "user" ) |
Пример запроса:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
Удалить члена домена
DELETE /v1/domains/:domain_name/members/:member_id
Пример запроса:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
Псевдонимы
Создать псевдоним пароля
Обратите внимание: если вы не отправите инструкции по электронной почте, имя пользователя и пароль будут в теле ответа JSON успешного запроса в формате { username: 'alias@yourdomain.com', password: 'some-generated-password' }
.
POST /v1/domains/example.com/aliases/:alias_id/generate-password
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
new_password | нет | строка | Ваш новый пароль, который будет использоваться в качестве псевдонима. Обратите внимание, что вы можете оставить это поле пустым или вообще отсутствовать в теле запроса API, если хотите получить случайно сгенерированный и надежный пароль. |
password | нет | строка | Существующий пароль для псевдонима, чтобы изменить пароль без удаления существующего хранилища почтовых ящиков IMAP (см. is_override вариант ниже, если у вас больше нет существующего пароля). |
is_override | нет | логический | USE WITH CAUTION: это полностью заменит существующий пароль и базу данных псевдонима, а также навсегда удалит существующее хранилище IMAP и полностью сбросит базу данных электронной почты SQLite псевдонима. Если возможно, сделайте резервную копию, если у вас уже есть почтовый ящик, привязанный к этому псевдониму. |
emailed_instructions | нет | строка | Адрес электронной почты, на который нужно отправить пароль псевдонима и инструкции по настройке. |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
-u API_TOKEN:
Список псевдонимов домена
NOTE: По состоянию на 1 ноября 2024 года конечные точки API для Список доменов а также Список псевдонимов домена по умолчанию будет
1000
максимальное количество результатов на странице. Если вы хотите заранее подписаться на это поведение, вы можете передать?paginate=true
как дополнительный параметр строки запроса к URL для запроса конечной точки. См. пагинация для большего понимания.
GET /v1/domains/example.com/aliases
Параметр Querystring | необходимые | Тип | Описание |
---|---|---|---|
q | нет | String (поддерживается RegExp) | Поиск псевдонимов в домене по имени, ярлыку или получателю |
name | нет | String (поддерживается RegExp) | Искать алиасы в домене по имени |
recipient | нет | String (поддерживается RegExp) | Поиск псевдонимов в домене по получателю |
sort | нет | строка | Сортировать по определенному полю (префикс с одним дефисом) - для сортировки в обратном направлении этого поля). По умолчанию created_at если не установлено. |
page | нет | Число | Видеть пагинация для более глубокого понимания |
limit | нет | Число | Видеть пагинация для более глубокого понимания |
Пример запроса:
curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
-u API_TOKEN:
Создать новый псевдоним домена
POST /v1/domains/example.com/aliases
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
name | нет | строка | Имя псевдонима (если не указано или пусто, то генерируется случайный псевдоним) |
recipients | нет | Строка или Массив | Список получателей (должен быть разделен строкой/пробелом/запятой. Строка или массив действительных адресов электронной почты, полных доменных имен («FQDN»), IP-адресов и/или URL-адресов веб-перехватчиков, а также, если он не указан или является пустым Массив, тогда адрес электронной почты пользователя, отправляющего запрос API, будет установлен в качестве получателя) |
description | нет | строка | Описание псевдонима |
labels | нет | Строка или Массив | Список меток (должен быть через строку / пробел / через запятую, String или Array) |
has_recipient_verification | нет | логический | Требовать от получателей щелкнуть ссылку для подтверждения электронной почты, чтобы электронные письма могли пройти (по умолчанию используются настройки домена, если они не указаны явно в теле запроса). |
is_enabled | нет | логический | Включить или отключить этот псевдоним (если он отключен, электронные письма не будут направляться никуда, а будут возвращать успешные коды состояния). Если передается значение, оно преобразуется в логическое значение с помощью логический) |
error_code_if_disabled | нет | Номер (либо 250 , 421 , или же 550 ) | Входящее электронное письмо на этот псевдоним будет отклонено, если is_enabled является false либо с 250 (тихо доставить в никуда, например в черную дыру или /dev/null ), 421 (мягкий отказ; повторная попытка в течение примерно 5 дней) или 550 постоянные неудачи и отказы. По умолчанию 250 . |
has_imap | нет | логический | Включить или отключить хранилище IMAP для этого псевдонима (если отключено, полученные входящие электронные письма не будут сохраняться в IMAP-хранилище. Если передается значение, оно преобразуется в логическое значение с помощью логический) |
has_pgp | нет | логический | Включить или отключить OpenPGP-шифрование для Хранение электронной почты с шифрованием IMAP/POP3/CalDAV используя псевдоним public_key . |
public_key | нет | строка | Открытый ключ OpenPGP в формате ASCII Armor (нажмите здесь, чтобы просмотреть пример; например GPG-ключ для support@forwardemail.net ). Это применимо только в том случае, если у вас есть has_pgp установлен в true . Узнайте больше о сквозном шифровании в нашем разделе часто задаваемых вопросов.. |
max_quota | нет | строка | Максимальная квота хранилища для этого псевдонима. Оставьте пустым, чтобы сбросить текущую максимальную квоту домена или введите значение, например "1 ГБ", которое будет проанализировано байты. Это значение может быть изменено только администраторами домена. |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Получить псевдоним домена
Вы можете получить псевдоним домена либо по его id
или его name
ценность.
GET /v1/domains/:domain_name/aliases/:alias_id
Пример запроса:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN:
GET /v1/domains/:domain_name/aliases/:alias_name
Пример запроса:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
-u API_TOKEN:
Обновить псевдоним домена
PUT /v1/domains/example.com/aliases/:alias_id
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
name | нет | строка | Псевдоним |
recipients | нет | Строка или Массив | Список получателей (должен быть строкой / пробелом / разделенным запятыми строкой или массивом допустимых адресов электронной почты, полными доменными именами («FQDN»), IP-адресами и / или URL-адресами веб-крюка) |
description | нет | строка | Описание псевдонима |
labels | нет | Строка или Массив | Список меток (должен быть через строку / пробел / через запятую, String или Array) |
has_recipient_verification | нет | логический | Требовать от получателей щелкнуть ссылку для подтверждения электронной почты, чтобы электронные письма могли пройти (по умолчанию используются настройки домена, если они не указаны явно в теле запроса). |
is_enabled | нет | логический | Включить или отключить этот псевдоним (если он отключен, электронные письма не будут направляться никуда, а будут возвращать успешные коды состояния). Если передается значение, оно преобразуется в логическое значение с помощью логический) |
error_code_if_disabled | нет | Номер (либо 250 , 421 , или же 550 ) | Входящее электронное письмо на этот псевдоним будет отклонено, если is_enabled является false либо с 250 (тихо доставить в никуда, например в черную дыру или /dev/null ), 421 (мягкий отказ; повторная попытка в течение примерно 5 дней) или 550 постоянные неудачи и отказы. По умолчанию 250 . |
has_imap | нет | логический | Включить или отключить хранилище IMAP для этого псевдонима (если отключено, полученные входящие электронные письма не будут сохраняться в IMAP-хранилище. Если передается значение, оно преобразуется в логическое значение с помощью логический) |
has_pgp | нет | логический | Включить или отключить OpenPGP-шифрование для Хранение электронной почты с шифрованием IMAP/POP3/CalDAV используя псевдоним public_key . |
public_key | нет | строка | Открытый ключ OpenPGP в формате ASCII Armor (нажмите здесь, чтобы просмотреть пример; например GPG-ключ для support@forwardemail.net ). Это применимо только в том случае, если у вас есть has_pgp установлен в true . Узнайте больше о сквозном шифровании в нашем разделе часто задаваемых вопросов.. |
max_quota | нет | строка | Максимальная квота хранилища для этого псевдонима. Оставьте пустым, чтобы сбросить текущую максимальную квоту домена или введите значение, например "1 ГБ", которое будет проанализировано байты. Это значение может быть изменено только администраторами домена. |
Пример запроса:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
Удалить псевдоним домена
DELETE /v1/domains/:domain_name/aliases/:alias_id
Пример запроса:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN:
Шифровать
Мы позволяем вам бесплатно шифровать записи даже на бесплатном плане. Конфиденциальность не должна быть особенностью, она должна быть неотъемлемо встроена во все аспекты продукта. По настоятельной просьбе в Обсуждение руководств по конфиденциальности и дальше наши проблемы с GitHub мы добавили это.
Зашифровать TXT-запись
POST /v1/encrypt
Параметр тела | необходимые | Тип | Описание |
---|---|---|---|
input | да | строка | Любая действительная текстовая запись TXT для пересылки электронной почты. |
Пример запроса:
curl -X POST https://api.forwardemail.net/v1/encrypt \
-d "input=user@gmail.com"