Aller au contenu
Maildocs
Sommaire de la documentation

Documentation › Outils › remove_domain

remove_domain

Voir en .md

Retire un domaine de l’espace : plus aucune boîte ne s’y crée, et le serveur de messagerie cesse de recevoir son courrier.

En bref

PropriétéValeur
TitreRetirer un domaine
Outil MCPremove_domain, sur https://api.subagent.fr/mcp
Appelé parl’assistant et la vue
Appel HTTPPOST https://api.subagent.fr/v1/remove_domain
Accèspermission manage_inboxes
État de l’espacevérifié : sinon, refus space_unverified
Effetécriture, irréversible : confirm doit valoir true
Vue dans l’assistantnon

Ce que fait l’outil

Le serveur décrit l’outil ainsi à l’agent qui se branche :

Retire un domaine de l’espace : plus aucune boîte ne s’y crée, et le serveur de messagerie cesse de recevoir son courrier. À faire avant de pointer le MX du domaine ailleurs. Refusé tant qu’une boîte de l’espace vit sur ce domaine (supprimez-les d’abord). Pensez ensuite à retirer ses enregistrements de votre DNS. Irréversible : passer confirm = true ; le réenregistrer donnera de nouvelles clés DKIM.

Paramètres

remove_domain accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.

ParamètreTypeObligatoireDescription
domaintexteouiLe domaine à retirer (voir list_domains).
confirmbooléenouiDoit valoir true : le retrait est irréversible.

Résultat

L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.

ChampTypeContenu
remote_domain_removedbooléenLe domaine a été retiré du serveur de messagerie.
removedtexteLe domaine retiré.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/remove_domain \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "agents.exemple.fr",
  "confirm": true
}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_domain",
    "arguments": {
      "domain": "agents.exemple.fr",
      "confirm": true
    }
  }
}

Refus possibles

CodeHTTPCe qui s’est passéQue faire
space_unverified403L’espace n’est pas vérifié : ses boîtes reçoivent, mais n’envoient pas.Demander à l’humain le code à 6 chiffres, puis appeler verify. S’il n’a rien reçu, ou si aucun e-mail n’est rattaché à l’espace : attach_human.
not_found404L’objet n’existe pas pour cette clé.Vérifier l’identifiant : il vient de list_inboxes, list_threads, get_thread ou list_drafts.
domain_in_use409Des boîtes de l’espace vivent encore sur le domaine à retirer.Supprimer d’abord ces boîtes avec delete_inbox.
provisioning_failed502Le serveur de messagerie n’a pas créé la boîte, n’a pas pris le domaine, ou n’a pas traité un mot de passe d’application.Réessayer dans un instant. Rien n’est perdu.

S’y ajoutent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.

Voir aussi