Aller au contenu
adaptmailAPI
Français

Envoyer une lettre

API 0.16.0OpenAPIllms-full.txt
POST/v1/mailboxes/{mailbox_id}/send

Obligatoire Idempotency-Key 8 à 128 caractères. Répéter avec la même clé et le même corps renvoie la même opération ; un autre organisme donne 409. HTTP 202 signifie faire la queue. Vérifiez l'état de l'opération, et non le fait qu'une réponse a été reçue.

Zones d’autorisation et d’accès · Erreurs et répétitions

Demande

Fenêtre de terminal
curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/send' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"to":["[email protected]"],"subject":"Hello","text":"A message from Adapt Mail"}'

Possibilités

mailbox_idpathNécessairement

integer

X-Customer-IDheader
Option 1

string

Option 2

null

Idempotency-KeyheaderNécessairement

string

minLength: 8

maxLength: 128

Corps de la demande · application/json

object

toNécessairement

array

Adresses des principaux destinataires.

minItems: 1

maxItems: 50

Éléments du tableau

string

cc

array

Copiez les adresses des destinataires visibles par les autres participants.

maxItems: 50

Éléments du tableau

string

bcc

array

Adresses des destinataires en Cci.

maxItems: 50

Éléments du tableau

string

subject

string

Objet de la lettre.

Défaut: ""

maxLength: 998

text

string

Le texte de la lettre sans mise en forme.

Défaut: ""

maxLength: 200000

html

Version au format HTML- de la lettre.

Option 1

string

maxLength: 300000

Option 2

null

file_ids

array

ID fichiers précédemment téléchargés dans cette boîte aux lettres. Récupérez-les lors du téléchargement ou depuis la liste des fichiers.

maxItems: 20

Éléments du tableau

string · uuid

forward_message

L'e-mail d'origine dont les pièces jointes doivent être transférées.

Option 1

object

folderNécessairement

string

Nom du dossier dans la liste des dossiers, par exemple INBOX.

minLength: 1

maxLength: 255

uidvalidityNécessairement

integer

La valeur est uidvalidity de la réponse API pour ce dossier.

exclusiveMinimum: 0

uidNécessairement

integer

exclusiveMinimum: 0

Les champs inconnus ne sont pas acceptés.

Option 2

null

reply_to_message_id

La valeur message_id de l'e-mail auquel vous répondez.

Option 1

string

maxLength: 998

Option 2

null

references

La valeur references du message d'origine pour enregistrer la chaîne de réponse.

Option 1

string

maxLength: 4000

Option 2

null

send_at

Heure d'envoi différé avec fuseau horaire, par exemple 2026-11-01T12:00:00Z. Sans valeur, l'envoi commence au fur et à mesure du traitement de la file d'attente.

Option 1

string · date-time

Option 2

null

Les champs inconnus ne sont pas acceptés.

Réponses

202 Réponse réussie

application/json

object

id

string · uuid

ID d'opération pour vérifier le statut et annuler une soumission en attente.

kind

string

mailbox_id
Option 1

integer

Option 2

null

status

string

Valeurs valides: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

created_at

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

completed_at
Option 1

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

Option 2

null

error

La raison de l'erreur si l'opération n'a pas abouti.

Option 1

string

Option 2

null

result

Le résultat de l'opération. Pour l'envoi, contient des informations sur les destinataires acceptés et rejetés.

Option 1

object

Option 2

null

400 En-tête ou identifiant invalide

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

401 Connexion requise

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

403 Pas d'accès

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

404 Ressource introuvable

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

409 Conflit d'État

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

413 Taille dépassée

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

422 Erreur de validation

application/json

object

detail

array

Éléments du tableau

object

locNécessairement

array

Éléments du tableau
Option 1

string

Option 2

integer

msgNécessairement

string

typeNécessairement

string

503 Indisponibilité temporaire

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

Résultat de soumission réussi

Les champs result de l'opération sont après l'exécution, pas la réponse à la mise en file d'attente.

object

message_id

string

smtp_accepted

boolean

sent_saved

boolean

accepted_recipients

array

Éléments du tableau

string

rejected_recipients

array

Éléments du tableau

object

email

string

code

integer