Boîtes aux lettres

La boîte du réseau de messagerie SESAM-Vitale d’un praticien, par où partent ses fichiers et arrivent ses retours.

Le cycle de vie et les pièges : Boîtes aux lettres.

Routes

Route	Effet
`GET /v1/practitioners/{practitioner}/mailbox`	Lire la boîte aux lettres d’un praticien
`POST /v1/practitioners/{practitioner}/mailbox`	Régler la boîte aux lettres d’un praticien
`POST /v1/practitioners/{practitioner}/mailbox/verify`	Vérifier la boîte aux lettres d’un praticien
`DELETE /v1/practitioners/{practitioner}/mailbox`	Retirer la boîte aux lettres d’un praticien

L’objet

idtexte
L'identifiant de l'objet, préfixé par son type.
objecttexte
Le nom du type d'objet.
practitionertexteou null
addresstexte
L'adresse de la boîte, expéditrice des fichiers du praticien et destinataire de ses retours.
usernametexte
L'identifiant de connexion, commun à l'envoi et au relevé. Le secret ne se relit jamais.
smtpobjet
L'envoi, en SMTP.
Champs de smtp
- hosttexteobligatoire
- portentierobligatoire
- securityénumérationobligatoire
  tls, starttls, ou none, refusé hors d'un poste de développement.
  tlsstarttlsnone
retrievalobjet
Le relevé, en IMAP ou en POP3.
Champs de retrieval
- protocolénumérationobligatoire
  imappop3
- hosttexteobligatoire
- portentierobligatoire
- securityénumérationobligatoire
  tlsstarttlsnone
verified_atentierou null
La dernière vérification réussie de l'envoi et du relevé.
last_fetched_atentierou null
Le dernier relevé réussi. Les boîtes se relèvent toutes les cinq minutes.
last_error_codetexteou null
La dernière erreur de connexion, d'envoi ou de relevé, effacée au succès suivant : mailbox_unreachable, authentication_failed, tls_failed…
last_error_atentierou null
set_aside_countentier
Les messages relevés mis de côté : inconnus, d'un autre mode, ou sans organisation sûre. Ils restent dans la boîte.
livemodebooléen
true en production, false en mode test.
createdentierou null
La création de l'objet, en secondes Unix.

L'objet


{
  "id": "obj_…",
  "object": "mailbox",
  "practitioner": null,
  "address": "…",
  "username": "…",
  "smtp": {
    "host": "…",
    "port": 0,
    "security": "tls"
  },
  "retrieval": {
    "protocol": "imap",
    "host": "…",
    "port": 0,
    "security": "tls"
  },
  "verified_at": null,
  "last_fetched_at": null,
  "last_error_code": null,
  "last_error_at": null,
  "set_aside_count": 0,
  "livemode": false,
  "created": 1793970000
}