Skip to main content

Tool Reference

All eight tools are prefixed pibx_email_. Every tool call is scoped to the organization your API key belongs to, exactly like the REST API.

ToolDoesNeeds
pibx_email_list_inboxesList inboxes in your organizationemail_inboxes:read
pibx_email_list_messagesList messages in an inbox, optionally grouped into threadsemail_messages:read
pibx_email_search_messagesSearch messages by text, sender, tags, or categoriesemail_messages:read
pibx_email_get_messageFetch one message in fullemail_messages:read
pibx_email_get_threadFetch every message in a threademail_messages:read
pibx_email_get_latest_otpFetch the most recent one-time code delivered to an inboxemail_messages:read
pibx_email_create_inboxCreates a new email inbox and returns it. The address must be on a domain this account can receive at, and cannot be changed afterwards — create another inbox instead.email_inboxes:create
pibx_email_update_inboxRename an existing email inboxemail_inboxes:update

pibx_email_search_messages has no grouped argument — grouping and searching together isn't supported (see Search), so the combination isn't offered as an option in the first place.

Response size​

By default, message bodies come back as short snippets rather than full HTML, since a single templated marketing email can otherwise consume an entire tool-call response budget on its own. Pass response_format: "detailed" to pibx_email_get_message for the full body when you actually need it — even then, an oversized body is capped with a marker noting how much was cut, so a truncated body is never presented as if it were complete.