API de messagerie

À l'heure actuelle, nous n'avons pas encore publié de wrappers d'API, mais nous prévoyons de le faire dans un proche avenir. 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 terminaux 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 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 différentes. Tous les messages de réponse de l'API sont traduits dans les derniers paramètres régionaux détectés de l'utilisateur effectuant la demande d'API. Vous pouvez remplacer cela en passant un personnalisé Accept-Language entête. N'hésitez pas à l'essayer en utilisant la liste déroulante 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.

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 se trouvent sur Mon compte → Domaines → Paramètres → Configuration SMTP sortant. Vous devez vous assurer de la configuration de DKIM, Return-Path et DMARC pour l'envoi de SMTP sortant avec votre domaine.

Lister les e-mails

Notez que ce point de terminaison ne renvoie pas un 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 de terminaison 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 pour créer un e-mail s'inspire et exploite la configuration des options de message de Nodemailer. Veuillez vous reporter au Configuration des messages Nodemailer pour tous les paramètres corporels ci-dessous.

A noter 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 complet brut, y compris les en-têtes ou passez 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 des e-mails définira le statut sur "rejected" (et par la suite ne pas le traiter 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. Par conséquent, vous devez 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 valeur d'identifiant de messagerie dans votre base de données si vous le souhaitez - cette valeur est renvoyée à la fois par Créer un e-mail et Récupérer l'e-mail points de terminaison.

DELETE /v1/emails/:id

Exemple de demande:

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

Répertorier 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 un 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 un 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 au 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 au 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 le 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 de domaine

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

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: