API de messagerie

Nous n'avons pas encore publié de wrappers d'API, mais nous prévoyons de le faire prochainement. Envoyez un e-mail à api@forwardemail.net si vous souhaitez être informé de la sortie du wrapper d'API d'un langage de programmation spécifique. En attendant, vous pouvez utiliser les bibliothèques de requêtes HTTP recommandées dans votre application, ou simplement utiliser boucle comme dans les exemples ci-dessous.

Le chemin URI de base HTTP actuel est : https://api.forwardemail.net.

Tous les points de terminaison nécessitent que votre clé API soit défini comme valeur « nom d'utilisateur » de l'en-tête Autorisation de base de la requête (à l'exception de Contacts d'alias, Calendriers d'alias et Boîtes aux lettres d'alias qui utilisent un nom d'utilisateur et mot de passe d'alias générés).

Ne vous inquiétez pas, des exemples sont fournis ci-dessous si vous n'êtes pas sûr de ce que c'est.

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

Notre service est traduit dans plus de 25 langues. Tous les messages de réponse API sont traduits dans la dernière langue détectée de l'utilisateur effectuant la requête API. Vous pouvez contourner ce problème en ajoutant un en-tête Accept-Language personnalisé. N'hésitez pas à l'essayer en utilisant le menu déroulant des langues en bas de cette page.

La pagination est prise en charge par tous les points de terminaison d'API qui répertorient les résultats.

Fournissez simplement 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 indiquez limit (également un nombre), la valeur minimale est 10 et la valeur maximale est 50 (sauf indication contraire).

Afin de déterminer si davantage de résultats sont disponibles ou non, nous fournissons ces en-têtes de réponse HTTP (que vous pouvez analyser afin de paginer par programmation) :

Exemple de requête :

curl https://api.forwardemail.net/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 les journaux de votre compte par programmation. En soumettant une requête à ce point de terminaison, tous les journaux de votre compte seront traités et vous seront envoyés par e-mail sous forme de pièce jointe (fichier tableur compressé Gzip et CSV).

Cela vous permet de créer des tâches d'arrière-plan avec un Tâche cron ou d'utiliser notre Logiciel de planification de tâches Node.js Bree pour recevoir les journaux à tout moment. Notez que ce point de terminaison est limité à 10 requêtes par jour.

La pièce jointe est la forme minuscule de email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz et l'e-mail 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://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

Exemple de tâche Cron (à minuit tous les jours) :

0 0 * * * /usr/bin/curl https://api.forwardemail.net/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 de tâche cron.

Exemple de tâche Cron (à minuit tous les jours et avec les journaux du jour précédent) :

Pour 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

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

Créer un compte

POST /v1/account

Exemple de requête :

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

Récupérer le compte

GET /v1/account

Exemple de requête :

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

Mettre à jour le compte

PUT /v1/account

Exemple de requête :

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

Liste des contacts

GET /v1/contacts

À venir

Créer un contact

POST /v1/contacts

À venir

Récupérer le contact

GET /v1/contacts/:id

À venir

Mettre à jour le contact

PUT /v1/contacts/:id

À venir

Supprimer le contact

DELETE /v1/contacts/:id

À venir

Liste des calendriers

GET /v1/calendars

À venir

Créer un calendrier

POST /v1/calendars

À venir

Récupérer le calendrier

GET /v1/calendars/:id

À venir

Mettre à jour le calendrier

PUT /v1/calendars/:id

À venir

Supprimer le calendrier

DELETE /v1/calendars/:id

À venir

Veuillez vous assurer que vous avez suivi les instructions de configuration de votre domaine.

Ces instructions peuvent être trouvées dans notre section FAQ Prenez-vous en charge la réception d'e-mails avec IMAP ?.

Lister et rechercher des messages

GET /v1/messages

À venir

Créer un message

POST /v1/messages

À venir

Récupérer le message

GET /v1/messages/:id

À venir

Message de mise à jour

PUT /v1/messages/:id

À venir

Supprimer le message

DELETE /v1/messages:id

À venir

Liste des dossiers

GET /v1/folders

À venir

Créer le dossier

POST /v1/folders

À venir

Récupérer le dossier

GET /v1/folders/:id

À venir

Mettre à jour le dossier

PUT /v1/folders/:id

À venir

Supprimer le dossier

DELETE /v1/folders/:id

À venir

Copier le dossier

POST /v1/folders/:id/copy

À venir

Veuillez vous assurer que vous avez suivi les instructions de configuration de votre domaine.

Ces instructions se trouvent dans Mon compte → Domaines → Paramètres → Configuration SMTP sortante. Vous devez configurer DKIM, Return-Path et DMARC pour l'envoi de messages SMTP sortants avec votre domaine.

Obtenir la limite d'e-mails SMTP sortants

Il s'agit d'un point de terminaison simple qui renvoie un objet JSON contenant count et limit pour le nombre de messages SMTP sortants quotidiens par compte.

GET /v1/emails/limit

Exemple de requête :

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

Liste des e-mails SMTP sortants

Notez que ce point de terminaison ne renvoie pas de valeurs de propriété pour message, headers ni rejectedErrors d'un e-mail.

Pour renvoyer ces propriétés et leurs valeurs, veuillez utiliser le point de terminaison Récupérer l'e-mail avec un identifiant de messagerie.

GET /v1/emails

Exemple de requête :

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

Créer un e-mail SMTP sortant

Notre API de création d'e-mails s'inspire et exploite la configuration des options de message de Nodemailer. Veuillez vous référer à Configuration des messages Nodemailer pour tous les paramètres de corps ci-dessous.

Notez qu'à l'exception de envelope et dkim (que nous définissons automatiquement), nous prenons en charge toutes les options Nodemailer. Pour des raisons de sécurité, nous définissons automatiquement les options disableFileAccess et disableUrlAccess sur true.

Vous devez soit transmettre l'option unique raw avec votre e-mail complet brut, y compris les en-têtes ou transmettre les options de paramètres de corps individuelles ci-dessous.

Ce point de terminaison d'API encodera automatiquement les émojis présents 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 de messagerie extrêmement conviviale pour les développeurs et à l'épreuve des manipulations.

POST /v1/emails

Exemple de requête :

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"

Exemple de requête :

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

Récupérer les e-mails SMTP sortants

GET /v1/emails/:id

Exemple de requête :

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

Supprimer l'e-mail SMTP sortant

La suppression d'un e-mail définira son statut sur "rejected" (et ne le traitera donc pas dans la file d'attente) si et seulement si son statut actuel est "pending", "queued" ou "deferred". Nous pouvons supprimer automatiquement les e-mails 30 jours après leur création et/ou leur envoi ; il est donc conseillé de conserver une copie des e-mails SMTP sortants dans votre client, votre base de données ou votre application. Vous pouvez référencer notre identifiant d'e-mail dans votre base de données si vous le souhaitez ; cette valeur est renvoyée par les points de terminaison Créer un e-mail et Récupérer l'e-mail.

DELETE /v1/emails/:id

Exemple de requête :

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

Liste des domaines

GET /v1/domains

Exemple de requête :

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

Créer un domaine

POST /v1/domains

Exemple de requête :

curl -X POST https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Vérifier les enregistrements de domaine

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

Exemple de requête :

curl https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Liste des mots de passe fourre-tout à l'échelle du domaine

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

Exemple de requête :

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

Créer un mot de passe fourre-tout à l'échelle du 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 le mot de passe fourre-tout à l'échelle du domaine

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

Exemple de requête :

curl -X DELETE https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Supprimer le domaine

DELETE /v1/domains/:domain_name

Exemple de requête :

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

Accepter l'invitation de domaine

GET /v1/domains/:domain_name/invites

Exemple de requête :

curl https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Supprimer l'invitation de domaine

DELETE /v1/domains/:domain_name/invites

Exemple de requête :

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

Mettre à jour le membre du domaine

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

Exemple de requête :

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

Supprimer le membre du domaine

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

Exemple de requête :

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

Générer un mot de passe d'alias

Notez que si vous n'envoyez pas d'instructions par e-mail, le nom d'utilisateur et le mot de passe figureront dans le corps de la réponse JSON d'une demande 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://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Liste des alias de domaine

GET /v1/domains/example.com/aliases

Exemple de requête :

curl https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Récupérer l'alias de domaine

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

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

Exemple de requête :

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

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

Exemple de requête :

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

Mettre à jour l'alias de domaine

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

Exemple de requête :

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

Supprimer l'alias de domaine

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

Exemple de requête :

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

Nous vous permettons de chiffrer vos enregistrements gratuitement, même avec l'offre gratuite. La confidentialité ne devrait pas être une fonctionnalité, mais être intégrée à tous les aspects d'un produit. Suite à une forte demande pour Discussion sur les guides de confidentialité et nos problèmes GitHub, nous avons ajouté cette fonctionnalité.

Chiffrer l'enregistrement TXT

POST /v1/encrypt

Exemple de requête :

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