agentmail4k/com.agentmail4k.sdk

Package-level declarations

Types

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.

AgentMailConfig

data class AgentMailConfig(val apiKey: String, val baseUrl: String, val timeout: TimeoutConfig, val retry: RetryConfig, val perSenderRateLimiter: RateLimiterConfig? = null, val perRecipientRateLimiter: RateLimiterConfig? = null)

Immutable configuration for the AgentMail HTTP client.

AgentMailConfigBuilder

class AgentMailConfigBuilder

DSL builder for configuring an AgentMailClient instance. Allows setting the API key, base URL, timeout, and retry settings.

AgentMailDsl

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class AgentMailDsl

DSL marker annotation used to restrict scope in AgentMail builder lambdas.

RateLimitAction

enum RateLimitAction : Enum<RateLimitAction>

Action to take when a rate limit is exceeded.

RateLimiterBuilder

class RateLimiterBuilder

DSL builder for configuring a per-key rate limiter with max messages and time window.

RateLimiterConfig

data class RateLimiterConfig(val maxMessages: Int, val window: Duration, val onLimitExceeded: RateLimitAction = RateLimitAction.STOP)

Immutable rate limiter configuration with max messages allowed within a sliding time window.

RateLimitExceededException

class RateLimitExceededException(val key: String, val maxMessages: Int, val window: Duration) : RuntimeException

Thrown when a rate limit is exceeded and the action is RateLimitAction.STOP.

RetryBuilder

class RetryBuilder

DSL builder for configuring HTTP retry behavior.

RetryConfig

data class RetryConfig(val maxRetries: Int, val retryOnServerErrors: Boolean)

Immutable retry configuration with max retries and server error retry toggle.

TimeoutBuilder

class TimeoutBuilder

DSL builder for configuring HTTP timeout durations.

TimeoutConfig

data class TimeoutConfig(val connect: Duration, val request: Duration, val socket: Duration)

Immutable timeout configuration with connect, request, and socket durations.