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 entête. Ne vous inquiétez pas, des exemples sont fournis ci-dessous pour vous si vous n'êtes pas sûr de ce dont il s'agit.

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

Si vous souhaitez être averti lorsque la pagination est disponible, veuillez envoyer un e-mail api@forwardemail.net.

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"

Veuillez vous assurer que vous avez suivi les instructions de configuration de votre domaine. Ces instructions peuvent être trouvées sur 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.

Liste des e-mails

Notez que ce point de terminaison ne renvoie pas l'e-mail déjà créé message, headers, accepted, ni rejectedErrors propriétés.

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.

Ce point de terminaison renverra au maximum 50 résultats à la fois. Si vous souhaitez interroger plusieurs pages, ajoutez ?page=NUMBER où NUMBER est un entier, par ex. ?page=1.

GET /v1/emails

Exemple de demande :

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

Créer un e-mail

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.

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 l'e-mail

GET /v1/emails/:id

Exemple de demande :

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

Supprimer l'e-mail

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:

Lister les domaines

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

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:

Répertorier les alias de domaine

GET /v1/domains/example.com/aliases

Exemple de demande :

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