API de messagerie

Pour l’instant, nous n’avons pas encore publié de wrappers d’API, mais nous prévoyons de le faire dans un avenir proche. Envoyer un courriel à api@forwardemail.net si vous souhaitez être averti lorsque le wrapper API d'un langage de programmation particulier est publié. En attendant, vous pouvez utiliser ces 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 votre Clé API à définir comme valeur "nom d'utilisateur" de la requête Autorisation de base en-tê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é.

[!TIP] Si vous recevez un code d'état 5xx (ce qui ne devrait pas arriver), veuillez nous contacter à l'adresse api@forwardemail.net et nous vous aiderons à résoudre votre problème immédiatement.

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

[!NOTE] À compter du 1er novembre 2024, les points de terminaison de l'API pour Lister les domaines et Répertorier les alias de domaine sera par défaut 1000 max résultats par page. Si vous souhaitez accepter ce comportement plus tôt, vous pouvez passer ?paginate=true en tant que paramètre de chaîne de requête supplémentaire à l'URL pour la requête de point de terminaison.

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 la 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), alors la valeur minimale est 10 et le maximum 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 demande :

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 par programme de télécharger des journaux pour votre compte. La soumission d'une demande à ce point de terminaison traitera tous les journaux de votre compte et vous les enverra par courrier électronique en pièce jointe (Gzip comprimé CSV fichier de feuille de calcul) une fois terminé.

Cela vous permet de créer des tâches en arrière-plan avec un Tâche planifiée ou en utilisant notre Logiciel de planification de tâches Node.js Bree pour recevoir des journaux quand vous le souhaitez. Notez que ce point de terminaison est limité à 10 demandes 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 lui-même 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 demande :

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 de la veille):

Pour 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

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

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

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

Compte mis à jour

PUT /v1/account

Exemple de demande :

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

[!NOTE] Contrairement aux autres points de terminaison d'API, ceux-ci nécessitent Authentification « nom d'utilisateur » égal au nom d'utilisateur de l'alias et « mot de passe » égal au mot de passe généré par l'alias comme en-têtes d'autorisation de base.

[!AVERTISSEMENT] Cette section relative aux points de terminaison est en cours de développement et sera disponible (espérons-le) en 2024. En attendant, veuillez utiliser un client IMAP disponible dans le menu déroulant « Applications » de notre site web.

[!NOTE] Le support CardDAV n'est pas encore disponible, suivez cette discussion sur GitHub pour les mises à jour.

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

Mise à jour des contacts

PUT /v1/contacts/:id

À venir

Supprimer le contact

DELETE /v1/contacts/:id

À venir

[!NOTE] Contrairement aux autres points de terminaison d'API, ceux-ci nécessitent Authentification « nom d'utilisateur » égal au nom d'utilisateur de l'alias et « mot de passe » égal au mot de passe généré par l'alias comme en-têtes d'autorisation de base.

[!AVERTISSEMENT] Cette section relative aux points de terminaison est en cours de développement et sera disponible (espérons-le) en 2024. En attendant, veuillez utiliser un client IMAP disponible dans le menu déroulant « Applications » de notre site web.

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

Calendrier de mise à jour

PUT /v1/calendars/:id

À venir

Supprimer le calendrier

DELETE /v1/calendars/:id

À venir

[!NOTE] Contrairement aux autres points de terminaison d'API, ceux-ci nécessitent Authentification « nom d'utilisateur » égal au nom d'utilisateur de l'alias et « mot de passe » égal au mot de passe généré par l'alias comme en-têtes d'autorisation de base.

[!AVERTISSEMENT] Cette section relative aux points de terminaison est en cours de développement et sera disponible (espérons-le) en 2024. En attendant, veuillez utiliser un client IMAP disponible dans le menu déroulant « Applications » de notre site web.

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

[!NOTE] Cela NOT envoyer un e-mail – cela ajoutera simplement le message à votre dossier de boîte aux lettres (par exemple, cela est similaire au protocole IMAP) APPEND commande). Si vous souhaitez envoyer un e-mail, consultez Créer un e-mail SMTP sortant ci-dessous. Après avoir créé l'e-mail SMTP sortant, vous pouvez en ajouter une copie à l'aide de ce point de terminaison dans la boîte aux lettres de votre alias à des fins de stockage.

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

[!TIP] Points de terminaison de dossier avec le chemin d'accès d'un dossier /v1/folders/:path car leur point de terminaison est interchangeable avec l'ID d'un dossier :id. Cela signifie que vous pouvez faire référence au dossier soit par son path ou id valeur.

[!AVERTISSEMENT] Cette section relative aux points de terminaison est en cours de développement et sera disponible (espérons-le) en 2024. En attendant, veuillez utiliser un client IMAP disponible dans le menu déroulant « Applications » de notre site web.

Liste des dossiers

GET /v1/folders

À venir

Créer un 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 peuvent être trouvées à l'adresse Mon compte → Domaines → Paramètres → Configuration SMTP sortante. Vous devez assurer la configuration de DKIM, Return-Path et DMARC pour l'envoi de SMTP sortant avec votre domaine.

Obtenir la limite des e-mails SMTP sortants

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

GET /v1/emails/limit

Exemple de demande :

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

Lister les e-mails SMTP sortants

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

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

GET /v1/emails

Exemple de demande :

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-mail s'inspire et exploite la configuration des options de message de Nodemailer. Veuillez vous en remettre au Configuration des messages Nodemailer pour tous les paramètres corporels ci-dessous.

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

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

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

POST /v1/emails

Exemple de demande :

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

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

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

Supprimer les e-mails SMTP sortants

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

DELETE /v1/emails/:id

Exemple de demande :

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

[!TIP] Points de terminaison de domaine avec un nom de domaine /v1/domains/:domain_name car leur point de terminaison est interchangeable avec l'ID d'un domaine :domain_id. Cela signifie que vous pouvez faire référence au domaine soit par son name ou id valeur.

Lister les domaines

[!NOTE] À compter du 1er novembre 2024, les points de terminaison de l'API pour Lister les domaines et Répertorier les alias de domaine sera par défaut 1000 max résultats par page. Si vous souhaitez accepter ce comportement plus tôt, vous pouvez passer ?paginate=true en tant que paramètre de chaîne de requête supplémentaire à l'URL pour la requête du point de terminaison. Voir Pagination pour plus d'informations.

GET /v1/domains

Exemple de demande :

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

Créer un domaine

POST /v1/domains

Exemple de demande :

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

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

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

Mettre à jour le domaine

PUT /v1/domains/example.com

Exemple de demande :

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

Supprimer le domaine

DELETE /v1/domains/:domain_name

Exemple de demande :

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

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

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

[!IMPORTANT] Si l'utilisateur invité est déjà membre d'un autre domaine dont l'administrateur l'invite est membre, l'invitation sera automatiquement acceptée et aucun e-mail ne sera envoyé.

Supprimer l'invitation de domaine

DELETE /v1/domains/:domain_name/invites

Exemple de demande :

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

curl -X PUT https://api.forwardemail.net/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 demande :

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

Générer un alias de mot de passe

Notez que si vous n'envoyez pas d'instructions par courrier électronique, le nom d'utilisateur et le mot de passe figureront dans le corps de 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 demande :

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

Répertorier les alias de domaine

[!NOTE] À compter du 1er novembre 2024, les points de terminaison de l'API pour Lister les domaines et Répertorier les alias de domaine sera par défaut 1000 max résultats par page. Si vous souhaitez accepter ce comportement plus tôt, vous pouvez passer ?paginate=true en tant que paramètre de chaîne de requête supplémentaire à l'URL pour la requête du point de terminaison. Voir Pagination pour plus d'informations.

GET /v1/domains/example.com/aliases

Exemple de demande :

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

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

Récupérer l'alias du domaine

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

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

Exemple de demande :

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

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

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

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

Nous vous permettons de crypter des enregistrements, même avec le forfait gratuit, sans frais. La confidentialité ne doit pas être une fonctionnalité, elle doit être intrinsèquement intégrée à tous les aspects d’un produit. Comme fortement demandé dans un Discussion sur les guides de confidentialité et sur nos problèmes GitHub nous avons ajouté ceci.

Chiffrer l'enregistrement TXT

POST /v1/encrypt

Exemple de demande :

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