Régler la boîte aux lettres d’un praticien

POST/v1/practitioners/{practitioner}/mailbox

Crée ou remplace la boîte du réseau de messagerie SESAM-Vitale par où partent ses fichiers et arrivent ses retours. Le secret ne se relit jamais ; absent, l’ancien reste. En mode test, elle ne sert qu’aux lots signés avec de vraies cartes de test.

Droit de clé restreinte : practitioners:write.

Paramètres de chemin

practitionertexteobligatoire
L'identifiant, prac_….

Corps de la requête

addresstexteobligatoire
L'adresse de la boîte, telle que l'opérateur de messagerie l'a donnée.
usernametexteobligatoire
L'identifiant de connexion, commun à l'envoi et au relevé.
passwordtexteobligatoire
Le secret de connexion. Facultatif pour modifier une boîte : l'ancien reste. Il ne se relit jamais.
smtpobjetobligatoire
Champs de smtp
- hosttexteobligatoire
  Le serveur d'envoi.
- portentierobligatoire
- securityénumérationobligatoire
  tls (port 465), starttls (port 587), ou none, refusé hors d'un poste de développement.
  tlsstarttlsnone
retrievalobjetobligatoire
Champs de retrieval
- protocolénumérationobligatoire
  imap ou pop3.
  imappop3
- hosttexteobligatoire
  Le serveur de relevé.
- portentierobligatoire
- securityénumérationobligatoire
  tlsstarttlsnone

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend l’objet boîtes aux lettres.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/practitioners/prac_…/mailbox \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "dr.martin@exemple-messagerie.fr",
    "username": "dr.martin",
    "password": "secret-de-la-boite",
    "smtp": {
      "host": "smtp.exemple-messagerie.fr",
      "port": 465,
      "security": "tls"
    },
    "retrieval": {
      "protocol": "imap",
      "host": "imap.exemple-messagerie.fr",
      "port": 993,
      "security": "tls"
    }
  }'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/practitioners/prac_…/mailbox', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'address' => 'dr.martin@exemple-messagerie.fr',
        'username' => 'dr.martin',
        'password' => 'secret-de-la-boite',
        'smtp' => [
            'host' => 'smtp.exemple-messagerie.fr',
            'port' => 465,
            'security' => 'tls',
        ],
        'retrieval' => [
            'protocol' => 'imap',
            'host' => 'imap.exemple-messagerie.fr',
            'port' => 993,
            'security' => 'tls',
        ],
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/practitioners/prac_…/mailbox', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    address: 'dr.martin@exemple-messagerie.fr',
    username: 'dr.martin',
    password: 'secret-de-la-boite',
    smtp: {
      host: 'smtp.exemple-messagerie.fr',
      port: 465,
      security: 'tls'
    },
    retrieval: {
      protocol: 'imap',
      host: 'imap.exemple-messagerie.fr',
      port: 993,
      security: 'tls'
    }
  }),
})
const object = await response.json()

Réponse 200


{
  "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
}