Skip to main content

list-mailboxes

List every mailbox in one ECGrid network. Use to browse or enumerate a network's mailboxes when you do not have a name to search by (e.g. "show the mailboxes on network 7", or just "list my mailboxes"). networkId is optional: supply it to list a specific network; omit it to list the caller's own home network, resolved from the current session. There is no "all networks" mode — the result is always scoped to a single network. Returns an array of mailbox records (mailboxes) plus a count; the array may be empty when the network has no mailboxes.

ℹ️ Interactive UI Component: This tool renders a visual widget in Claude Desktop and Claude.ai alongside the AI's response.

Tool Name

connectivity_mailbox_list-mailboxes

Auth Level Required

Any (scoped to caller's APIKey)

Parameters

ParameterTypeRequiredDescription
request.networkIdinteger | nullNoECGrid network ID to list mailboxes for. Positive integer >= 1. When omitted or null, defaults to the caller's own home network resolved from the current session.

Response

Returns a count and a mailboxes array. Each mailbox record has the same shape as the response from get-mailbox-by-id. Always reflects current state — cache is bypassed.

{
"count": 2,
"mailboxes": [
{
"mailboxId": 142,
"networkId": 7,
"name": "acme-prod@example.com",
"description": "ACME Production Mailbox",
"status": "Active",
"useType": "Production",
"managed": false,
"ecgridAccount": "acme-prod",
"defaultAs2Id": 0,
"ownerUserId": 101,
"ownerLoginName": "admin@example.com",
"ownerAuthLevel": "MailboxAdmin",
"created": "2021-06-01T00:00:00Z",
"modified": "2026-05-20T14:10:33Z"
},
{
"mailboxId": 143,
"networkId": 7,
"name": "acme-test@example.com",
"description": "ACME Test Mailbox",
"status": "Active",
"useType": "Test",
"managed": false,
"ecgridAccount": "acme-test",
"defaultAs2Id": 0,
"ownerUserId": 101,
"ownerLoginName": "admin@example.com",
"ownerAuthLevel": "MailboxAdmin",
"created": "2021-06-01T00:00:00Z",
"modified": "2026-05-20T14:10:33Z"
}
]
}

Response Fields

FieldTypeDescription
countintegerTotal number of mailboxes returned
mailboxesarrayArray of mailbox profile objects
mailboxes[].mailboxIdintegerUnique numeric ECGrid mailbox ID
mailboxes[].networkIdintegerECGrid network this mailbox belongs to
mailboxes[].namestringMailbox name (typically an email address)
mailboxes[].descriptionstringHuman-readable display name for the mailbox
mailboxes[].statusstringLifecycle status (see Status enum)
mailboxes[].useTypestringUse type — Test, Production, or TestAndProduction (see UseType enum)
mailboxes[].managedbooleantrue if this is a managed mailbox
mailboxes[].ecgridAccountstringShort account identifier used internally
mailboxes[].defaultAs2IdintegerECGrid ID of the default AS2 trading partner; 0 if none
mailboxes[].ownerUserIdintegerUser ID of the mailbox owner contact
mailboxes[].ownerLoginNamestringLogin name of the mailbox owner contact
mailboxes[].ownerAuthLevelstringAuth level of the owner (see AuthLevel enum)
mailboxes[].createdstringISO 8601 timestamp when the mailbox was created
mailboxes[].modifiedstringISO 8601 timestamp of the most recent mailbox update

Example Call

List mailboxes on a specific network

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "connectivity_mailbox_list-mailboxes",
"arguments": {
"request": { "networkId": 47 }
}
}
}

List mailboxes on the caller's home network

{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "connectivity_mailbox_list-mailboxes",
"arguments": {
"request": { "networkId": null }
}
}
}

Example Prompts

  • List all mailboxes on my network
  • How many mailboxes does network 47 have?
  • Show all mailboxes for network 7

See Also