API de correo electrónico

En este momento, aún no hemos lanzado ninguna envoltura de API, pero planeamos hacerlo en un futuro cercano. Enviar un correo electrónico a api@forwardemail.net si desea recibir una notificación cuando se publique el envoltorio API de un lenguaje de programación en particular. Mientras tanto, puede usar estas bibliotecas de solicitudes HTTP recomendadas en su aplicación, o simplemente usar rizo como en los siguientes ejemplos.

La ruta de URI base HTTP actual es: https://api.forwardemail.net.

Todos los puntos finales requieren su Clave API para establecerse como el valor de "nombre de usuario" de la solicitud Autorización Básica encabezamiento. No se preocupe, a continuación se proporcionan ejemplos para usted si no está seguro de qué se trata.

Si ocurre algún error, el cuerpo de respuesta de la solicitud de API contendrá un mensaje de error detallado.

Nuestro servicio está traducido a más de 25 idiomas diferentes. Todos los mensajes de respuesta de API se traducen a la última configuración regional detectada del usuario que realiza la solicitud de API. Puede anular esto pasando un personalizado Accept-Language encabezamiento. Siéntase libre de probarlo usando el menú desplegable de idiomas en la parte inferior de esta página.

Si desea recibir una notificación cuando la paginación esté disponible, envíe un correo electrónico api@forwardemail.net.

Crear una cuenta

POST /v1/account

Solicitud de ejemplo:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Recuperar cuenta

GET /v1/account

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Actualizar cuenta

PUT /v1/account

Solicitud de ejemplo:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Asegúrese de haber seguido las instrucciones de configuración para su dominio. Estas instrucciones se pueden encontrar en Mi cuenta → Dominios → Configuración → Configuración de SMTP saliente. Debe asegurarse de la configuración de DKIM, Return-Path y DMARC para enviar SMTP saliente con su dominio.

Lista de correos electrónicos

Tenga en cuenta que este punto final no devuelve un correo electrónico ya creado. message, headers, accepted, ni rejectedErrors propiedades.

Para devolver esas propiedades y sus valores, utilice el recuperar correo electrónico punto final con un ID de correo electrónico.

Este punto final regresará como máximo 50 resultados a la vez. Si desea consultar varias páginas, agregue ?page=NUMBER dónde NUMBER es un número entero, p.e. ?page=1.

GET /v1/emails

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/emails \
  -u API_TOKEN:

Crear correo electrónico

Nuestra API para crear un correo electrónico se inspira y aprovecha la configuración de opciones de mensajes de Nodemailer. Por favor difiera a la Configuración de mensajes de Nodemailer para todos los parámetros del cuerpo a continuación.

Tenga en cuenta que con la excepción de envelope y dkim (dado que los configuramos automáticamente para usted), admitimos todas las opciones de Nodemailer. Configuramos automáticamente disableFileAccess y disableUrlAccess opciones para true para fines de seguridad.

Debe pasar la opción única de raw con su correo electrónico completo sin procesar, incluidos los encabezados o pase las opciones de parámetros de cuerpo individuales a continuación.

POST /v1/emails

Solicitud de ejemplo:

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"

Solicitud de ejemplo:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

recuperar correo electrónico

GET /v1/emails/:id

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Eliminar correo electrónico

La eliminación del correo electrónico establecerá el estado en "rejected" (y posteriormente no procesarlo en la cola) si y solo si el estado actual es uno de "pending", "queued", o "deferred". Es posible que eliminemos los correos electrónicos automáticamente después de 30 días de haberlos creado y/o enviado; por lo tanto, debe conservar una copia de los correos electrónicos SMTP salientes en su cliente, base de datos o aplicación. Puede hacer referencia a nuestro valor de ID de correo electrónico en su base de datos si lo desea; este valor se devuelve de ambos Crear correo electrónico y recuperar correo electrónico puntos finales

DELETE /v1/emails/:id

Solicitud de ejemplo:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Lista de dominios

GET /v1/domains

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Crear dominio

POST /v1/domains

Solicitud de ejemplo:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Recuperar dominio

GET /v1/domains/example.com

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Verificar registros de dominio

GET /v1/domains/example.com/verify-records

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Actualizar dominio

PUT /v1/domains/example.com

Solicitud de ejemplo:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Eliminar dominio

DELETE /v1/domains/:domain_name

Solicitud de ejemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Aceptar invitación de dominio

GET /v1/domains/:domain_name/invites

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Crear invitación de dominio

POST /v1/domains/example.com/invites

Solicitud de ejemplo:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Eliminar invitación de dominio

DELETE /v1/domains/:domain_name/invites

Solicitud de ejemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Actualizar miembro de dominio

PUT /v1/domains/example.com/members/:member_id

Solicitud de ejemplo:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Eliminar miembro de dominio

DELETE /v1/domains/:domain_name/members/:member_id

Solicitud de ejemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Listar alias de dominio

GET /v1/domains/example.com/aliases

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Crear nuevo alias de dominio

POST /v1/domains/example.com/aliases

Solicitud de ejemplo:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Recuperar alias de dominio

Puede recuperar un alias de dominio ya sea por su id o su name valor.

GET /v1/domains/:domain_name/aliases/:alias_id

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Solicitud de ejemplo:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Actualizar alias de dominio

PUT /v1/domains/example.com/aliases/:alias_id

Solicitud de ejemplo:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Eliminar alias de dominio

DELETE /v1/domains/:domain_name/aliases/:alias_id

Solicitud de ejemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN: