API de Email

Por ahora no hemos lanzado ningún wrapper de API, pero planeamos hacerlo en un futuro cercano. Envía un correo a api@forwardemail.net si deseas ser notificado cuando se lance el wrapper de API para un lenguaje de programación en particular. Mientras tanto, puedes usar estas bibliotecas recomendadas para solicitudes HTTP en tu aplicación, o simplemente usar curl como en los ejemplos a continuación.

La ruta base HTTP actual es: https://fe.tiamati.email.

Todos los endpoints requieren autenticación usando Autorización Básica. Soportamos dos métodos de autenticación:

Autenticación con Token API (Recomendado para la mayoría de los endpoints)

Establece tu clave API como el valor "usuario" con una contraseña vacía:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Nota el dos puntos (:) después del token API – esto indica una contraseña vacía en formato de Autenticación Básica.

Autenticación con Credenciales de Alias (Para correo saliente)

El endpoint Crear correo SMTP saliente también soporta autenticación usando tu dirección de correo alias y una contraseña de alias generada:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hola" \
  -d "text=Correo de prueba"

Este método es útil cuando se envían correos desde aplicaciones que ya usan credenciales SMTP y facilita la migración de SMTP a nuestra API sin problemas.

Endpoints Solo para Alias

Los endpoints Contactos de Alias, Calendarios de Alias, Mensajes de Alias y Carpetas de Alias requieren credenciales de alias y no soportan autenticación con token API.

No te preocupes – a continuación se proporcionan ejemplos para ti si no estás seguro de qué es esto.

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

Nuestro servicio está traducido a más de 25 idiomas diferentes. Todos los mensajes de respuesta de la API se traducen al último idioma detectado del usuario que realiza la solicitud API. Puedes sobrescribir esto pasando un encabezado Accept-Language personalizado. Siéntete libre de probarlo usando el selector de idioma en la parte inferior de esta página.

La paginación es soportada por todos los endpoints de API que listan resultados.

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

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

Ejemplo de solicitud:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Recuperar registros

Nuestra API permite programáticamente descargar registros para su cuenta. Enviar una solicitud a este endpoint procesará todos los registros de su cuenta y se los enviará por correo electrónico como un archivo adjunto (hoja de cálculo CSV comprimida con Gzip) 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 endpoint está limitado a 10 solicitudes por día.

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

GET /v1/logs/download

Ejemplo de solicitud:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

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

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Tenga en cuenta que puede usar servicios como Crontab.guru para validar la sintaxis de su expresión de 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://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Recuperar cuenta

GET /v1/account

Ejemplo de solicitud:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Actualizar cuenta

PUT /v1/account

Ejemplo de solicitud:

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

Listar 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

Listar 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

Por favor asegúrese de haber seguido las instrucciones de configuración para su dominio.

Estas instrucciones se pueden encontrar en nuestra sección de FAQ ¿Soportan recibir correo electrónico con IMAP?.

Listar y buscar mensajes

GET /v1/messages

Próximamente

Crear mensaje

POST /v1/messages

Próximamente

Recuperar mensaje

GET /v1/messages/:id

Próximamente

Actualizar mensaje

PUT /v1/messages/:id

Próximamente

Eliminar mensaje

DELETE /v1/messages:id

Próximamente

Listar 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

Por favor 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 límite de correo SMTP saliente

Este es un endpoint simple que devuelve un objeto JSON que contiene el count y limit para el número de mensajes SMTP salientes diarios por cuenta.

GET /v1/emails/limit

Ejemplo de solicitud:

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Listar correos SMTP salientes

Tenga en cuenta que este endpoint no devuelve los valores de las propiedades message, headers ni rejectedErrors de un correo.

Para devolver esas propiedades y sus valores, utilice el endpoint Recuperar correo con un ID de correo.

GET /v1/emails

Ejemplo de solicitud:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Crear correo SMTP saliente

Nuestra API para crear un correo está inspirada y aprovecha la configuración de opciones de mensaje de Nodemailer. Por favor, consulte la configuración de mensaje 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 los configuramos automáticamente por usted), soportamos todas las opciones de Nodemailer. Automáticamente configuramos las opciones disableFileAccess y disableUrlAccess a true por razones de seguridad.

Debe pasar la opción única raw con su correo completo en bruto incluyendo encabezados o pasar las opciones individuales de parámetros del cuerpo a continuación.

Este endpoint de la API codificará automáticamente los emojis si se encuentran en los encabezados (por ejemplo, una línea de asunto Subject: 🤓 Hello se convierte automáticamente en Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Nuestro objetivo fue crear una API de correo extremadamente amigable para desarrolladores y a prueba de errores.

Autenticación: Este endpoint soporta tanto autenticación con token API como autenticación con credenciales de alias. Consulte la sección Autenticación arriba para más detalles.

POST /v1/emails

Solicitud de ejemplo (Token API):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=prueba" \
  -d "text=prueba"

Solicitud de ejemplo (Credenciales de alias):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=prueba" \
  -d "text=prueba"

Solicitud de ejemplo (Correo electrónico en bruto):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Recuperar correo SMTP saliente

GET /v1/emails/:id

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Eliminar correo SMTP saliente

La eliminación de correos establecerá el estado a "rejected" (y posteriormente no lo procesará en la cola) si y solo si el estado actual es uno de "pending", "queued" o "deferred". Podemos purgar correos automáticamente después de 30 días desde que fueron creados y/o enviados – por lo tanto, debe mantener una copia de los correos SMTP salientes en su cliente, base de datos o aplicación. Puede referenciar nuestro valor de ID de correo en su base de datos si lo desea – este valor se devuelve tanto en los endpoints de Crear correo como de Recuperar correo.

DELETE /v1/emails/:id

Solicitud de ejemplo:

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Listar dominios

GET /v1/domains

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Crear dominio

POST /v1/domains

Solicitud de ejemplo:

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Recuperar dominio

GET /v1/domains/example.com

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Verificar registros del dominio

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

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Verificar registros SMTP del dominio

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

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Listar contraseñas catch-all a nivel de dominio

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

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Crear contraseña catch-all a nivel de dominio

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

Solicitud de ejemplo:

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

Eliminar contraseña catch-all a nivel de dominio

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

Solicitud de ejemplo:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Actualizar dominio

PUT /v1/domains/example.com

Solicitud de ejemplo:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Eliminar dominio

DELETE /v1/domains/:domain_name

Solicitud de ejemplo:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Aceptar invitación de dominio

GET /v1/domains/:domain_name/invites

Solicitud de ejemplo:

curl https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Actualizar miembro del dominio

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

Solicitud de ejemplo:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Eliminar miembro del dominio

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

Solicitud de ejemplo:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Generar una contraseña para alias

Tenga en cuenta que si no envía instrucciones por correo electrónico, entonces 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://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Listar alias de dominio

GET /v1/domains/example.com/aliases

Ejemplo de solicitud:

curl https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Recuperar alias de dominio

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

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

Solicitud de ejemplo:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Solicitud de ejemplo:

curl https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Permitimos que encripte 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 se solicitó mucho en una discusión de Privacy Guides y en nuestros issues de GitHub lo hemos añadido.

Encriptar registro TXT

POST /v1/encrypt

Solicitud de ejemplo:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"