agentmail4k/com.agentmail4k.sdk.model

Package-level declarations

Types

@Serializable

data class ApiKey(val apiKeyId: String, val name: String? = null, val updatedAt: Instant, val createdAt: Instant)

Represents an API key with its ID, optional name, and timestamps.

@Serializable

data class ApiKeyList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val apiKeys: List<ApiKey>)

Paginated list of API keys.

Attachment

@Serializable

data class Attachment(val attachmentId: String, val filename: String? = null, val size: Int, val contentType: String? = null, val contentDisposition: ContentDisposition? = null, val contentId: String? = null)

Metadata for an email attachment including filename, size, content type, and disposition.

AttachmentData

data class AttachmentData(val data: ByteArray, val contentType: String)

Raw attachment binary data with its content type.

ContentDisposition

@Serializable

enum ContentDisposition : Enum<ContentDisposition>

Disposition type for email attachments: inline or attachment.

CreateApiKeyResponse

@Serializable

data class CreateApiKeyResponse(val apiKeyId: String, val apiKey: String)

Response from creating an API key, containing the key ID and secret value.

Domain

@Serializable

data class Domain(val domainId: String, val name: String, val verified: Boolean, val updatedAt: Instant, val createdAt: Instant)

Represents a custom email domain with its verification status and timestamps.

DomainList

@Serializable

data class DomainList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val domains: List<Domain>)

Paginated list of domains.

Draft

@Serializable

data class Draft(val inboxId: String, val draftId: String, val labels: List<String> = emptyList(), val timestamp: Instant, val from: String? = null, val to: List<String> = emptyList(), val cc: List<String> = emptyList(), val bcc: List<String> = emptyList(), val subject: String? = null, val preview: String? = null, val text: String? = null, val html: String? = null, val attachments: List<Attachment> = emptyList(), val updatedAt: Instant, val createdAt: Instant)

Represents an email draft with recipients, subject, body content, and attachments.

DraftList

@Serializable

data class DraftList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val drafts: List<Draft>)

Paginated list of drafts.

Inbox

@Serializable

data class Inbox(val podId: String? = null, val inboxId: String, val email: String, val displayName: String? = null, val clientId: String? = null, val updatedAt: Instant, val createdAt: Instant)

Represents an email inbox with its address, display name, and optional pod/client association.

InboxList

@Serializable

data class InboxList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val inboxes: List<Inbox>)

Paginated list of inboxes.

ListDirection

enum ListDirection : Enum<ListDirection>

Direction for list filtering: allow or block.

ListEntry

@Serializable

data class ListEntry(val entry: String, val updatedAt: Instant, val createdAt: Instant)

Represents an entry in an allow/block list.

ListEntryList

@Serializable

data class ListEntryList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val entries: List<ListEntry>)

Paginated list of list entries.

ListType

enum ListType : Enum<ListType>

Type of list entry: sender, recipient, domain, or subject.

Message

@Serializable

data class Message(val inboxId: String, val threadId: String, val messageId: String, val labels: List<String> = emptyList(), val timestamp: Instant, val from: String, val to: List<String> = emptyList(), val cc: List<String> = emptyList(), val bcc: List<String> = emptyList(), val subject: String? = null, val preview: String? = null, val text: String? = null, val html: String? = null, val attachments: List<Attachment> = emptyList(), val inReplyTo: String? = null, val references: List<String> = emptyList(), val headers: Map<String, String> = emptyMap(), val size: Int, val updatedAt: Instant, val createdAt: Instant)

Represents a complete email message with headers, body, attachments, and metadata.

MessageList

@Serializable

data class MessageList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val messages: List<Message>)

Paginated list of messages.

Metric

@Serializable

data class Metric(val eventType: String, val count: Int, val timestamp: Instant)

A single metric data point with event type, count, and timestamp.

MetricsPeriod

enum MetricsPeriod : Enum<MetricsPeriod>

Time period for metric aggregation: hour, day, week, or month.

Organization

@Serializable

data class Organization(val updatedAt: Instant, val createdAt: Instant)

Represents an organization with its timestamps.

Pod

@Serializable

data class Pod(val podId: String, val updatedAt: Instant, val createdAt: Instant)

Represents a pod (isolated workspace) with its ID and timestamps.

PodList

@Serializable

data class PodList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val pods: List<Pod>)

Paginated list of pods.

PodListEntry

@Serializable

data class PodListEntry(val entry: String, val updatedAt: Instant, val createdAt: Instant)

Represents a pod-level entry in an allow/block list.

PodListEntryList

@Serializable

data class PodListEntryList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val entries: List<PodListEntry>)

Paginated list of pod-level list entries.

QueryMetricsResponse

@Serializable

data class QueryMetricsResponse(val metrics: List<Metric>)

Response containing a list of aggregated email event metrics.

RawMessageResponse

@Serializable

data class RawMessageResponse(val raw: String)

Response containing the raw RFC 2822 message content.

SendMessageResponse

@Serializable

data class SendMessageResponse(val messageId: String, val threadId: String)

Response from sending a message, containing the message and thread IDs.

Thread

@Serializable

data class Thread(val inboxId: String, val threadId: String, val labels: List<String> = emptyList(), val timestamp: Instant, val receivedTimestamp: Instant? = null, val sentTimestamp: Instant? = null, val senders: List<String> = emptyList(), val recipients: List<String> = emptyList(), val subject: String? = null, val preview: String? = null, val attachments: List<Attachment> = emptyList(), val lastMessageId: String, val messageCount: Int, val size: Int, val updatedAt: Instant, val createdAt: Instant)

Represents an email thread with participants, subject, message count, and attachments.

ThreadList

@Serializable

data class ThreadList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val threads: List<Thread>)

Paginated list of threads.

UpdateMessageResponse

@Serializable

data class UpdateMessageResponse(val messageId: String, val labels: List<String> = emptyList())

Response from updating a message, containing the message ID and updated labels.

Webhook

@Serializable

data class Webhook(val webhookId: String, val url: String, val events: List<String> = emptyList(), val updatedAt: Instant, val createdAt: Instant)

Represents a webhook subscription with its target URL and subscribed events.

WebhookEvent

enum WebhookEvent : Enum<WebhookEvent>

Supported webhook event types for message and domain lifecycle events.

WebhookList

@Serializable

data class WebhookList(val count: Int, val limit: Int? = null, val nextPageToken: String? = null, val webhooks: List<Webhook>)

Paginated list of webhooks.