API Email

Pour l'instant, nous n'avons pas encore publié de wrappers API, mais nous prévoyons de le faire prochainement. Envoyez un email à api@forwardemail.net si vous souhaitez être informé de la sortie d'un wrapper API pour un langage de programmation particulier. En attendant, vous pouvez utiliser ces bibliothèques HTTP recommandées dans votre application, ou simplement utiliser curl comme dans les exemples ci-dessous.

Le chemin URI de base HTTP actuel est : https://fe.tiamati.email.

Tous les points de terminaison nécessitent une authentification utilisant l’authentification basique. Nous supportons deux méthodes d’authentification :

Authentification par jeton API (recommandée pour la plupart des points de terminaison)

Définissez votre clé API comme valeur "nom d’utilisateur" avec un mot de passe vide :

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

Notez les deux-points (:) après le jeton API – cela indique un mot de passe vide au format Auth basique.

Authentification par identifiants d’alias (pour les emails sortants)

Le point de terminaison Créer un email SMTP sortant supporte également l’authentification en utilisant votre adresse email alias et un mot de passe alias généré :

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

Cette méthode est utile lors de l’envoi d’emails depuis des applications qui utilisent déjà des identifiants SMTP et facilite la migration de SMTP vers notre API.

Points de terminaison réservés aux alias

Les points de terminaison Contacts alias, Calendriers alias, Messages alias et Dossiers alias requièrent des identifiants alias et ne supportent pas l’authentification par jeton API.

Ne vous inquiétez pas – des exemples sont fournis ci-dessous si vous ne savez pas ce que c’est.

Si des erreurs surviennent, le corps de la réponse de la requête API contiendra un message d’erreur détaillé.

Notre service est traduit en plus de 25 langues différentes. Tous les messages de réponse API sont traduits dans la dernière locale détectée de l’utilisateur effectuant la requête API. Vous pouvez outrepasser cela en passant un en-tête Accept-Language personnalisé. N’hésitez pas à l’essayer en utilisant le menu déroulant de langue en bas de cette page.

La pagination est supportée par tous les points de terminaison API qui listent des résultats.

Il suffit de fournir les propriétés de chaîne de requête page (et éventuellement limit).

La propriété page doit être un nombre supérieur ou égal à 1. Si vous fournissez limit (également un nombre), la valeur minimale est 10 et la maximale est 50 (sauf indication contraire).

Exemple de requête :

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

Récupérer les journaux

Notre API vous permet de télécharger programmatiquement les journaux de votre compte. Soumettre une requête à ce point de terminaison traitera tous les journaux de votre compte et vous les enverra par email en pièce jointe (fichier tableur CSV compressé Gzip) une fois terminé.

Cela vous permet de créer des tâches en arrière-plan avec un Cron job ou en utilisant notre logiciel de planification de tâches Node.js Bree pour recevoir les journaux quand vous le souhaitez. Notez que ce point de terminaison est limité à 10 requêtes par jour.

La pièce jointe porte le nom en minuscules email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz et l’email contient un bref résumé des journaux récupérés. Vous pouvez également télécharger les journaux à tout moment depuis Mon Compte → Journaux

GET /v1/logs/download

Exemple de requête :

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

Exemple de Cron job (à minuit chaque jour) :

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

Notez que vous pouvez utiliser des services tels que Crontab.guru pour valider la syntaxe de votre expression cron.

Exemple de Cron job (à minuit chaque jour et avec les journaux du jour précédent) :

Pour 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

Pour Linux et 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

Créer un compte

POST /v1/account

Exemple de requête :

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

Récupérer un compte

GET /v1/account

Exemple de requête :

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

Mettre à jour un compte

PUT /v1/account

Exemple de requête :

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

Lister les contacts

GET /v1/contacts

Bientôt disponible

Créer un contact

POST /v1/contacts

Bientôt disponible

Récupérer un contact

GET /v1/contacts/:id

Bientôt disponible

Mettre à jour un contact

PUT /v1/contacts/:id

Bientôt disponible

Supprimer un contact

DELETE /v1/contacts/:id

Bientôt disponible

Lister les calendriers

GET /v1/calendars

Bientôt disponible

Créer un calendrier

POST /v1/calendars

Bientôt disponible

Récupérer un calendrier

GET /v1/calendars/:id

Bientôt disponible

Mettre à jour un calendrier

PUT /v1/calendars/:id

Bientôt disponible

Supprimer un calendrier

DELETE /v1/calendars/:id

Bientôt disponible

Veuillez vous assurer d’avoir suivi les instructions de configuration pour votre domaine.

Ces instructions se trouvent dans notre section FAQ Supportez-vous la réception d’emails avec IMAP ?.

Lister et rechercher des messages

GET /v1/messages

Bientôt disponible

Créer un message

POST /v1/messages

Bientôt disponible

Récupérer un message

GET /v1/messages/:id

Bientôt disponible

Mettre à jour un message

PUT /v1/messages/:id

Bientôt disponible

Supprimer un message

DELETE /v1/messages:id

Bientôt disponible

Lister les dossiers

GET /v1/folders

Bientôt disponible

Créer un dossier

POST /v1/folders

Bientôt disponible

Récupérer un dossier

GET /v1/folders/:id

Bientôt disponible

Mettre à jour un dossier

PUT /v1/folders/:id

Bientôt disponible

Supprimer un dossier

DELETE /v1/folders/:id

Bientôt disponible

Copier un dossier

POST /v1/folders/:id/copy

Bientôt disponible

Veuillez vous assurer d’avoir suivi les instructions de configuration pour votre domaine.

Ces instructions se trouvent à Mon Compte → Domaines → Paramètres → Configuration SMTP sortant. Vous devez vous assurer de la configuration de DKIM, Return-Path, et DMARC pour l’envoi SMTP sortant avec votre domaine.

Obtenir la limite d'emails SMTP sortants

Ceci est un point de terminaison simple qui renvoie un objet JSON contenant le count et la limit pour le nombre de messages SMTP sortants quotidiens par compte.

GET /v1/emails/limit

Exemple de requête :

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

Lister les emails SMTP sortants

Notez que ce point de terminaison ne renvoie pas les valeurs des propriétés pour le message, les headers, ni les rejectedErrors d'un email.

Pour retourner ces propriétés et leurs valeurs, veuillez utiliser le point de terminaison Récupérer un email avec un ID d'email.

GET /v1/emails

Exemple de requête :

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

Créer un email SMTP sortant

Notre API pour créer un email est inspirée et utilise la configuration des options de message de Nodemailer. Veuillez vous référer à la configuration des messages Nodemailer pour tous les paramètres du corps ci-dessous.

Notez qu'à l'exception de envelope et dkim (puisque nous les définissons automatiquement pour vous), nous supportons toutes les options Nodemailer. Nous définissons automatiquement les options disableFileAccess et disableUrlAccess à true pour des raisons de sécurité.

Vous devez soit passer l'option unique raw avec votre email complet brut incluant les en-têtes ou passer les options individuelles du corps ci-dessous.

Ce point de terminaison API encodera automatiquement les emojis pour vous s'ils sont trouvés dans les en-têtes (par exemple une ligne d'objet Subject: 🤓 Hello est automatiquement convertie en Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Notre objectif était de créer une API email extrêmement conviviale et à l'épreuve des erreurs pour les développeurs.

Authentification : Ce point de terminaison supporte à la fois l'authentification par token API et l'authentification par identifiants d'alias. Voir la section Authentification ci-dessus pour plus de détails.

POST /v1/emails

Exemple de requête (jeton 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=test" \
  -d "text=test"

Exemple de requête (identifiants 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=test" \
  -d "text=test"

Exemple de requête (email brut) :

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

Récupérer un email SMTP sortant

GET /v1/emails/:id

Exemple de requête :

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

Supprimer un email SMTP sortant

La suppression d’un email définira le statut à "rejected" (et ne le traitera donc plus dans la file d’attente) si et seulement si le statut actuel est l’un des suivants : "pending", "queued", ou "deferred". Nous pouvons purger automatiquement les emails après 30 jours suivant leur création et/ou envoi – vous devez donc conserver une copie des emails SMTP sortants dans votre client, base de données ou application. Vous pouvez référencer notre valeur d’ID d’email dans votre base de données si vous le souhaitez – cette valeur est retournée à la fois par les points d’accès Créer un email et Récupérer un email.

DELETE /v1/emails/:id

Exemple de requête :

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

Lister les domaines

GET /v1/domains

Exemple de requête :

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

Créer un domaine

POST /v1/domains

Exemple de requête :

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

Récupérer le domaine

GET /v1/domains/example.com

Exemple de requête :

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

Vérifier les enregistrements du domaine

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

Exemple de requête :

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

Vérifier les enregistrements SMTP du domaine

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

Exemple de requête :

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

Lister les mots de passe catch-all pour tout le domaine

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

Exemple de requête :

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

Créer un mot de passe catch-all pour tout le domaine

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

Exemple de requête :

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

Supprimer un mot de passe catch-all pour tout le domaine

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

Exemple de requête :

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

Mettre à jour le domaine

PUT /v1/domains/example.com

Exemple de requête :

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

Supprimer un domaine

DELETE /v1/domains/:domain_name

Exemple de requête :

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

Accepter une invitation de domaine

GET /v1/domains/:domain_name/invites

Exemple de requête :

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

Créer une invitation de domaine

POST /v1/domains/example.com/invites

Exemple de requête :

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

Supprimer une invitation de domaine

DELETE /v1/domains/:domain_name/invites

Exemple de requête :

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

Mettre à jour un membre du domaine

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

Exemple de requête :

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

Supprimer un membre du domaine

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

Exemple de requête :

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

Générer un mot de passe pour un alias

Notez que si vous n'envoyez pas les instructions par email, alors le nom d'utilisateur et le mot de passe seront dans le corps de la réponse JSON d'une requête réussie au format { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Exemple de requête :

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Lister les alias de domaine

GET /v1/domains/example.com/aliases

Exemple de requête :

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

Créer un nouvel alias de domaine

POST /v1/domains/example.com/aliases

Exemple de requête :

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

Récupérer un alias de domaine

Vous pouvez récupérer un alias de domaine soit par son id, soit par sa valeur name.

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

Exemple de requête :

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

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

Exemple de requête :

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

Mettre à jour un alias de domaine

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

Exemple de requête :

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

Supprimer un alias de domaine

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

Exemple de requête :

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

Nous vous permettons de chiffrer des enregistrements même avec le plan gratuit sans frais. La confidentialité ne devrait pas être une fonctionnalité, elle devrait être intrinsèquement intégrée à tous les aspects d’un produit. Très demandé dans une discussion Privacy Guides et sur nos issues GitHub, nous avons ajouté cela.

Chiffrer un enregistrement TXT

POST /v1/encrypt

Exemple de requête :

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