anypost

package module

Go to main page

Versions in this module

v1

v1.4.0

Aug 3, 2026

Changes in this version

+ type WhoamiLimits struct

+ Daily int

+ DeliveryRatePerMinute int

+ Monthly int

type WhoamiResponse

+ Limits *WhoamiLimits

v1.3.0

Jul 30, 2026

Changes in this version

type Event

+ IPPool *string

type EventListParams

+ IPPool string

type SendEmailRequest

+ IPPool string

v1.2.0

Jun 20, 2026

Changes in this version

+ func String(v string) *string

v1.1.0

Jun 18, 2026

Changes in this version

type Event

+ Tracking *EventTracking

+ type EventBot struct

+ Kind string

+ Source string

+ type EventTracking struct

+ Bot *EventBot

v1.0.0

Jun 9, 2026

Changes in this version

+ const DefaultWebhookTolerance

+ const Version

+ func Bool(v bool) *bool

+ func VerifyWebhookSignature(payload []byte, signatureHeader, secret string, opts ...VerifyOption) error

+ type APIKey struct

+ AllowedDomains []string

+ AllowedIPs []string

+ CreatedAt string

+ ID string

+ KeyPrefix string

+ LastUsedAt *string

+ Name string

+ Permissions Permissions

+ type APIKeyCreateParams struct

+ AllowedDomains []string

+ AllowedIPs []string

+ Name string

+ Permissions Permissions

+ type APIKeyUpdateParams struct

+ AllowedDomains []string

+ AllowedIPs []string

+ Name string

+ Permissions Permissions

+ type APIKeyWithSecret struct

+ Key string

+ type APIKeysService struct

+ func (s *APIKeysService) Create(ctx context.Context, params *APIKeyCreateParams, opts ...RequestOption) (*APIKeyWithSecret, error)

+ func (s *APIKeysService) Delete(ctx context.Context, id string, opts ...RequestOption) error

+ func (s *APIKeysService) Get(ctx context.Context, id string, opts ...RequestOption) (*APIKey, error)

+ func (s *APIKeysService) List(ctx context.Context, params ListParams, opts ...RequestOption) (*Page[APIKey], error)

+ func (s *APIKeysService) Update(ctx context.Context, id string, params *APIKeyUpdateParams, ...) (*APIKey, error)

+ type Attachment struct

+ Content []byte

+ ContentID string

+ ContentType string

+ Filename string

+ type BatchItemError struct

+ Message string

+ Type string

+ type BatchItemResult struct

+ CreatedAt string

+ Error *BatchItemError

+ ID string

+ Index int

+ Status string

+ type BatchResponse struct

+ Data []BatchItemResult

+ Summary BatchSummary

+ type BatchSummary struct

+ Failed int

+ Queued int

+ Total int

+ type Client struct

+ APIKeys *APIKeysService

+ Domains *DomainsService

+ Email *EmailService

+ Events *EventsService

+ Suppressions *SuppressionsService

+ Templates *TemplatesService

+ Webhooks *WebhooksService

+ func New(apiKey string, opts ...Option) (*Client, error)

+ func (c *Client) Whoami(ctx context.Context, opts ...RequestOption) (*WhoamiResponse, error)

+ type DNSRecord struct

+ Name string

+ Purpose string

+ Type string

+ Value string

+ type Domain struct

+ CreatedAt string

+ DNSRecords []DNSRecord

+ ID string

+ Name string

+ Status string

+ Tracking DomainTracking

+ VerificationFailure *VerificationFailure

+ VerifiedAt *string

+ type DomainCreateParams struct

+ Name string

+ type DomainTracking struct

+ ClicksEnabled bool

+ DNSRecords []DNSRecord

+ OpensEnabled bool

+ Status string

+ Subdomain *string

+ VerificationFailure *VerificationFailure

+ VerifiedAt *string

+ type DomainTrackingParams struct

+ ClicksEnabled *bool

+ OpensEnabled *bool

+ Subdomain *string

+ type DomainUpdateParams struct

+ Tracking DomainTrackingParams

+ type DomainsService struct

+ func (s *DomainsService) Create(ctx context.Context, params *DomainCreateParams, opts ...RequestOption) (*Domain, error)

+ func (s *DomainsService) Delete(ctx context.Context, id string, opts ...RequestOption) error

+ func (s *DomainsService) Get(ctx context.Context, id string, opts ...RequestOption) (*Domain, error)

+ func (s *DomainsService) List(ctx context.Context, params ListParams, opts ...RequestOption) (*Page[Domain], error)

+ func (s *DomainsService) Update(ctx context.Context, id string, params *DomainUpdateParams, ...) (*Domain, error)

+ func (s *DomainsService) Verify(ctx context.Context, id string, opts ...RequestOption) (*Domain, error)

+ type EmailBatchRequest struct

+ Defaults *SendEmailRequest

+ Emails []SendEmailRequest

+ type EmailService struct

+ func (s *EmailService) Send(ctx context.Context, email *SendEmailRequest, opts ...RequestOption) (*SendResponse, error)

+ func (s *EmailService) SendBatch(ctx context.Context, batch *EmailBatchRequest, opts ...RequestOption) (*BatchResponse, error)

+ type Error struct

+ Body []byte

+ Message string

+ RequestID string

+ RetryAfter time.Duration

+ Status int

+ Type ErrorType

+ ValidationErrors map[string][]string

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type ErrorType string

+ const ErrorTypeAuthentication

+ const ErrorTypeConflict

+ const ErrorTypeConnection

+ const ErrorTypeIdempotencyConflict

+ const ErrorTypeIdempotencyMismatch

+ const ErrorTypeInternal

+ const ErrorTypeNotFound

+ const ErrorTypePayloadTooLarge

+ const ErrorTypePermission

+ const ErrorTypeProvisioning

+ const ErrorTypeRateLimit

+ const ErrorTypeValidation

+ const ErrorTypeWebhookRotation

+ type Event struct

+ Attempt *int

+ BounceClassification *string

+ BounceType *string

+ Campaign *string

+ EmailID *string

+ From *string

+ FromDomain *string

+ ID string

+ MessageID *string

+ OccurredAt string

+ Recipient *string

+ SMTPCode *int

+ Subject *string

+ Tags []string

+ TemplateID *string

+ Topic *string

+ Type EventType

+ type EventListParams struct

+ Campaign string

+ Domain string

+ EmailID string

+ End string

+ EventType EventType

+ MessageID string

+ Recipient string

+ Start string

+ Tags []string

+ TemplateID string

+ Topic string

+ type EventType string

+ const EventBounced

+ const EventClicked

+ const EventComplained

+ const EventDelayed

+ const EventDelivered

+ const EventOpened

+ const EventSent

+ const EventSuppressed

+ const EventUnsubscribed

+ type EventsService struct

+ func (s *EventsService) List(ctx context.Context, params EventListParams, opts ...RequestOption) (*Page[Event], error)

+ type IdentityService struct

+ func (s *IdentityService) Whoami(ctx context.Context, opts ...RequestOption) (*WhoamiResponse, error)

+ type ListParams struct

+ After string

+ Limit int

+ type Option func(*clientConfig)

+ func WithBaseURL(url string) Option

+ func WithDefaultHeader(name, value string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithMaxRetries(n int) Option

+ func WithTimeout(d time.Duration) Option

+ type Page struct

+ Data []T

+ HasMore bool

+ NextCursor string

+ func (p *Page[T]) All(ctx context.Context) iter.Seq2[T, error]

+ func (p *Page[T]) Next(ctx context.Context) (*Page[T], error)

+ type Permissions string

+ const PermissionFull

+ const PermissionSendOnly

+ type RequestOption func(*requestConfig)

+ func WithHeader(name, value string) RequestOption

+ func WithIdempotencyKey(key string) RequestOption

+ type SendEmailRequest struct

+ Attachments []Attachment

+ BCC []string

+ CC []string

+ Campaign string

+ From string

+ HTML string

+ Headers map[string]string

+ ReplyTo []string

+ Subject string

+ Tags []string

+ TemplateID string

+ Text string

+ To []string

+ Topic string

+ Tracking *Tracking

+ Unsubscribe *Unsubscribe

+ Variables map[string]any

+ type SendResponse struct

+ CreatedAt string

+ ID string

+ type Suppression struct

+ Classification *string

+ CreatedAt string

+ Email string

+ ExpiresAt *string

+ ID string

+ Note *string

+ Origin SuppressionOrigin

+ Reason SuppressionReason

+ SMTPCode *int

+ SuppressedAt string

+ Topic string

+ type SuppressionCreateParams struct

+ Email string

+ Note string

+ Topic string

+ type SuppressionListParams struct

+ EmailContains string

+ Origin SuppressionOrigin

+ Reason SuppressionReason

+ Topic string

+ type SuppressionOrigin string

+ const SuppressionOriginAuto

+ const SuppressionOriginManual

+ type SuppressionReason string

+ const SuppressionReasonComplaint

+ const SuppressionReasonManual

+ const SuppressionReasonPermanentBounce

+ const SuppressionReasonUnsubscribed

+ type SuppressionsService struct

+ func (s *SuppressionsService) Create(ctx context.Context, params *SuppressionCreateParams, opts ...RequestOption) (*Suppression, error)

+ func (s *SuppressionsService) Delete(ctx context.Context, email, topic string, opts ...RequestOption) error

+ func (s *SuppressionsService) DeleteForEmail(ctx context.Context, email string, opts ...RequestOption) error

+ func (s *SuppressionsService) Get(ctx context.Context, email, topic string, opts ...RequestOption) (*Suppression, error)

+ func (s *SuppressionsService) List(ctx context.Context, params SuppressionListParams, opts ...RequestOption) (*Page[Suppression], error)

+ func (s *SuppressionsService) ListForEmail(ctx context.Context, email string, opts ...RequestOption) ([]Suppression, error)

+ type Template struct

+ CreatedAt string

+ HTML *string

+ HasDraft bool

+ ID string

+ Kind TemplateKind

+ Markdown *string

+ Name string

+ PublishedAt *string

+ Subject *string

+ Text *string

+ UpdatedAt string

+ type TemplateCreateParams struct

+ HTML *string

+ Kind TemplateKind

+ Markdown *string

+ Name string

+ Subject *string

+ type TemplateDraft struct

+ HTML *string

+ Markdown *string

+ Subject *string

+ Text *string

+ UpdatedAt string

+ type TemplateDraftParams struct

+ HTML *string

+ Markdown *string

+ Subject *string

+ type TemplateDuplicateParams struct

+ Name string

+ type TemplateKind string

+ const TemplateKindHTML

+ const TemplateKindMarkdown

+ type TemplateUpdateParams struct

+ Name string

+ type TemplatesService struct

+ func (s *TemplatesService) Create(ctx context.Context, params *TemplateCreateParams, opts ...RequestOption) (*Template, error)

+ func (s *TemplatesService) Delete(ctx context.Context, id string, opts ...RequestOption) error

+ func (s *TemplatesService) DeleteDraft(ctx context.Context, id string, opts ...RequestOption) error

+ func (s *TemplatesService) Duplicate(ctx context.Context, id string, params *TemplateDuplicateParams, ...) (*Template, error)

+ func (s *TemplatesService) Get(ctx context.Context, id string, opts ...RequestOption) (*Template, error)

+ func (s *TemplatesService) GetDraft(ctx context.Context, id string, opts ...RequestOption) (*TemplateDraft, error)

+ func (s *TemplatesService) List(ctx context.Context, params ListParams, opts ...RequestOption) (*Page[Template], error)

+ func (s *TemplatesService) Publish(ctx context.Context, id string, opts ...RequestOption) (*Template, error)

+ func (s *TemplatesService) Update(ctx context.Context, id string, params *TemplateUpdateParams, ...) (*Template, error)

+ func (s *TemplatesService) UpdateDraft(ctx context.Context, id string, params *TemplateDraftParams, ...) (*TemplateDraft, error)

+ type Tracking struct

+ Clicks *bool

+ Opens *bool

+ type Unsubscribe struct

+ DisplayName string

+ Mode UnsubscribeMode

+ type UnsubscribeMode string

+ const UnsubscribeGenerate

+ const UnsubscribeNone

+ type VerificationFailure struct

+ Code string

+ Message string

+ type VerifyOption func(*verifyConfig)

+ func WithNow(unixSeconds int64) VerifyOption

+ func WithTolerance(d time.Duration) VerifyOption

+ type Webhook struct

+ CreatedAt string

+ Events []WebhookEventType

+ ID string

+ LastDeliveryAt *string

+ Name string

+ SigningSecretGraceExpiresAt *string

+ SigningSecretPrefix string

+ SigningSecretPreviousPrefix *string

+ Status WebhookStatus

+ URL string

+ type WebhookCreateParams struct

+ Events []WebhookEventType

+ Name string

+ URL string

+ type WebhookDelivery struct

+ BatchID string

+ Events []WebhookDeliveryEvent

+ Timestamp int64

+ func UnwrapWebhookEvent(payload []byte, signatureHeader, secret string, opts ...VerifyOption) (*WebhookDelivery, error)

+ type WebhookDeliveryEvent struct

+ Data map[string]any

+ ID string

+ OccurredAt string

+ Type string

+ type WebhookEventType string

+ const WebhookEventBounced

+ const WebhookEventClicked

+ const WebhookEventComplained

+ const WebhookEventDelayed

+ const WebhookEventDelivered

+ const WebhookEventOpened

+ const WebhookEventSent

+ const WebhookEventSuppressed

+ const WebhookEventUnsubscribed

+ type WebhookStatus string

+ const WebhookStatusActive

+ const WebhookStatusCircuitDisabled

+ const WebhookStatusDisabled

+ type WebhookTestResult struct

+ Delivered bool

+ Error *string

+ LatencyMS int

+ ResponseBodyPreview *string

+ StatusCode *int

+ type WebhookUpdateParams struct

+ Events []WebhookEventType

+ Name string

+ Status WebhookStatus

+ URL string

+ type WebhookVerificationError struct

+ Message string

+ Reason WebhookVerificationReason

+ func (e *WebhookVerificationError) Error() string

+ type WebhookVerificationReason string

+ const ReasonMalformedHeader

+ const ReasonNoMatch

+ const ReasonNoSignatures

+ const ReasonNoTimestamp

+ const ReasonTimestampOutOfTolerance

+ type WebhookWithSecret struct

+ SigningSecret string

+ type WebhooksService struct

+ func (s *WebhooksService) Create(ctx context.Context, params *WebhookCreateParams, opts ...RequestOption) (*WebhookWithSecret, error)

+ func (s *WebhooksService) Delete(ctx context.Context, id string, opts ...RequestOption) error

+ func (s *WebhooksService) Get(ctx context.Context, id string, opts ...RequestOption) (*Webhook, error)

+ func (s *WebhooksService) List(ctx context.Context, params ListParams, opts ...RequestOption) (*Page[Webhook], error)

+ func (s *WebhooksService) RotateSecret(ctx context.Context, id string, opts ...RequestOption) (*WebhookWithSecret, error)

+ func (s *WebhooksService) Test(ctx context.Context, id string, opts ...RequestOption) (*WebhookTestResult, error)

+ func (s *WebhooksService) Update(ctx context.Context, id string, params *WebhookUpdateParams, ...) (*Webhook, error)

+ type WhoamiAPIKey struct

+ ID string

+ Permissions Permissions

+ type WhoamiResponse struct

+ APIKey WhoamiAPIKey

+ Team *WhoamiTeam

+ type WhoamiTeam struct

+ ID string

+ Name string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL