> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AgentMail

> How to set up the AgentMail connector, plus the actions and events that are available.

![AgentMail](https://stackone-logos.com/api/agentmail/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/agentmail/changelog.md)

[63 actions](#actions) · [21 events](#events) · 1 auth method

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · API Key](https://docs.stackone.com/connectors/agentmail/guides/connector-profile/api-key.md)**
>
> No app registration required. Organization keys reach every inbox, while pod- or inbox-scoped keys only reach resources...

Optionally, configure receiving Events for AgentMail into StackOne.

> **[Webhooks setup](https://docs.stackone.com/connectors/agentmail/guides/webhook-setup.md)**

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](https://docs.stackone.com/connectors/agentmail/guides/link-account/api-key.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

63 actions

ActionDescription

Get Calendar`agentmail_get_calendar`

Gets the inbox's calendar.

Update Calendar`agentmail_update_calendar`

Updates the calendar's default time zone.

List Events`agentmail_list_calendar_events`

Lists the events stored on the calendar: one item per one-off or recurring event, plus one item for each edited date of...

Create Event`agentmail_create_calendar_event`

Creates a one-off or recurring event on the inbox's calendar.

Get Agenda`agentmail_get_calendar_agenda`

Lists every date on the calendar in a time window, ordered by start time: one-off events, and recurring events expanded...

Get Event`agentmail_get_calendar_event`

Gets an event by its UUID, or one date of a recurring event by its dated ID (\<uuid>\_\<slot>).

Update Event`agentmail_update_calendar_event`

Update a calendar event on an inbox's calendar, optionally guarded by its ETag.

Delete Event`agentmail_delete_calendar_event`

Deletes an event, or cancels dates of a recurring event.

List Event Instances`agentmail_list_calendar_event_instances`

Lists the dates of one recurring event in a time window, in start order, with each date's edits applied.

Respond To Event`agentmail_respond_to_calendar_event`

Accepts, declines or tentatively accepts an invitation the inbox received by email.

List Domains`agentmail_list_domains`

List the custom sending domains registered in the AgentMail organization.

Create Domain`agentmail_create_domain`

Register a custom domain so inboxes can send and receive on it.

Get Domain`agentmail_get_domain`

Get a custom domain with its DNS records and verification status.

Update Domain`agentmail_update_domain`

Update the settings of a registered custom domain.

Delete Domain`agentmail_delete_domain`

Delete a custom domain from the organization.

Get Zone File`agentmail_get_domain_zone_file`

Get the DNS zone file of records needed to set up a custom domain.

Verify Domain`agentmail_verify_domain`

Trigger DNS verification of a custom domain.

Get Setup Link`agentmail_get_domain_setup_link`

Build a one-click DNS setup link for the domain via the Domain Connect standard.

List Drafts`agentmail_list_inbox_drafts`

List drafts, most recent first.

Create Draft`agentmail_create_draft`

Create a draft in an inbox for review or scheduled sending.

Get Draft`agentmail_get_inbox_draft`

Get a draft with its full body, recipients and attachments.

Update Draft`agentmail_update_draft`

Edit fields on an existing draft.

Delete Draft`agentmail_delete_draft`

Permanently delete a draft, cancelling any scheduled send.

Get Attachment`agentmail_get_inbox_draft_attachment`

Get a download URL and metadata for one attachment of a draft.

Send Draft`agentmail_send_draft`

Send an existing draft from its inbox.

List Drafts`agentmail_list_drafts`

List drafts, most recent first across every inbox in the organization.

Get Draft`agentmail_get_draft`

Get a draft with its full body, recipients and attachments.

Get Attachment`agentmail_get_draft_attachment`

Get a download URL and metadata for one attachment of a draft.

List Inbox Events`agentmail_list_inbox_events`

List label change events for an inbox.

List Inboxes`agentmail_list_inboxes`

List the inboxes in the AgentMail organization.

Create Inbox`agentmail_create_inbox`

Create a new inbox (email address) for an agent.

Search Inboxes`agentmail_search_inboxes`

Searches inboxes in the organization by address or display name, ranked by relevance.

Get Inbox`agentmail_get_inbox`

Get an inbox with its email address, display name and metadata.

Update Inbox`agentmail_update_inbox`

Update an inbox's display name, status or metadata.

Delete Inbox`agentmail_delete_inbox`

Permanently delete an inbox along with its messages, threads and drafts.

Authorize Inbox`agentmail_authorize_inbox`

Authorizes the AgentID sign-in a client is already waiting in, for the inbox in the path, and returns the ID of the pend...

List Messages`agentmail_list_messages`

Lists messages in the inbox, most recent first.

Search Messages`agentmail_search_messages`

Full-text search across messages in the inbox, ranked by relevance.

Get Message`agentmail_get_message`

Get a single message with its full text, HTML, headers and attachment metadata.

Update Message`agentmail_update_message`

Add or remove labels on a single message.

Delete Message`agentmail_delete_message`

Permanently deletes a message.

Create Agent Armor Feedback`agentmail_create_agent_armor_feedback`

Tell us whether Agent Armor's verdict on a message was right.

Release Agent Armor Message`agentmail_release_agent_armor_message`

Release a message Agent Armor held for review in hold mode: your agents are sent its message.received event, message.sec...

Batch Get Messages`agentmail_batch_get_messages`

Fetch metadata for up to 500 messages in one request.

Batch Update Messages`agentmail_batch_update_messages`

Apply one label change to up to 50 messages in a single request.

Get Attachment`agentmail_get_message_attachment`

Get a download URL and metadata for one attachment of a message.

Get Raw Message`agentmail_get_raw_message`

Get a signed download URL for the raw .eml source of a message.

Send Message`agentmail_send_message`

Send a new email from an inbox.

Reply To Message`agentmail_reply_to_message`

Reply to a message in an inbox, keeping it in the same thread.

Reply All Message`agentmail_reply_all_to_message`

Reply to every recipient of a message in an inbox.

Forward Message`agentmail_forward_message`

Forward a message from an inbox to new recipients.

List Threads`agentmail_list_inbox_threads`

Lists threads in the inbox, most recent first.

Search Threads`agentmail_search_inbox_threads`

Full-text search across threads in the inbox, ranked by relevance.

Get Thread`agentmail_get_inbox_thread`

Get a thread with all of its messages.

Update Thread`agentmail_update_inbox_thread`

Add or remove labels on a thread.

Delete Thread`agentmail_delete_inbox_thread`

Permanently deletes a thread and all of its messages.

Get Attachment`agentmail_get_inbox_thread_attachment`

Get a download URL and metadata for one attachment in a thread.

List Threads`agentmail_list_threads`

Lists threads, most recent first.

Search Threads`agentmail_search_threads`

Full-text search across threads in the organization, ranked by relevance.

Get Thread`agentmail_get_thread`

Get a thread with all of its messages.

Update Thread`agentmail_update_thread`

Add or remove labels on a thread.

Delete Thread`agentmail_delete_thread`

Permanently deletes a thread and all of its messages.

Get Attachment`agentmail_get_thread_attachment`

Get a download URL and metadata for one attachment in a thread.

## Events

Tags

Select all
|
Clear

Agent Armor

Calendar

Domains

Messages

Webhooks

No tags found

21 events

EventDescriptionTags

Calendar Event Created Webhook`agentmail_webhook_calendar_event_created`

Processes AgentMail calendar.event.created events.

CalendarWebhooks

Calendar Event Updated Webhook`agentmail_webhook_calendar_event_updated`

Processes AgentMail calendar.event.updated events.

CalendarWebhooks

Calendar Event Deleted Webhook`agentmail_webhook_calendar_event_deleted`

Processes AgentMail calendar.event.deleted events.

CalendarWebhooks

Calendar Event Responded Webhook`agentmail_webhook_calendar_event_responded`

Processes AgentMail calendar.event.responded events.

CalendarWebhooks

Calendar Event Starting Webhook`agentmail_webhook_calendar_event_starting`

Processes AgentMail calendar.event.starting events.

CalendarWebhooks

Calendar Event Ending Webhook`agentmail_webhook_calendar_event_ending`

Processes AgentMail calendar.event.ending events.

CalendarWebhooks

Domain Verified Webhook`agentmail_webhook_domain_verified`

Processes AgentMail domain.verified events.

DomainsWebhooks

Webhook Delivery Acknowledgement`agentmail_webhook_ping`

Acknowledges AgentMail deliveries that carry no event\_type.

Webhooks

Message Received Webhook`agentmail_webhook_message_received`

Processes AgentMail message.received events.

MessagesWebhooks

Spam Message Received Webhook`agentmail_webhook_message_received_spam`

Processes AgentMail message.received.spam events.

MessagesWebhooks

Blocked Message Received Webhook`agentmail_webhook_message_received_blocked`

Processes AgentMail message.received.blocked events.

MessagesWebhooks

Unauthenticated Message Received Webhook`agentmail_webhook_message_received_unauthenticated`

Processes AgentMail message.received.unauthenticated events.

MessagesWebhooks

Message Sent Webhook`agentmail_webhook_message_sent`

Processes AgentMail message.sent events.

MessagesWebhooks

Message Delivered Webhook`agentmail_webhook_message_delivered`

Processes AgentMail message.delivered events.

MessagesWebhooks

Message Bounced Webhook`agentmail_webhook_message_bounced`

Processes AgentMail message.bounced events.

MessagesWebhooks

Message Complained Webhook`agentmail_webhook_message_complained`

Processes AgentMail message.complained events.

MessagesWebhooks

Message Rejected Webhook`agentmail_webhook_message_rejected`

Processes AgentMail message.rejected events.

MessagesWebhooks

Message Opened Webhook`agentmail_webhook_message_opened`

Processes AgentMail message.opened events.

MessagesWebhooks

Message Security Completed Webhook`agentmail_webhook_message_security_completed`

Processes AgentMail message.security.completed events.

Agent ArmorWebhooks

Message Security Review Webhook`agentmail_webhook_message_security_review`

Processes AgentMail message.security.review events.

Agent ArmorWebhooks

Message Security Override Webhook`agentmail_webhook_message_security_override`

Processes AgentMail message.security.override events.

Agent ArmorWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.