Reference

Inboxes

client.inboxes.list({ ...params }) -> AgentMail.ListInboxesResponse

📝 Description

CLI:

agentmail inboxes list

🔌 Usage

await client.inboxes.list();

⚙️ Parameters

request: AgentMail.inboxes.ListInboxesRequest

requestOptions: InboxesClient.RequestOptions

client.inboxes.get(inbox_id) -> AgentMail.Inbox

📝 Description

CLI:

agentmail inboxes get --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.get("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

requestOptions: InboxesClient.RequestOptions

client.inboxes.create({ ...params }) -> AgentMail.Inbox

📝 Description

CLI:

agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to

🔌 Usage

await client.inboxes.create(undefined);

⚙️ Parameters

request: AgentMail.CreateInboxRequest

requestOptions: InboxesClient.RequestOptions

client.inboxes.update(inbox_id, { ...params }) -> AgentMail.Inbox

📝 Description

CLI:

agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"

🔌 Usage

await client.inboxes.update("inbox_id", {
    displayName: "display_name"
});

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.UpdateInboxRequest

requestOptions: InboxesClient.RequestOptions

client.inboxes.delete(inbox_id) -> void

📝 Description

CLI:

agentmail inboxes delete --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.delete("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

requestOptions: InboxesClient.RequestOptions

Pods

client.pods.list({ ...params }) -> AgentMail.ListPodsResponse

📝 Description

CLI:

agentmail pods list

🔌 Usage

await client.pods.list();

⚙️ Parameters

request: AgentMail.pods.ListPodsRequest

requestOptions: PodsClient.RequestOptions

client.pods.get(pod_id) -> AgentMail.Pod

📝 Description

CLI:

agentmail pods get --pod-id <pod_id>

🔌 Usage

await client.pods.get("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

requestOptions: PodsClient.RequestOptions

client.pods.create({ ...params }) -> AgentMail.Pod

📝 Description

CLI:

agentmail pods create --client-id my-pod

🔌 Usage

await client.pods.create({});

⚙️ Parameters

request: AgentMail.CreatePodRequest

requestOptions: PodsClient.RequestOptions

client.pods.delete(pod_id) -> void

📝 Description

CLI:

agentmail pods delete --pod-id <pod_id>

🔌 Usage

await client.pods.delete("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

requestOptions: PodsClient.RequestOptions

Webhooks

client.webhooks.list({ ...params }) -> AgentMail.ListWebhooksResponse

📝 Description

CLI:

agentmail webhooks list

🔌 Usage

await client.webhooks.list();

⚙️ Parameters

request: AgentMail.webhooks.ListWebhooksRequest

requestOptions: WebhooksClient.RequestOptions

client.webhooks.get(webhook_id) -> AgentMail.Webhook

📝 Description

CLI:

agentmail webhooks get --webhook-id <webhook_id>

🔌 Usage

await client.webhooks.get("webhook_id");

⚙️ Parameters

webhook_id: AgentMail.WebhookId

requestOptions: WebhooksClient.RequestOptions

client.webhooks.create({ ...params }) -> AgentMail.Webhook

📝 Description

CLI:

agentmail webhooks create --url https://example.com/webhook --event-type message.received

🔌 Usage

await client.webhooks.create({
    url: "url",
    eventTypes: ["message.received", "message.received"]
});

⚙️ Parameters

request: AgentMail.CreateWebhookRequest

requestOptions: WebhooksClient.RequestOptions

client.webhooks.update(webhook_id, { ...params }) -> AgentMail.Webhook

📝 Description

CLI:

agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>

🔌 Usage

await client.webhooks.update("webhook_id", {});

⚙️ Parameters

webhook_id: AgentMail.WebhookId

request: AgentMail.UpdateWebhookRequest

requestOptions: WebhooksClient.RequestOptions

client.webhooks.delete(webhook_id) -> void

📝 Description

CLI:

agentmail webhooks delete --webhook-id <webhook_id>

🔌 Usage

await client.webhooks.delete("webhook_id");

⚙️ Parameters

webhook_id: AgentMail.WebhookId

requestOptions: WebhooksClient.RequestOptions

Agent

client.agent.signUp({ ...params }) -> AgentMail.AgentSignupResponse

📝 Description

Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.

A 6-digit OTP is sent to the human's email for verification.

This endpoint is idempotent. Calling it again with the same human_email will rotate the API key and resend the OTP if expired.

The returned API key has limited permissions until the organization is verified via the verify endpoint.

CLI:

agentmail agent sign-up --human-email [email protected] --username my-agent

🔌 Usage

await client.agent.signUp({
    humanEmail: "human_email",
    username: "username"
});

⚙️ Parameters

request: AgentMail.AgentSignupRequest

requestOptions: AgentClient.RequestOptions

client.agent.verify({ ...params }) -> AgentMail.AgentVerifyResponse

📝 Description

Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.

On success, the organization is upgraded from agent_unverified to agent_verified, the send allowlist is removed, and free plan entitlements are applied.

The OTP expires after 24 hours and allows a maximum of 10 attempts.

CLI:

agentmail agent verify --otp-code 123456

🔌 Usage

await client.agent.verify({
    otpCode: "otp_code"
});

⚙️ Parameters

request: AgentMail.AgentVerifyRequest

requestOptions: AgentClient.RequestOptions

ApiKeys

client.apiKeys.list({ ...params }) -> AgentMail.ListApiKeysResponse

📝 Description

CLI:

agentmail api-keys list

🔌 Usage

await client.apiKeys.list();

⚙️ Parameters

request: AgentMail.ListApiKeysRequest

requestOptions: ApiKeysClient.RequestOptions

client.apiKeys.create({ ...params }) -> AgentMail.CreateApiKeyResponse

📝 Description

CLI:

agentmail api-keys create --name "My Key"

🔌 Usage

await client.apiKeys.create({});

⚙️ Parameters

request: AgentMail.CreateApiKeyRequest

requestOptions: ApiKeysClient.RequestOptions

client.apiKeys.delete(api_key_id) -> void

📝 Description

CLI:

agentmail api-keys delete --api-key-id <api_key_id>

🔌 Usage

await client.apiKeys.delete("api_key_id");

⚙️ Parameters

api_key_id: AgentMail.ApiKeyId

requestOptions: ApiKeysClient.RequestOptions

Domains

client.domains.list({ ...params }) -> AgentMail.ListDomainsResponse

📝 Description

CLI:

agentmail domains list

🔌 Usage

await client.domains.list();

⚙️ Parameters

request: AgentMail.ListDomainsRequest

requestOptions: DomainsClient.RequestOptions

client.domains.get(domain_id) -> AgentMail.Domain

📝 Description

CLI:

agentmail domains get --domain-id <domain_id>

🔌 Usage

await client.domains.get("domain_id");

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.domains.getZoneFile(domain_id) -> core.BinaryResponse

📝 Description

CLI:

agentmail domains get-zone-file --domain-id <domain_id>

🔌 Usage

await client.domains.getZoneFile("domain_id");

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.domains.create({ ...params }) -> AgentMail.Domain

📝 Description

CLI:

agentmail domains create --domain example.com

🔌 Usage

await client.domains.create({
    domain: "domain",
    feedbackEnabled: true
});

⚙️ Parameters

request: AgentMail.CreateDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.update(domain_id, { ...params }) -> AgentMail.Domain

📝 Description

CLI:

agentmail domains update --domain-id <domain_id>

🔌 Usage

await client.domains.update("domain_id", {});

⚙️ Parameters

domain_id: AgentMail.DomainId

request: AgentMail.UpdateDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.delete(domain_id) -> void

📝 Description

CLI:

agentmail domains delete --domain-id <domain_id>

🔌 Usage

await client.domains.delete("domain_id");

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.domains.verify(domain_id) -> void

📝 Description

CLI:

agentmail domains verify --domain-id <domain_id>

🔌 Usage

await client.domains.verify("domain_id");

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

Drafts

client.drafts.list({ ...params }) -> AgentMail.ListDraftsResponse

📝 Description

CLI:

agentmail drafts list

🔌 Usage

await client.drafts.list();

⚙️ Parameters

request: AgentMail.ListDraftsRequest

requestOptions: DraftsClient.RequestOptions

client.drafts.get(draft_id) -> AgentMail.Draft

📝 Description

CLI:

agentmail drafts get --draft-id <draft_id>

🔌 Usage

await client.drafts.get("draft_id");

⚙️ Parameters

draft_id: AgentMail.DraftId

requestOptions: DraftsClient.RequestOptions

client.drafts.getAttachment(draft_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail drafts get-attachment --draft-id <draft_id> --attachment-id <attachment_id>

🔌 Usage

await client.drafts.getAttachment("draft_id", "attachment_id");

⚙️ Parameters

draft_id: AgentMail.DraftId

attachment_id: AgentMail.AttachmentId

requestOptions: DraftsClient.RequestOptions

Inboxes ApiKeys

client.inboxes.apiKeys.list(inbox_id, { ...params }) -> AgentMail.ListApiKeysResponse

📝 Description

CLI:

agentmail inboxes:api-keys list --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.apiKeys.list("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.ListApiKeysRequest

requestOptions: ApiKeysClient.RequestOptions

client.inboxes.apiKeys.create(inbox_id, { ...params }) -> AgentMail.CreateApiKeyResponse

📝 Description

CLI:

agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"

🔌 Usage

await client.inboxes.apiKeys.create("inbox_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.CreateApiKeyRequest

requestOptions: ApiKeysClient.RequestOptions

client.inboxes.apiKeys.delete(inbox_id, api_key_id) -> void

📝 Description

CLI:

agentmail inboxes:api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>

🔌 Usage

await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

api_key_id: AgentMail.ApiKeyId

requestOptions: ApiKeysClient.RequestOptions

Inboxes Drafts

client.inboxes.drafts.list(inbox_id, { ...params }) -> AgentMail.ListDraftsResponse

📝 Description

CLI:

agentmail inboxes:drafts list --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.drafts.list("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.ListDraftsRequest

requestOptions: DraftsClient.RequestOptions

client.inboxes.drafts.get(inbox_id, draft_id) -> AgentMail.Draft

📝 Description

CLI:

agentmail inboxes:drafts get --inbox-id <inbox_id> --draft-id <draft_id>

🔌 Usage

await client.inboxes.drafts.get("inbox_id", "draft_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

draft_id: AgentMail.DraftId

requestOptions: DraftsClient.RequestOptions

client.inboxes.drafts.getAttachment(inbox_id, draft_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail inboxes:drafts get-attachment --inbox-id <inbox_id> --draft-id <draft_id> --attachment-id <attachment_id>

🔌 Usage

await client.inboxes.drafts.getAttachment("inbox_id", "draft_id", "attachment_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

draft_id: AgentMail.DraftId

attachment_id: AgentMail.AttachmentId

requestOptions: DraftsClient.RequestOptions

client.inboxes.drafts.create(inbox_id, { ...params }) -> AgentMail.Draft

📝 Description

CLI:

agentmail inboxes:drafts create --inbox-id <inbox_id> --to [email protected] --subject "Draft subject" --text "Draft body"

🔌 Usage

await client.inboxes.drafts.create("inbox_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.CreateDraftRequest

requestOptions: DraftsClient.RequestOptions

client.inboxes.drafts.update(inbox_id, draft_id, { ...params }) -> AgentMail.Draft

📝 Description

CLI:

agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"

🔌 Usage

await client.inboxes.drafts.update("inbox_id", "draft_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

draft_id: AgentMail.DraftId

request: AgentMail.UpdateDraftRequest

requestOptions: DraftsClient.RequestOptions

client.inboxes.drafts.delete(inbox_id, draft_id) -> void

📝 Description

CLI:

agentmail inboxes:drafts delete --inbox-id <inbox_id> --draft-id <draft_id>

🔌 Usage

await client.inboxes.drafts.delete("inbox_id", "draft_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

draft_id: AgentMail.DraftId

requestOptions: DraftsClient.RequestOptions

client.inboxes.drafts.send(inbox_id, draft_id, { ...params }) -> AgentMail.SendMessageResponse

📝 Description

CLI:

agentmail inboxes:drafts send --inbox-id <inbox_id> --draft-id <draft_id>

🔌 Usage

await client.inboxes.drafts.send("inbox_id", "draft_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

draft_id: AgentMail.DraftId

request: AgentMail.UpdateMessageRequest

requestOptions: DraftsClient.RequestOptions

Inboxes Events

client.inboxes.events.list(inbox_id, { ...params }) -> AgentMail.ListInboxEventsResponse

📝 Description

List label change events for an inbox. Returns events in reverse chronological order by default. Use for IMAP UID projection or audit logging.

CLI:

agentmail inboxes:events list --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.events.list("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.ListInboxEventsRequest

requestOptions: EventsClient.RequestOptions

Inboxes Lists

client.inboxes.lists.list(inbox_id, direction, type, { ...params }) -> AgentMail.PodListListEntriesResponse

📝 Description

CLI:

agentmail inboxes:lists list --inbox-id <inbox_id> --direction <direction> --type <type>

🔌 Usage

await client.inboxes.lists.list("inbox_id", "send", "allow");

⚙️ Parameters

inbox_id: AgentMail.InboxId

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.inboxes.InboxListListEntriesRequest

requestOptions: ListsClient.RequestOptions

client.inboxes.lists.get(inbox_id, direction, type, entry) -> AgentMail.PodListEntry

📝 Description

CLI:

agentmail inboxes:lists get --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>

🔌 Usage

await client.inboxes.lists.get("inbox_id", "send", "allow", "entry");

⚙️ Parameters

inbox_id: AgentMail.InboxId

direction: AgentMail.Direction

type: AgentMail.ListType

entry: string — Email address or domain.

requestOptions: ListsClient.RequestOptions

client.inboxes.lists.create(inbox_id, direction, type, { ...params }) -> AgentMail.PodListEntry

📝 Description

CLI:

agentmail inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry [email protected]

🔌 Usage

await client.inboxes.lists.create("inbox_id", "send", "allow", {
    entry: "entry"
});

⚙️ Parameters

inbox_id: AgentMail.InboxId

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.CreateListEntryRequest

requestOptions: ListsClient.RequestOptions

client.inboxes.lists.delete(inbox_id, direction, type, entry) -> void

📝 Description

CLI:

agentmail inboxes:lists delete --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>

🔌 Usage

await client.inboxes.lists.delete("inbox_id", "send", "allow", "entry");

⚙️ Parameters

inbox_id: AgentMail.InboxId

direction: AgentMail.Direction

type: AgentMail.ListType

entry: string — Email address or domain.

requestOptions: ListsClient.RequestOptions

Inboxes Messages

client.inboxes.messages.list(inbox_id, { ...params }) -> AgentMail.ListMessagesResponse

📝 Description

CLI:

agentmail inboxes:messages list --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.messages.list("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.ListMessagesRequest

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.get(inbox_id, message_id) -> AgentMail.Message

📝 Description

CLI:

agentmail inboxes:messages get --inbox-id <inbox_id> --message-id <message_id>

🔌 Usage

await client.inboxes.messages.get("inbox_id", "message_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.getAttachment(inbox_id, message_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>

🔌 Usage

await client.inboxes.messages.getAttachment("inbox_id", "message_id", "attachment_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

attachment_id: AgentMail.AttachmentId

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.getRaw(inbox_id, message_id) -> AgentMail.RawMessageResponse

📝 Description

CLI:

agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>

🔌 Usage

await client.inboxes.messages.getRaw("inbox_id", "message_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.update(inbox_id, message_id, { ...params }) -> AgentMail.UpdateMessageResponse

📝 Description

CLI:

agentmail inboxes:messages update --inbox-id <inbox_id> --message-id <message_id> --add-label read --remove-label unread

🔌 Usage

await client.inboxes.messages.update("inbox_id", "message_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

request: AgentMail.UpdateMessageRequest

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.delete(inbox_id, message_id) -> void

📝 Description

Permanently deletes a message.

CLI:

agentmail inboxes:messages delete --inbox-id <inbox_id> --message-id <message_id>

🔌 Usage

await client.inboxes.messages.delete("inbox_id", "message_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.send(inbox_id, { ...params }) -> AgentMail.SendMessageResponse

📝 Description

CLI:

agentmail inboxes:messages send --inbox-id <inbox_id> --to [email protected] --subject "Hello" --text "Body"

🔌 Usage

await client.inboxes.messages.send("inbox_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.SendMessageRequest

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.reply(inbox_id, message_id, { ...params }) -> AgentMail.SendMessageResponse

📝 Description

CLI:

agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"

🔌 Usage

await client.inboxes.messages.reply("inbox_id", "message_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

request: AgentMail.ReplyToMessageRequest

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.replyAll(inbox_id, message_id, { ...params }) -> AgentMail.SendMessageResponse

📝 Description

CLI:

agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"

🔌 Usage

await client.inboxes.messages.replyAll("inbox_id", "message_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

request: AgentMail.ReplyAllMessageRequest

requestOptions: MessagesClient.RequestOptions

client.inboxes.messages.forward(inbox_id, message_id, { ...params }) -> AgentMail.SendMessageResponse

📝 Description

CLI:

agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to [email protected]

🔌 Usage

await client.inboxes.messages.forward("inbox_id", "message_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

message_id: AgentMail.MessageId

request: AgentMail.SendMessageRequest

requestOptions: MessagesClient.RequestOptions

Inboxes Metrics

client.inboxes.metrics.query(inbox_id, { ...params }) -> AgentMail.QueryMetricsResponse

📝 Description

CLI:

agentmail inboxes:metrics query --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.metrics.query("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.QueryMetricsRequest

requestOptions: MetricsClient.RequestOptions

Inboxes Threads

client.inboxes.threads.list(inbox_id, { ...params }) -> AgentMail.ListThreadsResponse

📝 Description

CLI:

agentmail inboxes:threads list --inbox-id <inbox_id>

🔌 Usage

await client.inboxes.threads.list("inbox_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.ListThreadsRequest

requestOptions: ThreadsClient.RequestOptions

client.inboxes.threads.get(inbox_id, thread_id) -> AgentMail.Thread

📝 Description

CLI:

agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>

🔌 Usage

await client.inboxes.threads.get("inbox_id", "thread_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

thread_id: AgentMail.ThreadId

requestOptions: ThreadsClient.RequestOptions

client.inboxes.threads.getAttachment(inbox_id, thread_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>

🔌 Usage

await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

thread_id: AgentMail.ThreadId

attachment_id: AgentMail.AttachmentId

requestOptions: ThreadsClient.RequestOptions

client.inboxes.threads.update(inbox_id, thread_id, { ...params }) -> AgentMail.UpdateThreadResponse

📝 Description

Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a 422 for threads with 100 or more messages.

🔌 Usage

await client.inboxes.threads.update("inbox_id", "thread_id", {});

⚙️ Parameters

inbox_id: AgentMail.InboxId

thread_id: AgentMail.ThreadId

request: AgentMail.UpdateThreadRequest

requestOptions: ThreadsClient.RequestOptions

client.inboxes.threads.delete(inbox_id, thread_id, { ...params }) -> void

📝 Description

Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use permanent=true to force permanent deletion.

CLI:

agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>

🔌 Usage

await client.inboxes.threads.delete("inbox_id", "thread_id");

⚙️ Parameters

inbox_id: AgentMail.InboxId

thread_id: AgentMail.ThreadId

request: AgentMail.inboxes.DeleteThreadRequest

requestOptions: ThreadsClient.RequestOptions

Lists

client.lists.list(direction, type, { ...params }) -> AgentMail.ListListEntriesResponse

📝 Description

CLI:

agentmail lists list --direction <direction> --type <type>

🔌 Usage

await client.lists.list("send", "allow");

⚙️ Parameters

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.ListListEntriesRequest

requestOptions: ListsClient.RequestOptions

client.lists.get(direction, type, entry) -> AgentMail.ListEntry

📝 Description

CLI:

agentmail lists get --direction <direction> --type <type> --entry <entry>

🔌 Usage

await client.lists.get("send", "allow", "entry");

⚙️ Parameters

direction: AgentMail.Direction

type: AgentMail.ListType

entry: string — Email address or domain.

requestOptions: ListsClient.RequestOptions

client.lists.create(direction, type, { ...params }) -> AgentMail.ListEntry

📝 Description

CLI:

agentmail lists create --direction <direction> --type <type> --entry [email protected]

🔌 Usage

await client.lists.create("send", "allow", {
    entry: "entry"
});

⚙️ Parameters

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.CreateListEntryRequest

requestOptions: ListsClient.RequestOptions

client.lists.delete(direction, type, entry) -> void

📝 Description

CLI:

agentmail lists delete --direction <direction> --type <type> --entry <entry>

🔌 Usage

await client.lists.delete("send", "allow", "entry");

⚙️ Parameters

direction: AgentMail.Direction

type: AgentMail.ListType

entry: string — Email address or domain.

requestOptions: ListsClient.RequestOptions

Metrics

client.metrics.query({ ...params }) -> AgentMail.QueryMetricsResponse

📝 Description

CLI:

agentmail metrics list

🔌 Usage

await client.metrics.query();

⚙️ Parameters

request: AgentMail.QueryMetricsRequest

requestOptions: MetricsClient.RequestOptions

Organizations

client.organizations.get() -> AgentMail.Organization

📝 Description

Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).

CLI:

agentmail organizations get

🔌 Usage

await client.organizations.get();

⚙️ Parameters

requestOptions: OrganizationsClient.RequestOptions

Pods ApiKeys

client.pods.apiKeys.list(pod_id, { ...params }) -> AgentMail.ListApiKeysResponse

📝 Description

CLI:

agentmail pods:api-keys list --pod-id <pod_id>

🔌 Usage

await client.pods.apiKeys.list("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.ListApiKeysRequest

requestOptions: ApiKeysClient.RequestOptions

client.pods.apiKeys.create(pod_id, { ...params }) -> AgentMail.CreateApiKeyResponse

📝 Description

CLI:

agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"

🔌 Usage

await client.pods.apiKeys.create("pod_id", {});

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.CreateApiKeyRequest

requestOptions: ApiKeysClient.RequestOptions

client.pods.apiKeys.delete(pod_id, api_key_id) -> void

📝 Description

CLI:

agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>

🔌 Usage

await client.pods.apiKeys.delete("pod_id", "api_key_id");

⚙️ Parameters

pod_id: AgentMail.PodId

api_key_id: AgentMail.ApiKeyId

requestOptions: ApiKeysClient.RequestOptions

Pods Domains

client.pods.domains.list(pod_id, { ...params }) -> AgentMail.ListDomainsResponse

📝 Description

CLI:

agentmail pods:domains list --pod-id <pod_id>

🔌 Usage

await client.pods.domains.list("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.ListDomainsRequest

requestOptions: DomainsClient.RequestOptions

client.pods.domains.get(pod_id, domain_id) -> AgentMail.Domain

📝 Description

CLI:

agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>

🔌 Usage

await client.pods.domains.get("pod_id", "domain_id");

⚙️ Parameters

pod_id: AgentMail.PodId

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.pods.domains.getZoneFile(pod_id, domain_id) -> core.BinaryResponse

📝 Description

CLI:

agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>

🔌 Usage

await client.pods.domains.getZoneFile("pod_id", "domain_id");

⚙️ Parameters

pod_id: AgentMail.PodId

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.pods.domains.create(pod_id, { ...params }) -> AgentMail.Domain

📝 Description

CLI:

agentmail pods:domains create --pod-id <pod_id> --domain example.com

🔌 Usage

await client.pods.domains.create("pod_id", {
    domain: "domain",
    feedbackEnabled: true
});

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.CreateDomainRequest

requestOptions: DomainsClient.RequestOptions

client.pods.domains.update(pod_id, domain_id, { ...params }) -> AgentMail.Domain

📝 Description

CLI:

agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>

🔌 Usage

await client.pods.domains.update("pod_id", "domain_id", {});

⚙️ Parameters

pod_id: AgentMail.PodId

domain_id: AgentMail.DomainId

request: AgentMail.UpdateDomainRequest

requestOptions: DomainsClient.RequestOptions

client.pods.domains.delete(pod_id, domain_id) -> void

📝 Description

CLI:

agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>

🔌 Usage

await client.pods.domains.delete("pod_id", "domain_id");

⚙️ Parameters

pod_id: AgentMail.PodId

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.pods.domains.verify(pod_id, domain_id) -> void

📝 Description

CLI:

agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>

🔌 Usage

await client.pods.domains.verify("pod_id", "domain_id");

⚙️ Parameters

pod_id: AgentMail.PodId

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

Pods Drafts

client.pods.drafts.list(pod_id, { ...params }) -> AgentMail.ListDraftsResponse

📝 Description

CLI:

agentmail pods:drafts list --pod-id <pod_id>

🔌 Usage

await client.pods.drafts.list("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.ListDraftsRequest

requestOptions: DraftsClient.RequestOptions

client.pods.drafts.get(pod_id, draft_id) -> AgentMail.Draft

📝 Description

CLI:

agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>

🔌 Usage

await client.pods.drafts.get("pod_id", "draft_id");

⚙️ Parameters

pod_id: AgentMail.PodId

draft_id: AgentMail.DraftId

requestOptions: DraftsClient.RequestOptions

client.pods.drafts.getAttachment(pod_id, draft_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>

🔌 Usage

await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");

⚙️ Parameters

pod_id: AgentMail.PodId

draft_id: AgentMail.DraftId

attachment_id: AgentMail.AttachmentId

requestOptions: DraftsClient.RequestOptions

Pods Inboxes

client.pods.inboxes.list(pod_id, { ...params }) -> AgentMail.ListInboxesResponse

📝 Description

CLI:

agentmail pods:inboxes list --pod-id <pod_id>

🔌 Usage

await client.pods.inboxes.list("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.ListInboxesRequest

requestOptions: InboxesClient.RequestOptions

client.pods.inboxes.get(pod_id, inbox_id) -> AgentMail.Inbox

📝 Description

CLI:

agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>

🔌 Usage

await client.pods.inboxes.get("pod_id", "inbox_id");

⚙️ Parameters

pod_id: AgentMail.PodId

inbox_id: AgentMail.InboxId

requestOptions: InboxesClient.RequestOptions

client.pods.inboxes.create(pod_id, { ...params }) -> AgentMail.Inbox

📝 Description

CLI:

agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com

🔌 Usage

await client.pods.inboxes.create("pod_id", {});

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.CreateInboxRequest

requestOptions: InboxesClient.RequestOptions

client.pods.inboxes.update(pod_id, inbox_id, { ...params }) -> AgentMail.Inbox

📝 Description

CLI:

agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>

🔌 Usage

await client.pods.inboxes.update("pod_id", "inbox_id", {
    displayName: "display_name"
});

⚙️ Parameters

pod_id: AgentMail.PodId

inbox_id: AgentMail.InboxId

request: AgentMail.UpdateInboxRequest

requestOptions: InboxesClient.RequestOptions

client.pods.inboxes.delete(pod_id, inbox_id) -> void

📝 Description

CLI:

agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>

🔌 Usage

await client.pods.inboxes.delete("pod_id", "inbox_id");

⚙️ Parameters

pod_id: AgentMail.PodId

inbox_id: AgentMail.InboxId

requestOptions: InboxesClient.RequestOptions

Pods Lists

client.pods.lists.list(pod_id, direction, type, { ...params }) -> AgentMail.PodListListEntriesResponse

📝 Description

CLI:

agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type>

🔌 Usage

await client.pods.lists.list("pod_id", "send", "allow");

⚙️ Parameters

pod_id: AgentMail.PodId

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.pods.ListListEntriesRequest

requestOptions: ListsClient.RequestOptions

client.pods.lists.get(pod_id, direction, type, entry) -> AgentMail.PodListEntry

📝 Description

CLI:

agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>

🔌 Usage

await client.pods.lists.get("pod_id", "send", "allow", "entry");

⚙️ Parameters

pod_id: AgentMail.PodId

direction: AgentMail.Direction

type: AgentMail.ListType

entry: string — Email address or domain.

requestOptions: ListsClient.RequestOptions

client.pods.lists.create(pod_id, direction, type, { ...params }) -> AgentMail.PodListEntry

📝 Description

CLI:

agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <type> --entry [email protected]

🔌 Usage

await client.pods.lists.create("pod_id", "send", "allow", {
    entry: "entry"
});

⚙️ Parameters

pod_id: AgentMail.PodId

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.CreateListEntryRequest

requestOptions: ListsClient.RequestOptions

client.pods.lists.delete(pod_id, direction, type, entry) -> void

📝 Description

CLI:

agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>

🔌 Usage

await client.pods.lists.delete("pod_id", "send", "allow", "entry");

⚙️ Parameters

pod_id: AgentMail.PodId

direction: AgentMail.Direction

type: AgentMail.ListType

entry: string — Email address or domain.

requestOptions: ListsClient.RequestOptions

Pods Metrics

client.pods.metrics.query(pod_id, { ...params }) -> AgentMail.QueryMetricsResponse

📝 Description

CLI:

agentmail pods:metrics query --pod-id <pod_id>

🔌 Usage

await client.pods.metrics.query("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.QueryMetricsRequest

requestOptions: MetricsClient.RequestOptions

Pods Threads

client.pods.threads.list(pod_id, { ...params }) -> AgentMail.ListThreadsResponse

📝 Description

CLI:

agentmail pods:threads list --pod-id <pod_id>

🔌 Usage

await client.pods.threads.list("pod_id");

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.ListThreadsRequest

requestOptions: ThreadsClient.RequestOptions

client.pods.threads.get(pod_id, thread_id) -> AgentMail.Thread

📝 Description

CLI:

agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>

🔌 Usage

await client.pods.threads.get("pod_id", "thread_id");

⚙️ Parameters

pod_id: AgentMail.PodId

thread_id: AgentMail.ThreadId

requestOptions: ThreadsClient.RequestOptions

client.pods.threads.getAttachment(pod_id, thread_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>

🔌 Usage

await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");

⚙️ Parameters

pod_id: AgentMail.PodId

thread_id: AgentMail.ThreadId

attachment_id: AgentMail.AttachmentId

requestOptions: ThreadsClient.RequestOptions

client.pods.threads.update(pod_id, thread_id, { ...params }) -> AgentMail.UpdateThreadResponse

📝 Description

Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a 422 for threads with 100 or more messages.

🔌 Usage

await client.pods.threads.update("pod_id", "thread_id", {});

⚙️ Parameters

pod_id: AgentMail.PodId

thread_id: AgentMail.ThreadId

request: AgentMail.UpdateThreadRequest

requestOptions: ThreadsClient.RequestOptions

client.pods.threads.delete(pod_id, thread_id, { ...params }) -> void

📝 Description

Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use permanent=true to force permanent deletion.

CLI:

agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>

🔌 Usage

await client.pods.threads.delete("pod_id", "thread_id");

⚙️ Parameters

pod_id: AgentMail.PodId

thread_id: AgentMail.ThreadId

request: AgentMail.pods.DeleteThreadRequest

requestOptions: ThreadsClient.RequestOptions

Threads

client.threads.list({ ...params }) -> AgentMail.ListThreadsResponse

📝 Description

CLI:

agentmail threads list

🔌 Usage

await client.threads.list();

⚙️ Parameters

request: AgentMail.ListThreadsRequest

requestOptions: ThreadsClient.RequestOptions

client.threads.get(thread_id) -> AgentMail.Thread

📝 Description

CLI:

agentmail threads get --thread-id <thread_id>

🔌 Usage

await client.threads.get("thread_id");

⚙️ Parameters

thread_id: AgentMail.ThreadId

requestOptions: ThreadsClient.RequestOptions

client.threads.getAttachment(thread_id, attachment_id) -> AgentMail.AttachmentResponse

📝 Description

CLI:

agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attachment_id>

🔌 Usage

await client.threads.getAttachment("thread_id", "attachment_id");

⚙️ Parameters

thread_id: AgentMail.ThreadId

attachment_id: AgentMail.AttachmentId

requestOptions: ThreadsClient.RequestOptions

client.threads.update(thread_id, { ...params }) -> AgentMail.UpdateThreadResponse

📝 Description

Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a 422 for threads with 100 or more messages.

🔌 Usage

await client.threads.update("thread_id", {});

⚙️ Parameters

thread_id: AgentMail.ThreadId

request: AgentMail.UpdateThreadRequest

requestOptions: ThreadsClient.RequestOptions

client.threads.delete(thread_id, { ...params }) -> void

📝 Description

Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use permanent=true to force permanent deletion.

CLI:

agentmail threads delete --thread-id <thread_id>

🔌 Usage

await client.threads.delete("thread_id");

⚙️ Parameters

thread_id: AgentMail.ThreadId

request: AgentMail.DeleteThreadRequest

requestOptions: ThreadsClient.RequestOptions

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

Inboxes

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Pods

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Webhooks

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Agent

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

ApiKeys

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Domains

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description