API de correo electrónico

Todavía no hemos publicado ningún contenedor de API, pero planeamos hacerlo próximamente. Envíe un correo electrónico a api@forwardemail.net si desea recibir notificaciones cuando se publique el contenedor de 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 ejemplos a continuación.

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

Todos los puntos finales requieren que su Clave API se configure como el valor de "nombre de usuario" del encabezado Autorización básica de la solicitud (con la excepción de Contactos de alias, Calendarios de alias y Buzones de alias que usan un nombre de usuario y contraseña alias generados).

No te preocupes, a continuación te proporcionamos ejemplos si no estás seguro de qué es esto.

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. Todos los mensajes de respuesta de la API se traducen a la última configuración regional detectada del usuario que realizó la solicitud. Puede anular esta configuración pasando un encabezado Accept-Language personalizado. Pruébelo en el menú desplegable de idiomas al final de esta página.

La paginación es compatible con todos los puntos finales de API que enumeran resultados.

Simplemente proporcione las propiedades de la cadena de consulta page (y opcionalmente limit).

La propiedad page debe ser un número mayor o igual que 1. Si proporciona limit (también un número), el valor mínimo será 10 y el máximo será 50 (a menos que se indique lo contrario).

Para determinar si hay más resultados disponibles o no, proporcionamos estos encabezados de respuesta HTTP (que puede analizar para paginar programáticamente):

Ejemplo de solicitud:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Recuperar registros

Nuestra API le permite descargar los registros de su cuenta de forma programática. Al enviar una solicitud a este punto final, se procesarán todos los registros de su cuenta y se los enviaremos por correo electrónico como archivo adjunto (archivo de hoja de cálculo comprimido Gzip CSV) una vez completados.

Esto le permite crear trabajos en segundo plano con un Trabajo cron o usar nuestro Software de programación de tareas Node.js Bree para recibir registros cuando lo desee. Tenga en cuenta que este punto final está limitado a 10 solicitudes por día.

El archivo adjunto es email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz en minúsculas y el correo electrónico contiene un breve resumen de los registros recuperados. También puede descargar los registros en cualquier momento desde Mi cuenta → Registros.

GET /v1/logs/download

Ejemplo de solicitud:

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

Ejemplo de trabajo Cron (a medianoche todos los días):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Tenga en cuenta que puede utilizar servicios como Crontab.guru para validar la sintaxis de la expresión de su trabajo cron.

Ejemplo de trabajo Cron (a medianoche todos los días y con registros del día anterior):

Para 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

Para Linux y 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

Crear cuenta

POST /v1/account

Ejemplo de solicitud:

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

Recuperar cuenta

GET /v1/account

Ejemplo de solicitud:

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

Actualizar cuenta

PUT /v1/account

Ejemplo de solicitud:

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

Lista de contactos

GET /v1/contacts

Muy pronto

Crear contacto

POST /v1/contacts

Muy pronto

Recuperar contacto

GET /v1/contacts/:id

Muy pronto

Actualizar contacto

PUT /v1/contacts/:id

Muy pronto

Eliminar contacto

DELETE /v1/contacts/:id

Muy pronto

Lista de calendarios

GET /v1/calendars

Muy pronto

Crear calendario

POST /v1/calendars

Muy pronto

Recuperar calendario

GET /v1/calendars/:id

Muy pronto

Actualizar calendario

PUT /v1/calendars/:id

Muy pronto

Eliminar calendario

DELETE /v1/calendars/:id

Muy pronto

Asegúrese de haber seguido las instrucciones de configuración para su dominio.

Estas instrucciones se pueden encontrar en nuestra sección de preguntas frecuentes ¿Es compatible la recepción de correo electrónico con IMAP?.

Listar y buscar mensajes

GET /v1/messages

Muy pronto

Crear mensaje

POST /v1/messages

Muy pronto

Recuperar mensaje

GET /v1/messages/:id

Muy pronto

Mensaje de actualización

PUT /v1/messages/:id

Muy pronto

Eliminar mensaje

DELETE /v1/messages:id

Muy pronto

Lista de carpetas

GET /v1/folders

Muy pronto

Crear carpeta

POST /v1/folders

Muy pronto

Recuperar carpeta

GET /v1/folders/:id

Muy pronto

Actualizar carpeta

PUT /v1/folders/:id

Muy pronto

Eliminar carpeta

DELETE /v1/folders/:id

Muy pronto

Copiar carpeta

POST /v1/folders/:id/copy

Muy pronto

Asegúrese de haber seguido las instrucciones de configuración para su dominio.

Estas instrucciones se encuentran en Mi cuenta → Dominios → Configuración → Configuración SMTP saliente. Debe asegurarse de configurar DKIM, Return-Path y DMARC para enviar SMTP saliente con su dominio.

Obtener el límite de correo electrónico SMTP saliente

Este es un punto final simple que devuelve un objeto JSON que contiene count y limit para la cantidad de mensajes SMTP salientes diarios por cuenta.

GET /v1/emails/limit

Ejemplo de solicitud:

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

Lista de correos electrónicos SMTP salientes

Tenga en cuenta que este punto final no devuelve valores de propiedad para message, headers ni rejectedErrors de un correo electrónico.

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

GET /v1/emails

Ejemplo de solicitud:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Crear correo electrónico SMTP saliente

Nuestra API para crear un correo electrónico se inspira en la configuración de opciones de mensaje de Nodemailer y la aprovecha. Por favor, utilice 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 (ya que las configuramos automáticamente), todas las opciones de Nodemailer son compatibles. Por seguridad, configuramos automáticamente las opciones disableFileAccess y disableUrlAccess en true.

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

Este punto final de la API codificará automáticamente los emojis si se encuentran en los encabezados (por ejemplo, una línea de asunto con Subject: 🤓 Hello se convierte automáticamente en Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Nuestro objetivo era crear una API de correo electrónico extremadamente intuitiva y a prueba de errores.

POST /v1/emails

Ejemplo de solicitud:

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"

Ejemplo de solicitud:

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

Recuperar correo electrónico SMTP saliente

GET /v1/emails/:id

Ejemplo de solicitud:

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

Eliminar correo electrónico SMTP saliente

La eliminación de correos electrónicos establecerá el estado en "rejected" (y posteriormente no se procesará en la cola) solo si el estado actual es "pending", "queued" o "deferred". Es posible que eliminemos los correos electrónicos automáticamente 30 días después de su creación o envío; por lo tanto, le recomendamos conservar una copia de los correos electrónicos SMTP salientes en su cliente, base de datos o aplicación. Si lo desea, puede consultar el valor de nuestro ID de correo electrónico en su base de datos; este valor se devuelve desde los endpoints Crear correo electrónico y Recuperar correo electrónico.

DELETE /v1/emails/:id

Ejemplo de solicitud:

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

Lista de dominios

GET /v1/domains

Ejemplo de solicitud:

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

Crear dominio

POST /v1/domains

Ejemplo de solicitud:

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

Ejemplo de solicitud:

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

Verificar registros de dominio

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

Ejemplo de solicitud:

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

Verificar registros SMTP del dominio

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

Ejemplo de solicitud:

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

Lista de contraseñas generales de todo el dominio

GET /v1/domains/example.com/catch-all-passwords

Ejemplo de solicitud:

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

Crear contraseña general para todo el dominio

POST /v1/domains/example.com/catch-all-passwords

Ejemplo de solicitud:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Eliminar la contraseña general de todo el dominio

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Ejemplo de solicitud:

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

Actualizar dominio

PUT /v1/domains/example.com

Ejemplo de solicitud:

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

Eliminar dominio

DELETE /v1/domains/:domain_name

Ejemplo de solicitud:

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

Ejemplo de solicitud:

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

Crear invitación de dominio

POST /v1/domains/example.com/invites

Ejemplo de solicitud:

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

Ejemplo de solicitud:

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

Actualizar miembro del dominio

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

Ejemplo de solicitud:

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

Eliminar miembro del dominio

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

Ejemplo de solicitud:

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

Generar una contraseña de alias

Tenga en cuenta que si no envía instrucciones por correo electrónico, el nombre de usuario y la contraseña estarán en el cuerpo de la respuesta JSON de una solicitud exitosa en el formato { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Ejemplo de solicitud:

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

Lista de alias de dominio

GET /v1/domains/example.com/aliases

Ejemplo de solicitud:

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

Crear nuevo alias de dominio

POST /v1/domains/example.com/aliases

Ejemplo de solicitud:

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 por su valor id o name.

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

Ejemplo de solicitud:

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

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

Ejemplo de solicitud:

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

Actualizar el alias del dominio

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

Ejemplo de solicitud:

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

Ejemplo de solicitud:

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

Le permitimos cifrar registros, incluso con el plan gratuito, sin costo alguno. La privacidad no debería ser una característica, sino una característica inherente a todos los aspectos del producto. Como se solicitó encarecidamente en Discusión sobre las Guías de Privacidad y nuestros problemas de GitHub, hemos añadido esto.

Cifrar registro TXT

POST /v1/encrypt

Ejemplo de solicitud:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"