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 encabezado (con excepción de Contactos de alias, Alias Calendarios, y Buzones de alias que utilizan 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.

[!TIP] Si recibe un código de estado 5xx (lo cual no debería suceder), contáctenos en api@forwardemail.net y le ayudaremos a resolver su problema inmediatamente.

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.

[!NOTA] A partir del 1 de noviembre de 2024, los puntos finales de la API para Lista de dominios y Listar alias de dominio El valor predeterminado será 1000 Máximo de resultados por página. Si desea optar por este comportamiento antes, puede pasar ?paginate=true como un parámetro de cadena de consulta adicional a la URL para la consulta del punto final.

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 a 1Si usted proporciona limit (también un número), entonces el valor mínimo es 10 y el máximo es 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):

Solicitud de ejemplo:

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

Recuperar registros

Nuestra API le permite descargar registros para su cuenta mediante programación. Al enviar una solicitud a este punto final se procesarán todos los registros de su cuenta y se los enviarán por correo electrónico como un archivo adjunto (zip comprimido CSV archivo de hoja de cálculo) una vez completado.

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

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

GET /v1/logs/download

Solicitud de ejemplo:

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 expresión de su trabajo cron.

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

Para Mac OS:

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 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"

[!NOTA] A diferencia de otros puntos finales de API, estos requieren Autenticación "nombre de usuario" igual al nombre de usuario alias y "contraseña" igual a la contraseña generada por alias como encabezados de Autorización Básica.

[!ADVERTENCIA] Esta sección de endpoints está en desarrollo y se lanzará (con suerte) en 2024. Mientras tanto, utilice un cliente IMAP del menú desplegable "Aplicaciones" en la navegación de nuestro sitio web.

[!NOTE] La compatibilidad con CardDAV aún no está disponible. Siga esta discusión en GitHub para obtener actualizaciones..

Lista de contactos

GET /v1/contacts

Próximamente

Crear contacto

POST /v1/contacts

Próximamente

Recuperar contacto

GET /v1/contacts/:id

Próximamente

Actualizar contacto

PUT /v1/contacts/:id

Próximamente

Eliminar contacto

DELETE /v1/contacts/:id

Próximamente

[!NOTA] A diferencia de otros puntos finales de API, estos requieren Autenticación "nombre de usuario" igual al nombre de usuario alias y "contraseña" igual a la contraseña generada por alias como encabezados de Autorización Básica.

[!ADVERTENCIA] Esta sección de endpoints está en desarrollo y se lanzará (con suerte) en 2024. Mientras tanto, utilice un cliente IMAP del menú desplegable "Aplicaciones" en la navegación de nuestro sitio web.

Lista de calendarios

GET /v1/calendars

Próximamente

Crear calendario

POST /v1/calendars

Próximamente

Recuperar calendario

GET /v1/calendars/:id

Próximamente

Actualizar calendario

PUT /v1/calendars/:id

Próximamente

Eliminar calendario

DELETE /v1/calendars/:id

Próximamente

[!NOTA] A diferencia de otros puntos finales de API, estos requieren Autenticación "nombre de usuario" igual al nombre de usuario alias y "contraseña" igual a la contraseña generada por alias como encabezados de Autorización Básica.

[!ADVERTENCIA] Esta sección de endpoints está en desarrollo y se lanzará (con suerte) en 2024. Mientras tanto, utilice un cliente IMAP del menú desplegable "Aplicaciones" en la navegación de nuestro sitio web.

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?.

Listado y búsqueda de mensajes

GET /v1/messages

Próximamente

Crear mensaje

[!NOTA] Esto hará NOT enviar un correo electrónico: simplemente agregará el mensaje a su carpeta de buzón (por ejemplo, esto es similar a IMAP) APPEND comando). Si desea enviar un correo electrónico, consulte Crear correo electrónico SMTP saliente A continuación. Después de crear el correo electrónico SMTP saliente, puede adjuntar una copia del mismo mediante este punto final al buzón de su alias para fines de almacenamiento.

POST /v1/messages

Próximamente

Recuperar mensaje

GET /v1/messages/:id

Próximamente

Mensaje de actualización

PUT /v1/messages/:id

Próximamente

Eliminar mensaje

DELETE /v1/messages:id

Próximamente

[!TIP] Puntos finales de carpeta con la ruta de una carpeta /v1/folders/:path ya que sus puntos finales son intercambiables con el ID de una carpeta :id. Esto significa que puede hacer referencia a la carpeta ya sea por su path o id valor.

[!ADVERTENCIA] Esta sección de endpoints está en desarrollo y se lanzará (con suerte) en 2024. Mientras tanto, utilice un cliente IMAP del menú desplegable "Aplicaciones" en la navegación de nuestro sitio web.

Lista de carpetas

GET /v1/folders

Próximamente

Crear carpeta

POST /v1/folders

Próximamente

Recuperar carpeta

GET /v1/folders/:id

Próximamente

Actualizar carpeta

PUT /v1/folders/:id

Próximamente

Eliminar carpeta

DELETE /v1/folders/:id

Próximamente

Copiar carpeta

POST /v1/folders/:id/copy

Próximamente

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.

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

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

GET /v1/emails/limit

Solicitud de ejemplo:

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 un correo electrónico. message, headers, ni rejectedErrors.

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

GET /v1/emails

Solicitud de ejemplo:

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 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.

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

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 SMTP saliente

GET /v1/emails/:id

Solicitud de ejemplo:

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

Eliminar correo electrónico SMTP saliente

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:

[!TIP] Puntos finales de dominio con nombre de dominio /v1/domains/:domain_name ya que sus puntos finales son intercambiables con el ID de un dominio :domain_id. Esto significa que puede hacer referencia al dominio ya sea por su name o id valor.

Lista de dominios

[!NOTA] A partir del 1 de noviembre de 2024, los puntos finales de la API para Lista de dominios y Listar alias de dominio El valor predeterminado será 1000 Máximo de resultados por página. Si desea optar por este comportamiento antes, puede pasar ?paginate=true como un parámetro de cadena de consulta adicional a la URL para la consulta del punto final. Ver Paginación para obtener más información.

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

[!IMPORTANTE] Si el usuario invitado ya es miembro de otro dominio del que es miembro el administrador que lo invita, se aceptará automáticamente la invitación y no se enviará un correo electrónico.

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:

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 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

Solicitud de ejemplo:

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

Listar alias de dominio

[!NOTA] A partir del 1 de noviembre de 2024, los puntos finales de la API para Lista de dominios y Listar alias de dominio El valor predeterminado será 1000 Máximo de resultados por página. Si desea optar por este comportamiento antes, puede pasar ?paginate=true como un parámetro de cadena de consulta adicional a la URL para la consulta del punto final. Ver Paginación para obtener más información.

GET /v1/domains/example.com/aliases

Solicitud de ejemplo:

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

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:

Le permitimos cifrar registros incluso en el plan gratuito sin costo alguno. La privacidad no debería ser una característica, debería estar inherentemente integrada en todos los aspectos de un producto. Como muy solicitado en un Discusión sobre guías de privacidad y en nuestros problemas de GitHub Hemos agregado esto.

Cifrar registro TXT

POST /v1/encrypt

Solicitud de ejemplo:

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