Configure Email

Configure email (AgentMail): create or verify domains, create or delete inboxes, check domain existence, get domain info or DNS zone file. Required: action. Then provide the params for that action (e.g. domain and feedback_enabled for create_domain; username and domain for create_inbox; inbox_id for delete_inbox; domain_id or domain for verify_domain, get_domain_info, get_zone_file, check_domain_exists).

Input Schema

Parameter	Type	Description
action	string	One of: create_domain (add a domain for sending), create_inbox (create email inbox for a domain), delete_inbox (remove an inbox), verify_domain (trigger DNS verification), check_domain_exists (check if domain is registered), get_domain_info (get domain status and DNS records), get_zone_file (get DNS zone file content). Enum: create_domain, create_inbox, delete_inbox, verify_domain, check_domain_exists, get_domain_info, get_zone_file
domain	string	Domain name. Used by create_domain, create_inbox, check_domain_exists; also as domain_id for verify_domain, get_domain_info, get_zone_file.
domain_id	string	Domain ID (usually the domain name). For verify_domain, get_domain_info, get_zone_file.
feedback_enabled	boolean	For create_domain: enable bounce/feedback tracking (default false).
username	string	For create_inbox: local part of the email (e.g. “hello” for hello@domain.com).
display_name	string	For create_inbox: optional display name for the inbox.
client_id	string	For create_inbox: optional client identifier.
inbox_id	string	For delete_inbox: AgentMail inbox ID to delete.

REST Endpoint


POST /api/agents/tools/configureEmail

The site_id field is required when calling via REST.


POST /api/agents/tools/configureEmail
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
 
{
  "action": "create_inbox",
  "site_id": "YOUR_SITE_ID",
  "domain": "yourdomain.com",
  "username": "hello",
  "display_name": "Hello Team"
}

Response:


{
  "success": true,
  "inbox": {
    "id": "...",
    "email": "hello@yourdomain.com",
    "display_name": "Hello Team"
  }
}