Skip to content

reference.md

Latest commit

 

History

History
4344 lines (2962 loc) · 48 KB

reference.md

File metadata and controls

4344 lines (2962 loc) · 48 KB
Raw

Reference

agent

client.agent.bootstrap(...) -> BootstrapResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.agent.bootstrap()

⚙️ Parameters

requested_local_part: typing.Optional[str]

pod_name: typing.Optional[str]

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

client.agent.sign_up(...) -> SignUpAgentResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.agent.sign_up(
    human_email="human_email",
    username="username",
)

⚙️ Parameters

human_email: str

username: str

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

inboxes

client.inboxes.list(...) -> ListInboxesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.inboxes.list()

⚙️ Parameters

limit: typing.Optional[int]

page_token: typing.Optional[str]

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

client.inboxes.create(...) -> CreateInboxesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.inboxes.create()

⚙️ Parameters

username: typing.Optional[str]

pod_id: typing.Optional[str]

domain_id: typing.Optional[str]

client_id: typing.Optional[str]

display_name: typing.Optional[str]

metadata: typing.Optional[typing.Dict[str, InboxCreateMetadataValue]]

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

client.inboxes.get(...) -> GetInboxesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.inboxes.get(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

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

client.inboxes.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.inboxes.delete(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

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

client.inboxes.update(...) -> UpdateInboxesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.inboxes.update(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

display_name: typing.Optional[str]

client_id: typing.Optional[str]

metadata: typing.Optional[typing.Dict[str, typing.Optional[InboxUpdateMetadataValue]]]

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

client.inboxes.issue_credentials(...) -> IssueCredentialsInboxesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.inboxes.issue_credentials(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

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

messages

client.messages.list(...) -> ListMessagesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.list(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

limit: typing.Optional[int]

page_token: typing.Optional[str]

thread_id: typing.Optional[str]

label: typing.Optional[str]

query: typing.Optional[str]

before: typing.Optional[datetime.datetime]

after: typing.Optional[datetime.datetime]

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

client.messages.send(...) -> SendMessagesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.send(
    inbox_id="inboxId",
    to=[
        "to"
    ],
)

⚙️ Parameters

inbox_id: str

request: MessageCompose

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

client.messages.get(...) -> GetMessagesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.get(
    inbox_id="inboxId",
    message_id="messageId",
)

⚙️ Parameters

inbox_id: str

message_id: str

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

client.messages.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.delete(
    inbox_id="inboxId",
    message_id="messageId",
)

⚙️ Parameters

inbox_id: str

message_id: str

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

client.messages.reply(...) -> ReplyMessagesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.reply(
    inbox_id="inboxId",
    message_id="messageId",
)

⚙️ Parameters

inbox_id: str

message_id: str

request: ReplyCompose

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

client.messages.reply_all(...) -> ReplyAllMessagesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.reply_all(
    inbox_id="inboxId",
    message_id="messageId",
)

⚙️ Parameters

inbox_id: str

message_id: str

request: ReplyCompose

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

client.messages.forward(...) -> ForwardMessagesResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.messages.forward(
    inbox_id="inboxId",
    message_id="messageId",
    to=[
        "to"
    ],
)

⚙️ Parameters

inbox_id: str

message_id: str

request: MessageCompose

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

threads

client.threads.list(...) -> ListThreadsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.threads.list(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

limit: typing.Optional[int]

page_token: typing.Optional[str]

label: typing.Optional[str]

query: typing.Optional[str]

before: typing.Optional[datetime.datetime]

after: typing.Optional[datetime.datetime]

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

client.threads.get(...) -> GetThreadsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.threads.get(
    inbox_id="inboxId",
    thread_id="threadId",
)

⚙️ Parameters

inbox_id: str

thread_id: str

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

drafts

client.drafts.list(...) -> ListDraftsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.drafts.list(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

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

client.drafts.create(...) -> CreateDraftsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.drafts.create(
    inbox_id="inboxId",
)

⚙️ Parameters

inbox_id: str

to: typing.Optional[typing.List[DraftCreateToItem]]

cc: typing.Optional[typing.List[DraftCreateCcItem]]

bcc: typing.Optional[typing.List[DraftCreateBccItem]]

reply_to: typing.Optional[typing.List[DraftCreateReplyToItem]]

subject: typing.Optional[str]

text: typing.Optional[str]

html: typing.Optional[str]

headers: typing.Optional[typing.Dict[str, str]]

attachments: typing.Optional[typing.List[DraftCreateAttachmentsItem]]

reply_to_message_id: typing.Optional[str]

forward_message_id: typing.Optional[str]

send_at: typing.Optional[datetime.datetime]

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

client.drafts.get(...) -> GetDraftsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.drafts.get(
    inbox_id="inboxId",
    draft_id="draftId",
)

⚙️ Parameters

inbox_id: str

draft_id: str

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

client.drafts.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.drafts.delete(
    inbox_id="inboxId",
    draft_id="draftId",
)

⚙️ Parameters

inbox_id: str

draft_id: str

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

client.drafts.update(...) -> UpdateDraftsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.drafts.update(
    inbox_id="inboxId",
    draft_id="draftId",
)

⚙️ Parameters

inbox_id: str

draft_id: str

to: typing.Optional[typing.List[DraftUpdateToItem]]

cc: typing.Optional[typing.List[DraftUpdateCcItem]]

bcc: typing.Optional[typing.List[DraftUpdateBccItem]]

reply_to: typing.Optional[typing.List[DraftUpdateReplyToItem]]

subject: typing.Optional[str]

text: typing.Optional[str]

html: typing.Optional[str]

headers: typing.Optional[typing.Dict[str, str]]

attachments: typing.Optional[typing.List[DraftUpdateAttachmentsItem]]

reply_to_message_id: typing.Optional[str]

forward_message_id: typing.Optional[str]

send_at: typing.Optional[datetime.datetime]

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

client.drafts.send(...) -> SendDraftsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.drafts.send(
    inbox_id="inboxId",
    draft_id="draftId",
)

⚙️ Parameters

inbox_id: str

draft_id: str

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

attachments

client.attachments.upload(...) -> typing.Dict[str, typing.Any]

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.attachments.upload(
    inbox_id="inboxId",
    filename="filename",
    content_type="contentType",
    size=1,
    checksum_sha256="checksumSha256",
)

⚙️ Parameters

inbox_id: str

filename: str

content_type: str

size: int

checksum_sha256: str

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

client.attachments.complete(...) -> CompleteAttachmentsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.attachments.complete(
    inbox_id="inboxId",
    attachment_id="attachmentId",
)

⚙️ Parameters

inbox_id: str

attachment_id: str

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

client.attachments.download(...) -> DownloadAttachmentsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.attachments.download(
    inbox_id="inboxId",
    attachment_id="attachmentId",
)

⚙️ Parameters

inbox_id: str

attachment_id: str

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

pods

client.pods.list() -> ListPodsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.pods.list()

⚙️ Parameters

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

client.pods.create(...) -> CreatePodsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.pods.create(
    name="name",
)

⚙️ Parameters

name: str

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

client.pods.get(...) -> GetPodsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.pods.get(
    pod_id="podId",
)

⚙️ Parameters

pod_id: str

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

client.pods.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.pods.delete(
    pod_id="podId",
)

⚙️ Parameters

pod_id: str

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

client.pods.update(...) -> UpdatePodsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.pods.update(
    pod_id="podId",
    name="name",
)

⚙️ Parameters

pod_id: str

name: str

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

domains

client.domains.list() -> ListDomainsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.domains.list()

⚙️ Parameters

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

client.domains.create(...) -> CreateDomainsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.domains.create(
    domain="domain",
)

⚙️ Parameters

domain: str

pod_id: typing.Optional[str]

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

client.domains.get(...) -> GetDomainsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.domains.get(
    domain_id="domainId",
)

⚙️ Parameters

domain_id: str

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

client.domains.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.domains.delete(
    domain_id="domainId",
)

⚙️ Parameters

domain_id: str

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

client.domains.verify(...) -> VerifyDomainsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.domains.verify(
    domain_id="domainId",
)

⚙️ Parameters

domain_id: str

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

webhooks

client.webhooks.list() -> ListWebhooksResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.webhooks.list()

⚙️ Parameters

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

client.webhooks.create(...) -> CreateWebhooksResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.webhooks.create(
    url="url",
)

⚙️ Parameters

url: str

pod_id: typing.Optional[str]

inbox_id: typing.Optional[str]

event_types: typing.Optional[typing.List[WebhookCreateEventTypesItem]]

description: typing.Optional[str]

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

client.webhooks.get(...) -> GetWebhooksResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.webhooks.get(
    webhook_id="webhookId",
)

⚙️ Parameters

webhook_id: str

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

client.webhooks.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.webhooks.delete(
    webhook_id="webhookId",
)

⚙️ Parameters

webhook_id: str

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

client.webhooks.update(...) -> UpdateWebhooksResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.webhooks.update(
    webhook_id="webhookId",
)

⚙️ Parameters

webhook_id: str

url: typing.Optional[str]

event_types: typing.Optional[typing.List[WebhookUpdateEventTypesItem]]

description: typing.Optional[str]

enabled: typing.Optional[bool]

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

client.webhooks.rotate_secret(...) -> RotateSecretWebhooksResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.webhooks.rotate_secret(
    webhook_id="webhookId",
)

⚙️ Parameters

webhook_id: str

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

labels

client.labels.list(...) -> ListLabelsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.labels.list()

⚙️ Parameters

pod_id: typing.Optional[str]

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

client.labels.create(...) -> CreateLabelsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.labels.create(
    pod_id="podId",
    name="name",
)

⚙️ Parameters

pod_id: str

name: str

color: typing.Optional[str]

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

client.labels.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.labels.delete(
    label_id="labelId",
)

⚙️ Parameters

label_id: str

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

client.labels.update_message(...) -> UpdateMessageLabelsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.labels.update_message(
    message_id="messageId",
)

⚙️ Parameters

message_id: str

request: LabelMutation

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

client.labels.update_thread(...) -> UpdateThreadLabelsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.labels.update_thread(
    thread_id="threadId",
)

⚙️ Parameters

thread_id: str

request: LabelMutation

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

lists

client.lists.list(...) -> ListListsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.lists.list()

⚙️ Parameters

pod_id: typing.Optional[str]

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

client.lists.create(...) -> CreateListsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.lists.create(
    pod_id="podId",
    name="name",
    kind="allow",
)

⚙️ Parameters

pod_id: str

name: str

kind: ListCreateKind

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

client.lists.delete(...)

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.lists.delete(
    list_id="listId",
)

⚙️ Parameters

list_id: str

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

client.lists.add_entry(...) -> AddEntryListsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.lists.add_entry(
    list_id="listId",
    address_pattern="addressPattern",
)

⚙️ Parameters

list_id: str

address_pattern: str

note: typing.Optional[str]

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

client.lists.remove_entry(...) -> RemoveEntryListsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.lists.remove_entry(
    list_id="listId",
)

⚙️ Parameters

list_id: str

address_pattern: typing.Optional[str]

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

events

client.events.create_ticket(...) -> CreateTicketEventsResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.events.create_ticket(
    pod_id="podId",
)

⚙️ Parameters

pod_id: str

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

billing

client.billing.get() -> GetBillingResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.billing.get()

⚙️ Parameters

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

client.billing.create_checkout(...) -> CreateCheckoutBillingResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.billing.create_checkout()

⚙️ Parameters

inboxes: typing.Optional[int]

monthly_messages: typing.Optional[int]

custom_domains: typing.Optional[int]

interval: typing.Optional[BillingSelectionInterval]

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

client.billing.create_portal() -> CreatePortalBillingResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.billing.create_portal()

⚙️ Parameters

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

a2a

client.a2a.send_task(...) -> typing.Dict[str, typing.Any]

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.a2a.send_task(
    handle="handle",
    jsonrpc="2.0",
    method="method",
)

⚙️ Parameters

handle: str

jsonrpc: A2AJsonRpcRequestJsonrpc

method: str

id: typing.Optional[A2AJsonRpcRequestId]

params: typing.Optional[typing.Dict[str, typing.Any]]

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

client.a2a.get_agent_card(...) -> A2AAgentCard

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.a2a.get_agent_card(
    handle="handle",
)

⚙️ Parameters

handle: str

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

client.a2a.update_task(...) -> UpdateTaskA2AResponse

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.a2a.update_task(
    task_id="taskId",
    state="TASK_STATE_SUBMITTED",
)

⚙️ Parameters

task_id: str

state: A2ATaskUpdateState

message: typing.Optional[A2ATaskUpdateMessage]

artifacts: typing.Optional[typing.List[A2ATaskUpdateArtifactsItem]]

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

client.a2a.update_identity(...) -> typing.Dict[str, typing.Any]

🔌 Usage

from agentmailer import AgentMailer
from agentmailer.environment import AgentMailerEnvironment

client = AgentMailer(
    api_key="<token>",
    environment=AgentMailerEnvironment.DEFAULT,
)

client.a2a.update_identity()

⚙️ Parameters

publicly_discoverable: typing.Optional[bool]

admission_mode: typing.Optional[A2AIdentitySettingsAdmissionMode]

name: typing.Optional[str]

description: typing.Optional[str]

skills: typing.Optional[typing.List[A2AIdentitySettingsSkillsItem]]

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