api.md

Inboxes

Params Types:

• agentmail.CreateInboxParam
• agentmail.MetricEventType

Response Types:

• agentmail.Inbox
• agentmail.ListInboxes
• agentmail.ListMetrics

Methods:

• client.Inboxes.New(ctx context.Context, body agentmail.InboxNewParams) (*agentmail.Inbox, error)
• client.Inboxes.Get(ctx context.Context, inboxID string) (*agentmail.Inbox, error)
• client.Inboxes.Update(ctx context.Context, inboxID string, body agentmail.InboxUpdateParams) (*agentmail.Inbox, error)
• client.Inboxes.List(ctx context.Context, query agentmail.InboxListParams) (*agentmail.ListInboxes, error)
• client.Inboxes.Delete(ctx context.Context, inboxID string) error
• client.Inboxes.ListMetrics(ctx context.Context, inboxID string, query agentmail.InboxListMetricsParams) (*agentmail.ListMetrics, error)

Drafts

Params Types:

• agentmail.UpdateMessageParam

Response Types:

• agentmail.SendMessageResponse

Methods:

• client.Inboxes.Drafts.New(ctx context.Context, inboxID string, body agentmail.InboxDraftNewParams) (*agentmail.Draft, error)
• client.Inboxes.Drafts.Get(ctx context.Context, draftID string, query agentmail.InboxDraftGetParams) (*agentmail.Draft, error)
• client.Inboxes.Drafts.Update(ctx context.Context, draftID string, params agentmail.InboxDraftUpdateParams) (*agentmail.Draft, error)
• client.Inboxes.Drafts.List(ctx context.Context, inboxID string, query agentmail.InboxDraftListParams) (*agentmail.ListDrafts, error)
• client.Inboxes.Drafts.Delete(ctx context.Context, draftID string, body agentmail.InboxDraftDeleteParams) error
• client.Inboxes.Drafts.Send(ctx context.Context, draftID string, params agentmail.InboxDraftSendParams) (*agentmail.SendMessageResponse, error)

Messages

Params Types:

• agentmail.AddressesUnionParam
• agentmail.AttachmentContentDisposition
• agentmail.SendAttachmentParam
• agentmail.SendMessageRequestParam

Response Types:

• agentmail.AttachmentContentDisposition
• agentmail.AttachmentResponse
• agentmail.Message
• agentmail.InboxMessageListResponse

Methods:

• client.Inboxes.Messages.Get(ctx context.Context, messageID string, query agentmail.InboxMessageGetParams) (*agentmail.Message, error)
• client.Inboxes.Messages.Update(ctx context.Context, messageID string, params agentmail.InboxMessageUpdateParams) (*agentmail.Message, error)
• client.Inboxes.Messages.List(ctx context.Context, inboxID string, query agentmail.InboxMessageListParams) (*agentmail.InboxMessageListResponse, error)
• client.Inboxes.Messages.Forward(ctx context.Context, messageID string, params agentmail.InboxMessageForwardParams) (*agentmail.SendMessageResponse, error)
• client.Inboxes.Messages.GetAttachment(ctx context.Context, attachmentID string, query agentmail.InboxMessageGetAttachmentParams) (*agentmail.AttachmentResponse, error)
• client.Inboxes.Messages.GetRaw(ctx context.Context, messageID string, query agentmail.InboxMessageGetRawParams) error
• client.Inboxes.Messages.Reply(ctx context.Context, messageID string, params agentmail.InboxMessageReplyParams) (*agentmail.SendMessageResponse, error)
• client.Inboxes.Messages.ReplyAll(ctx context.Context, messageID string, params agentmail.InboxMessageReplyAllParams) (*agentmail.SendMessageResponse, error)
• client.Inboxes.Messages.Send(ctx context.Context, inboxID string, body agentmail.InboxMessageSendParams) (*agentmail.SendMessageResponse, error)

Threads

Response Types:

• agentmail.ListThreads
• agentmail.Thread

Methods:

• client.Inboxes.Threads.Get(ctx context.Context, threadID string, query agentmail.InboxThreadGetParams) (*agentmail.Thread, error)
• client.Inboxes.Threads.List(ctx context.Context, inboxID string, query agentmail.InboxThreadListParams) (*agentmail.ListThreads, error)
• client.Inboxes.Threads.Delete(ctx context.Context, threadID string, body agentmail.InboxThreadDeleteParams) error
• client.Inboxes.Threads.GetAttachment(ctx context.Context, attachmentID string, query agentmail.InboxThreadGetAttachmentParams) (*agentmail.AttachmentResponse, error)

Pods

Response Types:

• agentmail.Pod
• agentmail.PodListResponse

Methods:

• client.Pods.New(ctx context.Context, body agentmail.PodNewParams) (*agentmail.Pod, error)
• client.Pods.Get(ctx context.Context, podID string) (*agentmail.Pod, error)
• client.Pods.List(ctx context.Context, query agentmail.PodListParams) (*agentmail.PodListResponse, error)
• client.Pods.Delete(ctx context.Context, podID string) error

Domains

Methods:

• client.Pods.Domains.New(ctx context.Context, podID string, body agentmail.PodDomainNewParams) (*agentmail.Domain, error)
• client.Pods.Domains.List(ctx context.Context, podID string, query agentmail.PodDomainListParams) (*agentmail.ListDomains, error)
• client.Pods.Domains.Delete(ctx context.Context, domainID string, body agentmail.PodDomainDeleteParams) error

Drafts

Methods:

• client.Pods.Drafts.Get(ctx context.Context, draftID string, query agentmail.PodDraftGetParams) (*agentmail.Draft, error)
• client.Pods.Drafts.List(ctx context.Context, podID string, query agentmail.PodDraftListParams) (*agentmail.ListDrafts, error)

Inboxes

Methods:

• client.Pods.Inboxes.New(ctx context.Context, podID string, body agentmail.PodInboxNewParams) (*agentmail.Inbox, error)
• client.Pods.Inboxes.Get(ctx context.Context, inboxID string, query agentmail.PodInboxGetParams) (*agentmail.Inbox, error)
• client.Pods.Inboxes.List(ctx context.Context, podID string, query agentmail.PodInboxListParams) (*agentmail.ListInboxes, error)
• client.Pods.Inboxes.Delete(ctx context.Context, inboxID string, body agentmail.PodInboxDeleteParams) error

Threads

Methods:

• client.Pods.Threads.Get(ctx context.Context, threadID string, query agentmail.PodThreadGetParams) (*agentmail.Thread, error)
• client.Pods.Threads.List(ctx context.Context, podID string, query agentmail.PodThreadListParams) (*agentmail.ListThreads, error)
• client.Pods.Threads.GetAttachment(ctx context.Context, attachmentID string, query agentmail.PodThreadGetAttachmentParams) (*agentmail.AttachmentResponse, error)

Webhooks

Params Types:

• agentmail.EventType

Response Types:

• agentmail.EventType
• agentmail.Webhook
• agentmail.WebhookListResponse

Methods:

• client.Webhooks.New(ctx context.Context, body agentmail.WebhookNewParams) (*agentmail.Webhook, error)
• client.Webhooks.Get(ctx context.Context, webhookID string) (*agentmail.Webhook, error)
• client.Webhooks.Update(ctx context.Context, webhookID string, body agentmail.WebhookUpdateParams) (*agentmail.Webhook, error)
• client.Webhooks.List(ctx context.Context, query agentmail.WebhookListParams) (*agentmail.WebhookListResponse, error)
• client.Webhooks.Delete(ctx context.Context, webhookID string) error

APIKeys

Response Types:

• agentmail.APIKeyNewResponse
• agentmail.APIKeyListResponse

Methods:

• client.APIKeys.New(ctx context.Context, body agentmail.APIKeyNewParams) (*agentmail.APIKeyNewResponse, error)
• client.APIKeys.List(ctx context.Context, query agentmail.APIKeyListParams) (*agentmail.APIKeyListResponse, error)
• client.APIKeys.Delete(ctx context.Context, apiKey string) error

Domains

Params Types:

• agentmail.CreateDomainParam

Response Types:

• agentmail.Domain
• agentmail.ListDomains

Methods:

• client.Domains.New(ctx context.Context, body agentmail.DomainNewParams) (*agentmail.Domain, error)
• client.Domains.Get(ctx context.Context, domainID string) (*agentmail.Domain, error)
• client.Domains.List(ctx context.Context, query agentmail.DomainListParams) (*agentmail.ListDomains, error)
• client.Domains.Delete(ctx context.Context, domainID string) error
• client.Domains.GetZoneFile(ctx context.Context, domainID string) error
• client.Domains.Verify(ctx context.Context, domainID string) error

Drafts

Response Types:

• agentmail.AttachmentFile
• agentmail.Draft
• agentmail.DraftSendStatus
• agentmail.ListDrafts

Methods:

• client.Drafts.Get(ctx context.Context, draftID string) (*agentmail.Draft, error)
• client.Drafts.List(ctx context.Context, query agentmail.DraftListParams) (*agentmail.ListDrafts, error)

Metrics

Methods:

• client.Metrics.List(ctx context.Context, query agentmail.MetricListParams) (*agentmail.ListMetrics, error)

Organizations

Response Types:

• agentmail.OrganizationGetResponse

Methods:

• client.Organizations.Get(ctx context.Context) (*agentmail.OrganizationGetResponse, error)

Threads

Methods:

• client.Threads.Get(ctx context.Context, threadID string) (*agentmail.Thread, error)
• client.Threads.List(ctx context.Context, query agentmail.ThreadListParams) (*agentmail.ListThreads, error)
• client.Threads.GetAttachment(ctx context.Context, attachmentID string, query agentmail.ThreadGetAttachmentParams) (*agentmail.AttachmentResponse, error)