reference.md

Reference

Inboxes

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

🔌 Usage

await client.inboxes.list();

⚙️ Parameters

request: AgentMail.inboxes.ListInboxesRequest

requestOptions: InboxesClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

inbox_id: AgentMail.InboxId

requestOptions: InboxesClient.RequestOptions

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

🔌 Usage

await client.inboxes.create(undefined);

⚙️ Parameters

request: AgentMail.CreateInboxRequest

requestOptions: InboxesClient.RequestOptions

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

🔌 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

🔌 Usage

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

⚙️ Parameters

inbox_id: AgentMail.InboxId

requestOptions: InboxesClient.RequestOptions

Pods

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

🔌 Usage

await client.pods.list();

⚙️ Parameters

request: AgentMail.pods.ListPodsRequest

requestOptions: PodsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

pod_id: AgentMail.PodId

requestOptions: PodsClient.RequestOptions

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

🔌 Usage

await client.pods.create({});

⚙️ Parameters

request: AgentMail.CreatePodRequest

requestOptions: PodsClient.RequestOptions

client.pods.delete(pod_id) -> void

🔌 Usage

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

⚙️ Parameters

pod_id: AgentMail.PodId

requestOptions: PodsClient.RequestOptions

Webhooks

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

🔌 Usage

await client.webhooks.list();

⚙️ Parameters

request: AgentMail.webhooks.ListWebhooksRequest

requestOptions: WebhooksClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

webhook_id: AgentMail.WebhookId

requestOptions: WebhooksClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

webhook_id: AgentMail.WebhookId

request: AgentMail.UpdateWebhookRequest

requestOptions: WebhooksClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: AgentMail.CreateWebhookRequest

requestOptions: WebhooksClient.RequestOptions

client.webhooks.delete(webhook_id) -> void

🔌 Usage

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

⚙️ Parameters

webhook_id: AgentMail.WebhookId

requestOptions: WebhooksClient.RequestOptions

ApiKeys

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

🔌 Usage

await client.apiKeys.list();

⚙️ Parameters

request: AgentMail.ListApiKeysRequest

requestOptions: ApiKeysClient.RequestOptions

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

🔌 Usage

await client.apiKeys.create({
    name: "name"
});

⚙️ Parameters

request: AgentMail.CreateApiKeyRequest

requestOptions: ApiKeysClient.RequestOptions

client.apiKeys.delete(api_key) -> void

🔌 Usage

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

⚙️ Parameters

api_key: AgentMail.ApiKeyId

requestOptions: ApiKeysClient.RequestOptions

Domains

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

🔌 Usage

await client.domains.list();

⚙️ Parameters

request: AgentMail.ListDomainsRequest

requestOptions: DomainsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: AgentMail.CreateDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.delete(domain_id) -> void

🔌 Usage

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

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

client.domains.verify(domain_id) -> void

🔌 Usage

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

⚙️ Parameters

domain_id: AgentMail.DomainId

requestOptions: DomainsClient.RequestOptions

Drafts

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

🔌 Usage

await client.drafts.list();

⚙️ Parameters

request: AgentMail.ListDraftsRequest

requestOptions: DraftsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

draft_id: AgentMail.DraftId

requestOptions: DraftsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

draft_id: AgentMail.DraftId

attachment_id: AgentMail.AttachmentId

requestOptions: DraftsClient.RequestOptions

Inboxes Drafts

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

🔌 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

🔌 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

🔌 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

🔌 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

🔌 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.send(inbox_id, draft_id, { ...params }) -> AgentMail.SendMessageResponse

🔌 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

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

🔌 Usage

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

⚙️ Parameters

inbox_id: AgentMail.InboxId

draft_id: AgentMail.DraftId

requestOptions: DraftsClient.RequestOptions

Inboxes Messages

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

🔌 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

🔌 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

🔌 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) -> core.BinaryResponse

🔌 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.send(inbox_id, { ...params }) -> AgentMail.SendMessageResponse

🔌 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

🔌 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

🔌 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

🔌 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

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

🔌 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

Inboxes Metrics

client.inboxes.metrics.get(inbox_id, { ...params }) -> AgentMail.ListMetricsResponse

🔌 Usage

await client.inboxes.metrics.get("inbox_id", {
    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
    endTimestamp: new Date("2024-01-15T09:30:00.000Z")
});

⚙️ Parameters

inbox_id: AgentMail.InboxId

request: AgentMail.inboxes.ListInboxMetricsRequest

requestOptions: MetricsClient.RequestOptions

Inboxes Threads

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

🔌 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

🔌 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

🔌 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.delete(inbox_id, thread_id) -> void

🔌 Usage

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

⚙️ Parameters

inbox_id: AgentMail.InboxId

thread_id: AgentMail.ThreadId

requestOptions: ThreadsClient.RequestOptions

Lists

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

🔌 Usage

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

⚙️ Parameters

direction: AgentMail.Direction

type: AgentMail.ListType

request: AgentMail.CreateListEntryRequest

requestOptions: ListsClient.RequestOptions

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

🔌 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

🔌 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.delete(direction, type, entry) -> void

🔌 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.list({ ...params }) -> AgentMail.ListMetricsResponse

🔌 Usage

await client.metrics.list({
    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
    endTimestamp: new Date("2024-01-15T09:30:00.000Z")
});

⚙️ Parameters

request: AgentMail.ListMetricsRequest

requestOptions: MetricsClient.RequestOptions

Organizations

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

📝 Description

Get the current organization.

🔌 Usage

await client.organizations.get();

⚙️ Parameters

requestOptions: OrganizationsClient.RequestOptions

Pods Domains

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

🔌 Usage

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

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.pods.ListDomainsRequest

requestOptions: DomainsClient.RequestOptions

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

🔌 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.delete(pod_id, domain_id) -> void

🔌 Usage

await client.pods.domains.delete("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

🔌 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

🔌 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

🔌 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

🔌 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

🔌 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

🔌 Usage

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

⚙️ Parameters

pod_id: AgentMail.PodId

request: AgentMail.CreateInboxRequest

requestOptions: InboxesClient.RequestOptions

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

🔌 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.create(pod_id, direction, type, { ...params }) -> AgentMail.PodListEntry

🔌 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.list(pod_id, direction, type, { ...params }) -> AgentMail.PodListListEntriesResponse

🔌 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

🔌 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.delete(pod_id, direction, type, entry) -> void

🔌 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 Threads

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

🔌 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

🔌 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

🔌 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

Threads

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

🔌 Usage

await client.threads.list();

⚙️ Parameters

request: AgentMail.ListThreadsRequest

requestOptions: ThreadsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

thread_id: AgentMail.ThreadId

requestOptions: ThreadsClient.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

thread_id: AgentMail.ThreadId

attachment_id: AgentMail.AttachmentId

requestOptions: ThreadsClient.RequestOptions