agentmail4k/com.agentmail4k.sdk/AgentMailClient

AgentMailClient

Main entry point for the AgentMail SDK. Holds all top-level API resources (inboxes, threads, drafts, domains, pods, webhooks, lists, metrics, apiKeys, organization). Created via companion object invoke with optional DSL configuration. Implements Closeable to release the underlying HTTP client. Supports scoped access via inboxes and pods for nested resources.

Types

Companion

object Companion

Properties

apiKeys

val apiKeys: ApiKeyResource

domains

val domains: DomainResource

drafts

val drafts: DraftResource

inboxes

val inboxes: InboxResource

lists

val lists: ListResource

metrics

val metrics: MetricsResource

organization

val organization: OrganizationResource

pods

val pods: PodResource

threads

val threads: ThreadResource

webhooks

val webhooks: WebhookResource

Functions

autoReply

fun AgentMailClient.autoReply(inboxId: String, scope: CoroutineScope = CoroutineScope(Dispatchers.Default + SupervisorJob()), block: AutoReplyBuilder.() -> Unit): Job

Starts an auto-reply monitor on the given inbox that automatically replies to incoming messages based on configured rules.

bulk

suspend fun AgentMailClient.bulk(block: BulkBuilder.() -> Unit): List<SendMessageResponse>

Executes a batch of send and thread-iteration operations.

open override fun close()

Closes the underlying HTTP client and releases resources.

createApiKey

suspend fun AgentMailClient.createApiKey(block: CreateApiKeyBuilder.() -> Unit = {}): CreateApiKeyResponse

Creates a new API key.

createDomain

suspend fun AgentMailClient.createDomain(block: CreateDomainBuilder.() -> Unit): Domain

Creates a new custom domain.

createDraft

suspend fun AgentMailClient.createDraft(inboxId: String, block: CreateDraftBuilder.() -> Unit): Draft

Creates a new draft in an inbox.

createInbox

suspend fun AgentMailClient.createInbox(username: String, domain: String, displayName: String): Inbox

Creates a new inbox with the given username, domain, and display name.

createListEntry

suspend fun AgentMailClient.createListEntry(direction: ListDirection, type: ListType, block: CreateListEntryBuilder.() -> Unit): ListEntry

Creates a new allow/block list entry.

createPod

suspend fun AgentMailClient.createPod(): Pod

Creates a new pod.

createWebhook

suspend fun AgentMailClient.createWebhook(block: CreateWebhookBuilder.() -> Unit): Webhook

Creates a new webhook.

deleteApiKey

suspend fun AgentMailClient.deleteApiKey(apiKeyId: String)

Deletes an API key by ID.

deleteDomain

suspend fun AgentMailClient.deleteDomain(domainId: String)

Deletes a domain by ID.

deleteDraft

suspend fun AgentMailClient.deleteDraft(inboxId: String, draftId: String)

Deletes a draft by inbox and draft ID.

deleteInbox

suspend fun AgentMailClient.deleteInbox(inboxId: String)

Deletes an inbox by ID.

deleteListEntry

suspend fun AgentMailClient.deleteListEntry(direction: ListDirection, type: ListType, entry: String)

Deletes a specific list entry.

deletePod

suspend fun AgentMailClient.deletePod(podId: String)

Deletes a pod by ID.

deleteThread

suspend fun AgentMailClient.deleteThread(inboxId: String, threadId: String, block: DeleteThreadBuilder.() -> Unit = {})

Deletes a thread by inbox and thread ID.

deleteWebhook

suspend fun AgentMailClient.deleteWebhook(webhookId: String)

Deletes a webhook by ID.

forwardMessage

suspend fun AgentMailClient.forwardMessage(message: Message, block: ForwardMessageBuilder.() -> Unit): SendMessageResponse?

Forwards a message to new recipients. Returns null if rate-limited with SKIP.

getAttachment

suspend fun AgentMailClient.getAttachment(message: Message, attachmentId: String): AttachmentData

Retrieves a message attachment's binary data.

getDomain

suspend fun AgentMailClient.getDomain(domainId: String): Domain

Retrieves a domain by ID.

getDomainZoneFile

suspend fun AgentMailClient.getDomainZoneFile(domainId: String): ByteArray

Retrieves the DNS zone file for a domain.

getDraft

suspend fun AgentMailClient.getDraft(inboxId: String, draftId: String): Draft

Retrieves a draft by inbox and draft ID.

getDraftAttachment

suspend fun AgentMailClient.getDraftAttachment(inboxId: String, draftId: String, attachmentId: String): AttachmentData

Retrieves a draft attachment's binary data.

getInbox

suspend fun AgentMailClient.getInbox(inboxId: String): Inbox

Retrieves an inbox by ID.

getListEntry

suspend fun AgentMailClient.getListEntry(direction: ListDirection, type: ListType, entry: String): ListEntry

Retrieves a specific list entry.

getOrganization

suspend fun AgentMailClient.getOrganization(): Organization

Retrieves the current organization's details.

getPod

suspend fun AgentMailClient.getPod(podId: String): Pod

Retrieves a pod by ID.

getRawMessage

suspend fun AgentMailClient.getRawMessage(message: Message): RawMessageResponse

Retrieves the raw RFC 2822 content of a message.

getThread

suspend fun AgentMailClient.getThread(inboxId: String, threadId: String): Thread

Retrieves a thread by inbox and thread ID.

getThreadAttachment

suspend fun AgentMailClient.getThreadAttachment(inboxId: String, threadId: String, attachmentId: String): AttachmentData

Retrieves a thread attachment's binary data.

getWebhook

suspend fun AgentMailClient.getWebhook(webhookId: String): Webhook

Retrieves a webhook by ID.

inboxes

fun inboxes(inboxId: String): InboxScope

Returns an InboxScope for accessing resources nested under the given inbox.

listApiKeys

suspend fun AgentMailClient.listApiKeys(block: ListApiKeysBuilder.() -> Unit = {}): ApiKeyList

Lists all API keys with optional pagination.

listDomains

suspend fun AgentMailClient.listDomains(block: ListDomainsBuilder.() -> Unit = {}): DomainList

Lists all custom domains with optional pagination.

listDrafts

suspend fun AgentMailClient.listDrafts(inboxId: String, block: ListDraftsBuilder.() -> Unit = {}): DraftList

Lists drafts in an inbox with optional pagination and filtering.

listEntries

suspend fun AgentMailClient.listEntries(direction: ListDirection, type: ListType, block: ListEntriesBuilder.() -> Unit = {}): ListEntryList

Lists allow/block entries for a given direction and type.

listInboxes

suspend fun AgentMailClient.listInboxes(block: ListInboxesBuilder.() -> Unit = {}): InboxList

Lists all inboxes with optional pagination.

listMessages

suspend fun AgentMailClient.listMessages(inboxId: String, block: ListMessagesBuilder.() -> Unit = {}): MessageList

Lists messages in an inbox with optional pagination and filtering.

listPods

suspend fun AgentMailClient.listPods(block: ListPodsBuilder.() -> Unit = {}): PodList

Lists all pods with optional pagination.

listThreads

suspend fun AgentMailClient.listThreads(inboxId: String, block: ListThreadsBuilder.() -> Unit = {}): ThreadList

Lists threads in an inbox with optional pagination and filtering.

listWebhooks

suspend fun AgentMailClient.listWebhooks(block: ListWebhooksBuilder.() -> Unit = {}): WebhookList

Lists all webhooks with optional pagination.

monitor

fun AgentMailClient.monitor(inboxId: String, scope: CoroutineScope = CoroutineScope(Dispatchers.Default + SupervisorJob()), block: MonitorBuilder.() -> Unit): Job

Starts a coroutine that polls an inbox for new messages and invokes handlers.

pods

fun pods(podId: String): PodScope

Returns a PodScope for accessing resources nested under the given pod.

poll

fun AgentMailClient.poll(inboxId: String, interval: Duration = 10.seconds, filter: (Message) -> Boolean? = null, scope: CoroutineScope = CoroutineScope(Dispatchers.Default + SupervisorJob()), handler: suspend (Message) -> Unit): Job

Simplified inbox polling that invokes a handler for each new message at a fixed interval.

queryMetrics

suspend fun AgentMailClient.queryMetrics(block: QueryMetricsBuilder.() -> Unit = {}): QueryMetricsResponse

Queries email event metrics with optional filters.

replyAllToMessage

suspend fun AgentMailClient.replyAllToMessage(message: Message, block: ReplyAllBuilder.() -> Unit): SendMessageResponse?

Sends a reply-all to a specific message. Returns null if rate-limited with SKIP.

replyToMessage

suspend fun AgentMailClient.replyToMessage(message: Message, block: ReplyBuilder.() -> Unit): SendMessageResponse?

Sends a reply to a specific message. Returns null if rate-limited with SKIP.

sendDraft

suspend fun AgentMailClient.sendDraft(inboxId: String, draftId: String, block: SendDraftBuilder.() -> Unit = {}): SendMessageResponse

Sends a draft as an email message.

sendMessage

suspend fun AgentMailClient.sendMessage(block: SendMessage.() -> Unit): SendMessageResponse?

Sends an email message from an inbox to recipients. Returns null if rate-limited with SKIP.

toFullMessage

suspend fun AgentMailClient.toFullMessage(message: Message): Message

Fetches the full message content for a message (useful after listing which returns previews).

updateDomain

suspend fun AgentMailClient.updateDomain(domainId: String, block: UpdateDomainBuilder.() -> Unit): Domain

Updates a domain by ID.

updateDraft

suspend fun AgentMailClient.updateDraft(inboxId: String, draftId: String, block: UpdateDraftBuilder.() -> Unit): Draft

Updates a draft by inbox and draft ID.

updateInbox

suspend fun AgentMailClient.updateInbox(inboxId: String, block: UpdateInboxBuilder.() -> Unit): Inbox

Updates an inbox by ID.

updateMessage

suspend fun AgentMailClient.updateMessage(message: Message, block: UpdateMessageBuilder.() -> Unit): UpdateMessageResponse

Updates a message's labels.

updateWebhook

suspend fun AgentMailClient.updateWebhook(webhookId: String, block: UpdateWebhookBuilder.() -> Unit): Webhook

Updates a webhook by ID.

verifyDomain

suspend fun AgentMailClient.verifyDomain(domainId: String)

Triggers DNS verification for a domain.