reference.md

Reference

Inboxes

client.inboxes.list(...) -> AsyncHttpResponse[ListInboxesResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.get(...) -> AsyncHttpResponse[Inbox]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.get(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.create(...) -> AsyncHttpResponse[Inbox]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.create()

⚙️ Parameters

request: typing.Optional[CreateInboxRequest]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.update(...) -> AsyncHttpResponse[Inbox]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.update(
    inbox_id="inbox_id",
    display_name="display_name",
)

⚙️ Parameters

inbox_id: InboxId

display_name: DisplayName

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.delete(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods

client.pods.list(...) -> AsyncHttpResponse[ListPodsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.get(...) -> AsyncHttpResponse[Pod]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.get(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.create(...) -> AsyncHttpResponse[Pod]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.create()

⚙️ Parameters

name: typing.Optional[Name]

client_id: typing.Optional[ClientId]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.delete(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Webhooks

client.webhooks.list(...) -> AsyncHttpResponse[ListWebhooksResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.webhooks.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.webhooks.get(...) -> AsyncHttpResponse[Webhook]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.webhooks.get(
    webhook_id="webhook_id",
)

⚙️ Parameters

webhook_id: WebhookId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.webhooks.update(...) -> AsyncHttpResponse[Webhook]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.webhooks.update(
    webhook_id="webhook_id",
)

⚙️ Parameters

webhook_id: WebhookId

add_inbox_ids: typing.Optional[InboxIds] — Inbox IDs to subscribe to the webhook.

remove_inbox_ids: typing.Optional[InboxIds] — Inbox IDs to unsubscribe from the webhook.

add_pod_ids: typing.Optional[PodIds] — Pod IDs to subscribe to the webhook.

remove_pod_ids: typing.Optional[PodIds] — Pod IDs to unsubscribe from the webhook.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.webhooks.create(...) -> AsyncHttpResponse[Webhook]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.webhooks.create(
    url="url",
    event_types=["message.received", "message.received"],
)

⚙️ Parameters

url: Url

event_types: EventTypes

pod_ids: typing.Optional[PodIds]

inbox_ids: typing.Optional[InboxIds]

client_id: typing.Optional[ClientId]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.webhooks.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.webhooks.delete(
    webhook_id="webhook_id",
)

⚙️ Parameters

webhook_id: WebhookId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

ApiKeys

client.api_keys.list(...) -> AsyncHttpResponse[ListApiKeysResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.api_keys.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.api_keys.create(...) -> AsyncHttpResponse[CreateApiKeyResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.api_keys.create(
    name="name",
)

⚙️ Parameters

name: Name

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.api_keys.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.api_keys.delete(
    api_key="api_key",
)

⚙️ Parameters

api_key: ApiKeyId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Domains

client.domains.list(...) -> AsyncHttpResponse[ListDomainsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.domains.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.domains.get(...) -> AsyncHttpResponse[Domain]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.domains.get(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: DomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.domains.get_zone_file(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.domains.get_zone_file(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: DomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration. You can pass in configuration such as chunk_size, and more to customize the request and response.

client.domains.create(...) -> AsyncHttpResponse[Domain]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.domains.create(
    domain="domain",
    feedback_enabled=True,
)

⚙️ Parameters

domain: DomainName

feedback_enabled: FeedbackEnabled

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.domains.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.domains.delete(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: DomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.domains.verify(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.domains.verify(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: DomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Drafts

client.drafts.list(...) -> AsyncHttpResponse[ListDraftsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.drafts.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.drafts.get(...) -> AsyncHttpResponse[Draft]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.drafts.get(
    draft_id="draft_id",
)

⚙️ Parameters

draft_id: DraftId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.drafts.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.drafts.get_attachment(
    draft_id="draft_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

draft_id: DraftId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Inboxes Drafts

client.inboxes.drafts.list(...) -> AsyncHttpResponse[ListDraftsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.list(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.drafts.get(...) -> AsyncHttpResponse[Draft]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.get(
    inbox_id="inbox_id",
    draft_id="draft_id",
)

⚙️ Parameters

inbox_id: InboxId

draft_id: DraftId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.drafts.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.get_attachment(
    inbox_id="inbox_id",
    draft_id="draft_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

inbox_id: InboxId

draft_id: DraftId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.drafts.create(...) -> AsyncHttpResponse[Draft]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.create(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

labels: typing.Optional[DraftLabels]

reply_to: typing.Optional[DraftReplyTo]

to: typing.Optional[DraftTo]

cc: typing.Optional[DraftCc]

bcc: typing.Optional[DraftBcc]

subject: typing.Optional[DraftSubject]

text: typing.Optional[DraftText]

html: typing.Optional[DraftHtml]

attachments: typing.Optional[typing.Sequence[SendAttachment]] — Attachments to include in draft.

in_reply_to: typing.Optional[DraftInReplyTo]

send_at: typing.Optional[DraftSendAt]

client_id: typing.Optional[DraftClientId]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.drafts.update(...) -> AsyncHttpResponse[Draft]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.update(
    inbox_id="inbox_id",
    draft_id="draft_id",
)

⚙️ Parameters

inbox_id: InboxId

draft_id: DraftId

reply_to: typing.Optional[DraftReplyTo]

to: typing.Optional[DraftTo]

cc: typing.Optional[DraftCc]

bcc: typing.Optional[DraftBcc]

subject: typing.Optional[DraftSubject]

text: typing.Optional[DraftText]

html: typing.Optional[DraftHtml]

send_at: typing.Optional[DraftSendAt]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.drafts.send(...) -> AsyncHttpResponse[SendMessageResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.send(
    inbox_id="inbox_id",
    draft_id="draft_id",
)

⚙️ Parameters

inbox_id: InboxId

draft_id: DraftId

add_labels: typing.Optional[typing.Sequence[str]] — Labels to add to message.

remove_labels: typing.Optional[typing.Sequence[str]] — Labels to remove from message.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.drafts.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.drafts.delete(
    inbox_id="inbox_id",
    draft_id="draft_id",
)

⚙️ Parameters

inbox_id: InboxId

draft_id: DraftId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Inboxes Messages

client.inboxes.messages.list(...) -> AsyncHttpResponse[ListMessagesResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.list(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

include_spam: typing.Optional[IncludeSpam]

include_blocked: typing.Optional[IncludeBlocked]

include_trash: typing.Optional[IncludeTrash]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.get(...) -> AsyncHttpResponse[Message]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.get(
    inbox_id="inbox_id",
    message_id="message_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.get_attachment(
    inbox_id="inbox_id",
    message_id="message_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.get_raw(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.get_raw(
    inbox_id="inbox_id",
    message_id="message_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

request_options: typing.Optional[RequestOptions] — Request-specific configuration. You can pass in configuration such as chunk_size, and more to customize the request and response.

client.inboxes.messages.send(...) -> AsyncHttpResponse[SendMessageResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.send(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

labels: typing.Optional[MessageLabels]

reply_to: typing.Optional[SendMessageReplyTo]

to: typing.Optional[SendMessageTo]

cc: typing.Optional[SendMessageCc]

bcc: typing.Optional[SendMessageBcc]

subject: typing.Optional[MessageSubject]

text: typing.Optional[MessageText]

html: typing.Optional[MessageHtml]

attachments: typing.Optional[SendMessageAttachments]

headers: typing.Optional[SendMessageHeaders]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.reply(...) -> AsyncHttpResponse[SendMessageResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.reply(
    inbox_id="inbox_id",
    message_id="message_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

labels: typing.Optional[MessageLabels]

reply_to: typing.Optional[SendMessageReplyTo]

to: typing.Optional[SendMessageTo]

cc: typing.Optional[SendMessageCc]

bcc: typing.Optional[SendMessageBcc]

reply_all: typing.Optional[ReplyAll]

text: typing.Optional[MessageText]

html: typing.Optional[MessageHtml]

attachments: typing.Optional[SendMessageAttachments]

headers: typing.Optional[SendMessageHeaders]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.reply_all(...) -> AsyncHttpResponse[SendMessageResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.reply_all(
    inbox_id="inbox_id",
    message_id="message_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

labels: typing.Optional[MessageLabels]

reply_to: typing.Optional[SendMessageReplyTo]

text: typing.Optional[MessageText]

html: typing.Optional[MessageHtml]

attachments: typing.Optional[SendMessageAttachments]

headers: typing.Optional[SendMessageHeaders]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.forward(...) -> AsyncHttpResponse[SendMessageResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.forward(
    inbox_id="inbox_id",
    message_id="message_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

labels: typing.Optional[MessageLabels]

reply_to: typing.Optional[SendMessageReplyTo]

to: typing.Optional[SendMessageTo]

cc: typing.Optional[SendMessageCc]

bcc: typing.Optional[SendMessageBcc]

subject: typing.Optional[MessageSubject]

text: typing.Optional[MessageText]

html: typing.Optional[MessageHtml]

attachments: typing.Optional[SendMessageAttachments]

headers: typing.Optional[SendMessageHeaders]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.messages.update(...) -> AsyncHttpResponse[Message]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.messages.update(
    inbox_id="inbox_id",
    message_id="message_id",
)

⚙️ Parameters

inbox_id: InboxId

message_id: MessageId

add_labels: typing.Optional[typing.Sequence[str]] — Labels to add to message.

remove_labels: typing.Optional[typing.Sequence[str]] — Labels to remove from message.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Inboxes Metrics

client.inboxes.metrics.get(...) -> AsyncHttpResponse[ListMetricsResponse]

🔌 Usage

import datetime

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.metrics.get(
    inbox_id="inbox_id",
    start_timestamp=datetime.datetime.fromisoformat(
        "2024-01-15 09:30:00+00:00",
    ),
    end_timestamp=datetime.datetime.fromisoformat(
        "2024-01-15 09:30:00+00:00",
    ),
)

⚙️ Parameters

inbox_id: InboxId

start_timestamp: MetricStartTimestamp

end_timestamp: MetricEndTimestamp

event_types: typing.Optional[MetricEventTypes]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Inboxes Threads

client.inboxes.threads.list(...) -> AsyncHttpResponse[ListThreadsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.threads.list(
    inbox_id="inbox_id",
)

⚙️ Parameters

inbox_id: InboxId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

include_spam: typing.Optional[IncludeSpam]

include_blocked: typing.Optional[IncludeBlocked]

include_trash: typing.Optional[IncludeTrash]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.threads.get(...) -> AsyncHttpResponse[Thread]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.threads.get(
    inbox_id="inbox_id",
    thread_id="thread_id",
)

⚙️ Parameters

inbox_id: InboxId

thread_id: ThreadId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.threads.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.threads.get_attachment(
    inbox_id="inbox_id",
    thread_id="thread_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

inbox_id: InboxId

thread_id: ThreadId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.inboxes.threads.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.inboxes.threads.delete(
    inbox_id="inbox_id",
    thread_id="thread_id",
)

⚙️ Parameters

inbox_id: InboxId

thread_id: ThreadId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Lists

client.lists.create(...) -> AsyncHttpResponse[ListEntry]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.lists.create(
    direction="send",
    type="allow",
    entry="entry",
)

⚙️ Parameters

direction: Direction

type: ListType

entry: str — Email address or domain to add.

reason: typing.Optional[str] — Reason for adding the entry.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.lists.list(...) -> AsyncHttpResponse[ListListEntriesResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.lists.list(
    direction="send",
    type="allow",
)

⚙️ Parameters

direction: Direction

type: ListType

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.lists.get(...) -> AsyncHttpResponse[ListEntry]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.lists.get(
    direction="send",
    type="allow",
    entry="entry",
)

⚙️ Parameters

direction: Direction

type: ListType

entry: str — Email address or domain.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.lists.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.lists.delete(
    direction="send",
    type="allow",
    entry="entry",
)

⚙️ Parameters

direction: Direction

type: ListType

entry: str — Email address or domain.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Metrics

client.metrics.list(...) -> AsyncHttpResponse[ListMetricsResponse]

🔌 Usage

import datetime

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.metrics.list(
    start_timestamp=datetime.datetime.fromisoformat(
        "2024-01-15 09:30:00+00:00",
    ),
    end_timestamp=datetime.datetime.fromisoformat(
        "2024-01-15 09:30:00+00:00",
    ),
)

⚙️ Parameters

start_timestamp: MetricStartTimestamp

end_timestamp: MetricEndTimestamp

event_types: typing.Optional[MetricEventTypes]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organizations

client.organizations.get() -> AsyncHttpResponse[Organization]

📝 Description

Get the current organization.

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.organizations.get()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods ApiKeys

client.pods.api_keys.create(...) -> AsyncHttpResponse[CreateApiKeyResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.api_keys.create(
    pod_id="pod_id",
    name="name",
)

⚙️ Parameters

pod_id: PodId

name: Name

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.api_keys.list(...) -> AsyncHttpResponse[ListApiKeysResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.api_keys.list(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.api_keys.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.api_keys.delete(
    pod_id="pod_id",
    api_key="api_key",
)

⚙️ Parameters

pod_id: PodId

api_key: ApiKeyId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods Domains

client.pods.domains.list(...) -> AsyncHttpResponse[ListDomainsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.domains.list(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.domains.create(...) -> AsyncHttpResponse[Domain]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.domains.create(
    pod_id="pod_id",
    domain="domain",
    feedback_enabled=True,
)

⚙️ Parameters

pod_id: PodId

domain: DomainName

feedback_enabled: FeedbackEnabled

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.domains.get(...) -> AsyncHttpResponse[Domain]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.domains.get(
    pod_id="pod_id",
    domain_id="domain_id",
)

⚙️ Parameters

pod_id: PodId

domain_id: DomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.domains.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.domains.delete(
    pod_id="pod_id",
    domain_id="domain_id",
)

⚙️ Parameters

pod_id: PodId

domain_id: DomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods Drafts

client.pods.drafts.list(...) -> AsyncHttpResponse[ListDraftsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.drafts.list(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.drafts.get(...) -> AsyncHttpResponse[Draft]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.drafts.get(
    pod_id="pod_id",
    draft_id="draft_id",
)

⚙️ Parameters

pod_id: PodId

draft_id: DraftId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.drafts.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.drafts.get_attachment(
    pod_id="pod_id",
    draft_id="draft_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

pod_id: PodId

draft_id: DraftId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods Inboxes

client.pods.inboxes.list(...) -> AsyncHttpResponse[ListInboxesResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.inboxes.list(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

ascending: typing.Optional[Ascending]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.inboxes.get(...) -> AsyncHttpResponse[Inbox]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.inboxes.get(
    pod_id="pod_id",
    inbox_id="inbox_id",
)

⚙️ Parameters

pod_id: PodId

inbox_id: InboxId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.inboxes.create(...) -> AsyncHttpResponse[Inbox]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.inboxes.create(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

username: typing.Optional[str] — Username of address. Randomly generated if not specified.

domain: typing.Optional[str] — Domain of address. Must be verified domain. Defaults to agentmail.to.

display_name: typing.Optional[DisplayName]

client_id: typing.Optional[ClientId]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.inboxes.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.inboxes.delete(
    pod_id="pod_id",
    inbox_id="inbox_id",
)

⚙️ Parameters

pod_id: PodId

inbox_id: InboxId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods Lists

client.pods.lists.create(...) -> AsyncHttpResponse[PodListEntry]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.lists.create(
    pod_id="pod_id",
    direction="send",
    type="allow",
    entry="entry",
)

⚙️ Parameters

pod_id: PodId

direction: Direction

type: ListType

entry: str — Email address or domain to add.

reason: typing.Optional[str] — Reason for adding the entry.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.lists.list(...) -> AsyncHttpResponse[PodListListEntriesResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.lists.list(
    pod_id="pod_id",
    direction="send",
    type="allow",
)

⚙️ Parameters

pod_id: PodId

direction: Direction

type: ListType

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.lists.get(...) -> AsyncHttpResponse[PodListEntry]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.lists.get(
    pod_id="pod_id",
    direction="send",
    type="allow",
    entry="entry",
)

⚙️ Parameters

pod_id: PodId

direction: Direction

type: ListType

entry: str — Email address or domain.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.lists.delete(...) -> AsyncHttpResponse[None]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.lists.delete(
    pod_id="pod_id",
    direction="send",
    type="allow",
    entry="entry",
)

⚙️ Parameters

pod_id: PodId

direction: Direction

type: ListType

entry: str — Email address or domain.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Pods Threads

client.pods.threads.list(...) -> AsyncHttpResponse[ListThreadsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.threads.list(
    pod_id="pod_id",
)

⚙️ Parameters

pod_id: PodId

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

include_spam: typing.Optional[IncludeSpam]

include_blocked: typing.Optional[IncludeBlocked]

include_trash: typing.Optional[IncludeTrash]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.threads.get(...) -> AsyncHttpResponse[Thread]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.threads.get(
    pod_id="pod_id",
    thread_id="thread_id",
)

⚙️ Parameters

pod_id: PodId

thread_id: ThreadId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.pods.threads.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.pods.threads.get_attachment(
    pod_id="pod_id",
    thread_id="thread_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

pod_id: PodId

thread_id: ThreadId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Threads

client.threads.list(...) -> AsyncHttpResponse[ListThreadsResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.threads.list()

⚙️ Parameters

limit: typing.Optional[Limit]

page_token: typing.Optional[PageToken]

labels: typing.Optional[Labels]

before: typing.Optional[Before]

after: typing.Optional[After]

ascending: typing.Optional[Ascending]

include_spam: typing.Optional[IncludeSpam]

include_blocked: typing.Optional[IncludeBlocked]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.threads.get(...) -> AsyncHttpResponse[Thread]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.threads.get(
    thread_id="thread_id",
)

⚙️ Parameters

thread_id: ThreadId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.threads.get_attachment(...) -> AsyncHttpResponse[AttachmentResponse]

🔌 Usage

from agentmail import AgentMail

client = AgentMail(
    api_key="YOUR_API_KEY",
)
client.threads.get_attachment(
    thread_id="thread_id",
    attachment_id="attachment_id",
)

⚙️ Parameters

thread_id: ThreadId

attachment_id: AttachmentId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.