API Mailera

Introduction

Tous les points de terminaison partagent une URL de base et acceptent et renvoient du JSON.

1. 1Créez un compte et votre propre espace de travail (gratuit).
2. 2Ouvrez Paramètres → API keys, créez une clé et choisissez ses autorisations.
3. 3Transmettez la clé dans l’en-tête X-API-Key à chaque requête.

Les réponses réussies contiennent un champ data; les erreurs contiennent un champ error avec code et message.

Authentification

Transmettez votre API key dans l’en-tête X-API-Key. Les clés commencent par mh_live_ et ne sont affichées qu’une fois, à leur création; si vous en perdez une, créez-en une nouvelle et révoquez l’ancienne.

Un en-tête Authorization avec un token Bearer contenant la même clé est également accepté.

Les clés peuvent être limitées à une liste d’IP autorisées; les appels provenant d’autres IP reçoivent une erreur 403.

Limites et pagination

Chaque clé autorise 300 requêtes par minute. Tout dépassement renvoie 429 avec un en-tête Retry-After.

Les listes renvoient next_cursor; transmettez cette valeur dans le paramètre cursor pour obtenir la page suivante. S’il n’y a plus de données, next_cursor vaut null.

Le paramètre limit définit la taille des pages.

Boîtes aux lettres

Ajoutez, vérifiez, synchronisez, suspendez et supprimez des boîtes aux lettres.

• GET/mailboxes

  Lister les boîtes aux lettres

  Autorisation:

  read

  Paramètres de requête:

  status, q, cursor, limit

• POST/mailboxes/import

  Importer des boîtes aux lettres en masse (email:password:refresh_token:client_id, ou séparées par |)

  Autorisation:

  import

  Corps:

  lines, text, group_id, duplicate_mode

• GET/mailboxes/import

  Progression de l’import et résultats par ligne

  Autorisation:

  import

  Paramètres de requête:

  job_id

• GET/mailboxes/{id}

  Détails de la boîte aux lettres et compteurs des dossiers

  Autorisation:

  read

• PATCH/mailboxes/{id}

  Suspendre ou réactiver une boîte aux lettres

  Autorisation:

  manage

  Corps:

  action (obligatoire)

• DELETE/mailboxes/{id}

  Supprimer une boîte aux lettres

  Autorisation:

  manage

• GET/mailboxes/{id}/status

  Vérifier en direct auprès de Microsoft si la boîte aux lettres fonctionne toujours

  Autorisation:

  read

• POST/mailboxes/{id}/sync

  Synchronisez maintenant

  Autorisation:

  sync

  Corps:

  wait

Messages

Lisez, recherchez et envoyez des messages, et récupérez des codes OTP.

• GET/mailboxes/{id}/messages

  Lister les messages d’un dossier

  Autorisation:

  read

  Paramètres de requête:

  folder, unread, cursor, limit

• GET/mailboxes/{id}/messages/{msgId}

  Récupérer un message avec son contenu

  Autorisation:

  read

• GET/mailboxes/{id}/otp

  Récupérer le dernier code OTP

  Autorisation:

  read

  Paramètres de requête:

  from, subject, since_minutes

• POST/mailboxes/{id}/send

  Envoyer, répondre ou transférer

  Autorisation:

  send

  Corps:

  to, cc, bcc, subject, html, text, importance, reply_to_message_id, mode, attachments

• GET/messages/search

  Rechercher des messages dans toutes les boîtes aux lettres

  Autorisation:

  read

  Paramètres de requête:

  q, folder, limit

Courrier indésirable

Vérifiez l’emplacement des messages (Boîte de réception/Courrier indésirable) et sortez-les du Courrier indésirable.

• POST/mailboxes/{id}/messages/{msgId}/move

  Déplacer un message (par exemple du Courrier indésirable vers la Boîte de réception)

  Autorisation:

  move

  Corps:

  destination (obligatoire)

• POST/mailboxes/{id}/unspam

  Sortir tous les messages, ou ceux d’un expéditeur, du Courrier indésirable

  Autorisation:

  move

  Corps:

  filter

• GET/mailboxes/{id}/placement

  Savoir si le message est arrivé dans la Boîte de réception ou le Courrier indésirable

  Autorisation:

  read

  Paramètres de requête:

  from, subject, since_minutes

Webhooks

Enregistrez des URL pour recevoir des événements.

Pour chaque événement, Mailera envoie une requête POST en JSON à votre URL. Si votre point de terminaison renvoie une erreur ou ne répond pas, Mailera réessaie avec des délais croissants.

Pour vérifier la signature, calculez le HMAC-SHA256 de l’horodatage suivi d’un point et du corps avec le secret du webhook, puis comparez-le à l’en-tête de signature.

En-têtes envoyés: X-MailHub-Event X-MailHub-Delivery X-MailHub-Timestamp X-MailHub-Signature

• GET/webhooks

  Lister les webhooks

  Autorisation:

  webhooks

• POST/webhooks

  Créer un webhook (le secret de signature n’est renvoyé qu’une fois)

  Autorisation:

  webhooks

  Corps:

  url (obligatoire), events, group_id

• PATCH/webhooks/{id}

  Activer/désactiver un webhook ou modifier ses événements ou son URL

  Autorisation:

  webhooks

• DELETE/webhooks/{id}

  Supprimer un webhook

  Autorisation:

  webhooks