Versions in this module Expand all Collapse all v0 v0.1.0 Jun 13, 2026 Changes in this version + type AddContactParams struct + Email string + Metadata map[string]any + Name *string + type AddSuppressionParams struct + Email string + Reason string + type Address struct + Email string + Name string + func Addr(email string) Address + type Attachment struct + ContentBase64 string + ContentType string + Filename string + type BatchResult struct + Failed int + Results []SendResult + Sent int + Total int + type BulkSendParams struct + ContactListID string + HTML string + SenderAddressID string + Subject string + Tags []string + Text string + type BulkSendResult struct + Errors []string + Queued int + Skipped int + type BulkSuppressionResult struct + Added int + Skipped int + TotalProcessed int + type Client struct + Contacts *Contacts + Domains *Domains + Emails *Emails + Suppressions *Suppressions + Templates *Templates + Webhooks *Webhooks + func New(apiKey string, opts ...Option) *Client + type Contact struct + CreatedAt string + Email string + ID string + Metadata map[string]any + Name string + type ContactList struct + ContactCount int + CreatedAt string + Description string + ID string + IconSeed string + Name string + type ContactListDetail struct + Contacts []Contact + type Contacts struct + func (c *Contacts) AddContact(ctx context.Context, listID string, params AddContactParams) (*Contact, error) + func (c *Contacts) BulkSend(ctx context.Context, listID string, params BulkSendParams) (*BulkSendResult, error) + func (c *Contacts) CreateList(ctx context.Context, params CreateListParams) (*ContactList, error) + func (c *Contacts) DeleteList(ctx context.Context, id string) error + func (c *Contacts) GetList(ctx context.Context, id string, params ListContactsParams) (*ContactListDetail, error) + func (c *Contacts) ListLists(ctx context.Context) ([]ContactList, error) + func (c *Contacts) RemoveContact(ctx context.Context, listID, contactID string) error + func (c *Contacts) UpdateList(ctx context.Context, id string, params UpdateListParams) (*ContactList, error) + func (c *Contacts) UploadCSV(ctx context.Context, listID string, file []byte, filename string) (*CsvImportResult, error) + type CreateListParams struct + Description *string + IconSeed *string + Name string + type CreateTemplateParams struct + BlocksJSON map[string]any + HTML *string + Name string + Subject *string + Text *string + type CreateWebhookParams struct + Events []string + URL string + type CsvImportResult struct + Errors []string + Imported int + Skipped int + type DkimRotation struct + DkimRecordHost string + DkimRecordValue string + Domain Domain + type DnsRecord struct + Host string + ID string + IsVerified bool + LastCheckedAt string + Purpose string + RecordType string + Value string + type Domain struct + CreatedAt string + DkimSelector string + DnsRecords []DnsRecord + ID string + Name string + PlatformWarning string + Status string + VerifiedAt string + type DomainAvailability struct + Available bool + Detail string + Reason string + StaleTokens *int + type DomainCheck struct + Domain string + Exists bool + ID string + Status string + Verified bool + type DomainDiagnosis struct + Domain string + HealthScore int + Issues []map[string]any + type DomainHealth struct + Checks []DomainHealthCheck + Domain string + Summary DomainHealthSummary + type DomainHealthCheck struct + Detail string + Key string + Label string + Recommendation string + Record *DomainHealthRecord + Status string + type DomainHealthRecord struct + Host string + Type string + Value string + type DomainHealthSummary struct + Error int + Info int + OK int + Warn int + type DomainListItem struct + CreatedAt string + ID string + Name string + PlatformWarning string + Status string + type DomainTransfer struct + AcceptedAt string + CompletedAt string + CooloffUntil string + DomainID string + DomainName string + ExpiresAt string + ID string + InitiatedAt string + Note string + SourceLabel string + SourceOrgID string + SourceUserID string + Status string + TargetEmail string + TargetOrgID string + TargetUserID string + type Domains struct + func (d *Domains) Check(ctx context.Context, name string) (*DomainCheck, error) + func (d *Domains) CheckAvailability(ctx context.Context, name string) (*DomainAvailability, error) + func (d *Domains) Create(ctx context.Context, name string) (*Domain, error) + func (d *Domains) Delete(ctx context.Context, id string) error + func (d *Domains) Diagnose(ctx context.Context, id string) (*DomainDiagnosis, error) + func (d *Domains) Get(ctx context.Context, id string) (*Domain, error) + func (d *Domains) Health(ctx context.Context, id string) (*DomainHealth, error) + func (d *Domains) List(ctx context.Context) ([]DomainListItem, error) + func (d *Domains) MxStatus(ctx context.Context, id string) (map[string]any, error) + func (d *Domains) PublishedRecords(ctx context.Context, id string) (map[string]any, error) + func (d *Domains) RotateDkim(ctx context.Context, id string) (*DkimRotation, error) + func (d *Domains) Transfer(ctx context.Context, id string, params TransferParams) (*DomainTransfer, error) + func (d *Domains) Verify(ctx context.Context, id string) (*Domain, error) + type Email struct + ClickedCount int + CreatedAt string + DeliveredAt string + FromAddress string + ID string + OpenedCount int + RetryOfID string + ScheduledAt string + SentAt string + Source string + Status string + Subject string + Tags []string + ToAddresses []string + type EmailDetail struct + BCCAddresses []string + CCAddresses []string + Events []EmailEvent + HTMLBody string + Headers map[string]any + MessageID string + TextBody string + type EmailEvent struct + CreatedAt string + EventType string + ID string + Metadata map[string]any + type EmailSearchHit struct + CreatedAt string + DeliveredAt string + FromAddress string + ID string + Source string + Status string + Subject string + Tags []string + ToAddresses []string + type Emails struct + func (e *Emails) CancelScheduled(ctx context.Context, id string) (*IDStatus, error) + func (e *Emails) Events(ctx context.Context, id string) ([]EmailEvent, error) + func (e *Emails) Get(ctx context.Context, id string) (*EmailDetail, error) + func (e *Emails) GetSavedSearches(ctx context.Context) ([]SavedSearch, error) + func (e *Emails) List(ctx context.Context, params ListEmailsParams) ([]Email, error) + func (e *Emails) ListScheduled(ctx context.Context) ([]ScheduledEmail, error) + func (e *Emails) Retry(ctx context.Context, id string) (*SendResult, error) + func (e *Emails) Search(ctx context.Context, params SearchEmailsParams) ([]EmailSearchHit, error) + func (e *Emails) Send(ctx context.Context, msg SendEmail) (*SendResult, error) + func (e *Emails) SendBatch(ctx context.Context, msgs []SendEmail) (*BatchResult, error) + func (e *Emails) SendScheduledNow(ctx context.Context, id string) (*IDStatus, error) + func (e *Emails) SetSavedSearches(ctx context.Context, searches []SavedSearch) ([]SavedSearch, error) + func (e *Emails) Updates(ctx context.Context, since string) ([]Email, error) + func (e *Emails) Validate(ctx context.Context, msg SendEmail) (*ValidationResult, error) + type Error struct + Code string + Message string + Status int + func (e *Error) Error() string + type IDStatus struct + ID string + Status string + type ListContactsParams struct + Limit int + Page int + type ListDeliveriesParams struct + Limit int + Page int + Status string + type ListEmailsParams struct + Limit int + Page int + Status string + type ListSuppressionsParams struct + Limit int + Page int + Search string + type Option func(*transport) + func WithBaseURL(baseURL string) Option + func WithHTTPClient(hc *http.Client) Option + func WithMaxRetries(maxRetries int) Option + func WithTimeout(timeout time.Duration) Option + type Page struct + Items []T + Limit int + Page int + Total int + type SavedSearch struct + Domain string + ID string + Name string + Query string + Range string + Source string + Status string + type ScheduledEmail struct + CreatedAt string + FromAddress string + ID string + ScheduledAt string + SecondsUntilSend int + Status string + Subject string + Tags []string + ToAddresses []string + type SearchEmailsParams struct + Limit int + Page int + Q string + Status string + Tag string + type SendEmail struct + Attachments []Attachment + BCC []Address + CC []Address + From Address + HTML string + Headers map[string]string + ReplyTo *Address + SendAt string + Subject string + Tags []string + Text string + To []Address + type SendResult struct + ID string + MessageID string + RejectionReason string + Status string + type Suppression struct + CreatedAt string + EmailAddress string + ID string + Reason string + type Suppressions struct + func (s *Suppressions) Add(ctx context.Context, params AddSuppressionParams) (*Suppression, error) + func (s *Suppressions) BulkUpload(ctx context.Context, file []byte, filename string) (*BulkSuppressionResult, error) + func (s *Suppressions) List(ctx context.Context, params ListSuppressionsParams) (*Page[Suppression], error) + func (s *Suppressions) Remove(ctx context.Context, id string) error + type Template struct + BlocksJSON map[string]any + CreatedAt string + HTMLBody string + ID string + Name string + Subject string + TextBody string + UpdatedAt string + Variables []string + type Templates struct + func (t *Templates) Create(ctx context.Context, params CreateTemplateParams) (*Template, error) + func (t *Templates) Delete(ctx context.Context, id string) error + func (t *Templates) Duplicate(ctx context.Context, id string) (*Template, error) + func (t *Templates) Get(ctx context.Context, id string) (*Template, error) + func (t *Templates) List(ctx context.Context) ([]Template, error) + func (t *Templates) Update(ctx context.Context, id string, params UpdateTemplateParams) (*Template, error) + type TransferParams struct + Note string + TargetEmail string + type UpdateListParams struct + Description *string + IconSeed *string + Name *string + type UpdateTemplateParams struct + BlocksJSON map[string]any + HTML *string + Name *string + Subject *string + Text *string + type UpdateWebhookParams struct + Events []string + IsActive *bool + URL *string + type ValidationIssue struct + Error string + Field string + type ValidationResult struct + CanSend bool + Issues []ValidationIssue + Plan string + Usage ValidationUsage + Valid bool + type ValidationUsage struct + Daily int + DailyLimit int + Monthly int + MonthlyLimit int + type Webhook struct + CreatedAt string + Events []string + ID string + IsActive bool + Secret string + URL string + type WebhookDelivery struct + Attempt int + CreatedAt string + EventType string + ID string + NextRetryAt string + ResponseStatus *int + Status string + WebhookID string + type WebhookDeliveryDetail struct + EndpointURL string + Payload map[string]any + ResponseBody string + type WebhookTestResult struct + Queued bool + URL string + type Webhooks struct + func (w *Webhooks) Create(ctx context.Context, params CreateWebhookParams) (*Webhook, error) + func (w *Webhooks) Delete(ctx context.Context, id string) error + func (w *Webhooks) GetDelivery(ctx context.Context, id, deliveryID string) (*WebhookDeliveryDetail, error) + func (w *Webhooks) List(ctx context.Context) ([]Webhook, error) + func (w *Webhooks) ListDeliveries(ctx context.Context, id string, params ListDeliveriesParams) (*Page[WebhookDelivery], error) + func (w *Webhooks) Test(ctx context.Context, id string) (*WebhookTestResult, error) + func (w *Webhooks) Update(ctx context.Context, id string, params UpdateWebhookParams) (*Webhook, error)
Go to main page