lettr

package module

Go to main page

Versions in this module

v1

v1.6.0

Sep 22, 2026

Changes in this version

type CancelScheduledResponse

+ Data ScheduledEmail

+ type EmailDetail struct

+ Events []EmailEvent

+ From string

+ FromName *string

+ NumRecipients int

+ Recipients []string

+ ScheduledAt *string

+ State string

+ Subject string

+ TransmissionID string

type EmailService

+ func (s *EmailService) ListScheduled(ctx context.Context, params *ListScheduledEmailsParams) (*ListScheduledEmailsResponse, error)

+ type ListScheduledEmailsData struct

+ Pagination PagePagination

+ ScheduledEmails []ScheduledEmail

+ type ListScheduledEmailsParams struct

+ Page int

+ PerPage int

+ Status ScheduledEmailState

+ type ListScheduledEmailsResponse struct

+ Data ListScheduledEmailsData

+ Message string

+ type ScheduledEmail struct

+ Accepted int

+ Events []EmailEvent

+ FailureReason *string

+ From string

+ FromName *string

+ NumRecipients int

+ Recipients []string

+ Rejected int

+ RequestID string

+ ScheduledAt *string

+ State ScheduledEmailState

+ Subject *string

+ Tag *string

+ TransmissionID *string

+ type ScheduledEmailState string

+ const ScheduledStateBounced

+ const ScheduledStateCancelled

+ const ScheduledStateDelivered

+ const ScheduledStateFailed

+ const ScheduledStateGenerating

+ const ScheduledStateScheduled

+ const ScheduledStateSending

+ const ScheduledStateSent

+ const ScheduledStateSubmitted

+ func (s ScheduledEmailState) IsCancellable() bool

v1.5.0

Sep 11, 2026

Changes in this version

+ const ErrorCodeIdempotencyInProgress

+ const ErrorCodeIdempotencyKeyConflict

+ func IsIdempotencyConflict(err error) bool

+ func IsIdempotencyInProgress(err error) bool

+ func IsValidIdempotencyKey(key string) bool

type Client

+ Folders *FolderService

type CreateTemplateData

+ PreparationStatus TemplatePreparationStatus

+ Purpose TemplatePurpose

type CreateTemplateRequest

+ Purpose TemplatePurpose

type Error

+ RetryAfter int

+ type Folder struct

+ CreatedAt string

+ ID int

+ Name string

+ ProjectID int

+ Purpose TemplatePurpose

+ TemplatesCount int

+ UpdatedAt string

+ type FolderService struct

+ func (s *FolderService) List(ctx context.Context, params *ListFoldersParams) (*ListFoldersResponse, error)

+ type ListFoldersData struct

+ Folders []Folder

+ Pagination PagePagination

+ type ListFoldersParams struct

+ Page int

+ PerPage int

+ ProjectID int

+ Purpose TemplatePurpose

+ type ListFoldersResponse struct

+ Data ListFoldersData

+ Message string

type ListTemplatesParams

+ FolderID int

+ Purpose TemplatePurpose

type SendEmailData

+ Replayed bool

+ type SendOption func(*sendConfig)

+ func WithIdempotencyKey(key string) SendOption

type Template

+ PreparationStatus TemplatePreparationStatus

+ Purpose TemplatePurpose

type TemplateDetail

+ PreparationStatus TemplatePreparationStatus

+ Purpose TemplatePurpose

+ type TemplatePreparationStatus string

+ const PreparationFailed

+ const PreparationPending

+ const PreparationReady

+ func (s TemplatePreparationStatus) Settled() bool

+ type TemplatePurpose string

+ const PurposeCampaign

+ const PurposeTransactional

+ func (p TemplatePurpose) IsCampaign() bool

v1.4.1

Aug 15, 2026

v1.4.0

Aug 14, 2026

Changes in this version

+ const BulkContactErrorInvalidEmail

+ const BulkContactErrorInvalidPropertyValue

+ const BulkContactErrorInvalidTopicSubscription

+ const BulkContactErrorMissingEmail

+ const BulkContactErrorUnknownList

+ const BulkContactErrorUnknownPropertyKey

+ const BulkContactErrorUnknownTopic

+ const ErrorCodeResourceAlreadyExists

+ const TopicOptIn

+ const TopicOptOut

+ func IsConflict(err error) bool

+ func IsContactAlreadyExists(err error) bool

type AudienceContactService

+ func (s *AudienceContactService) BulkSubscribeToTopics(ctx context.Context, params *BulkContactsTopicsRequest) (*BulkSubscribeContactsToTopicsResponse, error)

+ func (s *AudienceContactService) BulkUnsubscribeFromTopics(ctx context.Context, params *BulkContactsTopicsRequest) (*BulkUnsubscribeContactsFromTopicsResponse, error)

+ type AudienceTopicSubscription struct

+ ID string

+ Subscription string

+ func SubscribeTopic(topicID string) AudienceTopicSubscription

+ func UnsubscribeTopic(topicID string) AudienceTopicSubscription

+ type BulkAudienceContactError struct

+ Email string

+ Error string

+ ErrorCode string

+ Index int

+ type BulkAudienceContactRef struct

+ Created bool

+ Email string

+ ID string

+ type BulkAudienceContactRow struct

+ Email string

+ ListIDs []string

+ Properties map[string]string

+ Topics []AudienceTopicSubscription

+ type BulkContactsTopicsRequest struct

+ ContactIDs []string

+ TopicIDs []string

type BulkCreateAudienceContactsData

+ Contacts []BulkAudienceContactRef

+ ErrorCount int

+ Errors []BulkAudienceContactError

+ Updated int

+ func (d BulkCreateAudienceContactsData) ContactIDs() []string

+ func (d BulkCreateAudienceContactsData) HasErrors() bool

+ func (d BulkCreateAudienceContactsData) IDFor(email string) (string, bool)

type BulkCreateAudienceContactsRequest

+ Contacts []BulkAudienceContactRow

+ ListIDs []string

+ Topics []AudienceTopicSubscription

+ UpdateExisting bool

+ type BulkSubscribeContactsToTopicsData struct

+ AlreadySubscribed int

+ Subscribed int

+ TotalPairs int

+ type BulkSubscribeContactsToTopicsResponse struct

+ Data BulkSubscribeContactsToTopicsData

+ Message string

+ type BulkUnsubscribeContactsFromTopicsData struct

+ TotalPairs int

+ Unsubscribed int

+ type BulkUnsubscribeContactsFromTopicsResponse struct

+ Data BulkUnsubscribeContactsFromTopicsData

+ Message string

v1.3.0

May 28, 2026

Changes in this version

+ const CampaignEventTypeBounce

+ const CampaignEventTypeClick

+ const CampaignEventTypeDelivery

+ const CampaignEventTypeInjection

+ const CampaignEventTypeListUnsubscribe

+ const CampaignEventTypeOpen

+ const CampaignEventTypeSpamComplaint

+ const CampaignStatusDraft

+ const CampaignStatusFailed

+ const CampaignStatusInReview

+ const CampaignStatusPreparing

+ const CampaignStatusScheduled

+ const CampaignStatusSending

+ const CampaignStatusSent

+ type Campaign struct

+ CreatedAt string

+ FromEmail *string

+ FromName *string

+ ID string

+ Name string

+ ReplyTo *string

+ ScheduledAt *string

+ SentAt *string

+ SentCount int

+ Stats CampaignStats

+ Status string

+ Subject *string

+ TotalRecipients *int

+ type CampaignActionResponse struct

+ Data *Campaign

+ Message string

+ type CampaignDetail struct

+ HTMLContent *string

+ type CampaignEvent struct

+ BounceClass *string

+ Email string

+ EventID string

+ EventType string

+ Reason *string

+ TargetLinkURL *string

+ Timestamp string

+ UserAgent *string

+ type CampaignResponse struct

+ Data CampaignDetail

+ Message string

+ type CampaignService struct

+ func (s *CampaignService) Get(ctx context.Context, campaignID string) (*CampaignResponse, error)

+ func (s *CampaignService) List(ctx context.Context, params *ListCampaignsParams) (*ListCampaignsResponse, error)

+ func (s *CampaignService) ListEvents(ctx context.Context, campaignID string, params *ListCampaignEventsParams) (*ListCampaignEventsResponse, error)

+ func (s *CampaignService) Schedule(ctx context.Context, campaignID string, params *ScheduleCampaignRequest) (*CampaignActionResponse, error)

+ func (s *CampaignService) Send(ctx context.Context, campaignID string) (*CampaignActionResponse, error)

+ func (s *CampaignService) Unschedule(ctx context.Context, campaignID string) (*CampaignActionResponse, error)

+ type CampaignStats struct

+ Bounces int

+ Clicks int

+ Deliveries int

+ Injections int

+ Opens int

+ SpamComplaints int

+ UniqueClicks int

+ UniqueOpens int

+ Unsubscribes int

type Client

+ Campaigns *CampaignService

+ type ListCampaignEventsData struct

+ Events []CampaignEvent

+ NextCursor *string

+ type ListCampaignEventsParams struct

+ Cursor string

+ Email string

+ EndDate string

+ EventType string

+ Limit int

+ StartDate string

+ type ListCampaignEventsResponse struct

+ Data ListCampaignEventsData

+ Message string

+ type ListCampaignsData struct

+ Campaigns []Campaign

+ Pagination PagePagination

+ type ListCampaignsParams struct

+ Page int

+ PerPage int

+ Status string

+ type ListCampaignsResponse struct

+ Data ListCampaignsData

+ Message string

+ type ScheduleCampaignRequest struct

+ ScheduledAt string

v1.2.0

May 26, 2026

Changes in this version

+ const ContactStatusBounced

+ const ContactStatusComplained

+ const ContactStatusSubscribed

+ const ContactStatusUnsubscribed

+ const ContactStatusUnverified

+ const PropertyTypeBoolean

+ const PropertyTypeDate

+ const PropertyTypeJSON

+ const PropertyTypeNumber

+ const PropertyTypeString

+ const SegmentOperatorAfter

+ const SegmentOperatorBefore

+ const SegmentOperatorContains

+ const SegmentOperatorEndsWith

+ const SegmentOperatorEquals

+ const SegmentOperatorGreaterThan

+ const SegmentOperatorGreaterThanOrEqual

+ const SegmentOperatorIsFalse

+ const SegmentOperatorIsTrue

+ const SegmentOperatorLessThan

+ const SegmentOperatorLessThanOrEqual

+ const SegmentOperatorNotContains

+ const SegmentOperatorNotEndsWith

+ const SegmentOperatorNotEquals

+ const SegmentOperatorNotStartsWith

+ const SegmentOperatorStartsWith

+ const TopicDefaultSubscriptionOptIn

+ const TopicDefaultSubscriptionOptOut

+ const TopicVisibilityPrivate

+ const TopicVisibilityPublic

+ type AttachContactResponse struct

+ Message string

+ type AudienceContact struct

+ CreatedAt string

+ Email string

+ ID string

+ Lists []AudienceContactListLink

+ Properties ContactProperties

+ Status string

+ Topics []AudienceContactTopicLink

+ type AudienceContactListLink struct

+ ID string

+ Name string

+ type AudienceContactResponse struct

+ Data AudienceContact

+ Message string

+ type AudienceContactService struct

+ func (s *AudienceContactService) AttachToList(ctx context.Context, contactID, listID string) (*AttachContactResponse, error)

+ func (s *AudienceContactService) BulkAttachToLists(ctx context.Context, params *BulkContactsListsRequest) (*BulkAttachContactsToListsResponse, error)

+ func (s *AudienceContactService) BulkCreate(ctx context.Context, params *BulkCreateAudienceContactsRequest) (*BulkCreateAudienceContactsResponse, error)

+ func (s *AudienceContactService) BulkDetachFromLists(ctx context.Context, params *BulkContactsListsRequest) (*BulkDetachContactsFromListsResponse, error)

+ func (s *AudienceContactService) Create(ctx context.Context, params *CreateAudienceContactRequest) (*AudienceContactResponse, error)

+ func (s *AudienceContactService) Delete(ctx context.Context, contactID string) error

+ func (s *AudienceContactService) DetachFromList(ctx context.Context, contactID, listID string) error

+ func (s *AudienceContactService) Get(ctx context.Context, contactID string) (*AudienceContactResponse, error)

+ func (s *AudienceContactService) List(ctx context.Context, params *ListAudienceContactsParams) (*ListAudienceContactsResponse, error)

+ func (s *AudienceContactService) SubscribeToTopic(ctx context.Context, contactID, topicID string) (*AttachContactResponse, error)

+ func (s *AudienceContactService) UnsubscribeFromTopic(ctx context.Context, contactID, topicID string) error

+ func (s *AudienceContactService) Update(ctx context.Context, contactID string, params *UpdateAudienceContactRequest) (*AudienceContactResponse, error)

+ type AudienceContactTopicLink struct

+ ID string

+ Name string

+ type AudienceList struct

+ ContactsCount int

+ ID string

+ Name string

+ type AudienceListResponse struct

+ Data AudienceList

+ Message string

+ type AudienceListService struct

+ func (s *AudienceListService) BulkDelete(ctx context.Context, listIDs []string) (*BulkDeleteAudienceListsResponse, error)

+ func (s *AudienceListService) Create(ctx context.Context, params *CreateAudienceListRequest) (*AudienceListResponse, error)

+ func (s *AudienceListService) Delete(ctx context.Context, listID string) error

+ func (s *AudienceListService) Get(ctx context.Context, listID string) (*AudienceListResponse, error)

+ func (s *AudienceListService) List(ctx context.Context, params *ListAudienceListsParams) (*ListAudienceListsResponse, error)

+ func (s *AudienceListService) Update(ctx context.Context, listID string, params *UpdateAudienceListRequest) (*AudienceListResponse, error)

+ type AudienceProperty struct

+ CreatedAt string

+ FallbackValue *string

+ ID string

+ Name string

+ Type string

+ type AudiencePropertyResponse struct

+ Data AudienceProperty

+ Message string

+ type AudiencePropertyService struct

+ func (s *AudiencePropertyService) Create(ctx context.Context, params *CreateAudiencePropertyRequest) (*AudiencePropertyResponse, error)

+ func (s *AudiencePropertyService) Delete(ctx context.Context, propertyID string) error

+ func (s *AudiencePropertyService) Get(ctx context.Context, propertyID string) (*AudiencePropertyResponse, error)

+ func (s *AudiencePropertyService) List(ctx context.Context, params *ListAudiencePropertiesParams) (*ListAudiencePropertiesResponse, error)

+ func (s *AudiencePropertyService) Update(ctx context.Context, propertyID string, params *UpdateAudiencePropertyRequest) (*AudiencePropertyResponse, error)

+ type AudienceSegment struct

+ CachedContactsCount *int

+ ConditionGroups []SegmentConditionGroup

+ CreatedAt string

+ ID string

+ ListID *string

+ ListName *string

+ Name string

+ type AudienceSegmentResponse struct

+ Data AudienceSegment

+ Message string

+ type AudienceSegmentService struct

+ func (s *AudienceSegmentService) Create(ctx context.Context, params *CreateAudienceSegmentRequest) (*AudienceSegmentResponse, error)

+ func (s *AudienceSegmentService) Delete(ctx context.Context, segmentID string) error

+ func (s *AudienceSegmentService) Get(ctx context.Context, segmentID string) (*AudienceSegmentResponse, error)

+ func (s *AudienceSegmentService) List(ctx context.Context, params *ListAudienceSegmentsParams) (*ListAudienceSegmentsResponse, error)

+ func (s *AudienceSegmentService) Update(ctx context.Context, segmentID string, params *UpdateAudienceSegmentRequest) (*AudienceSegmentResponse, error)

+ type AudienceService struct

+ Contacts *AudienceContactService

+ Lists *AudienceListService

+ Properties *AudiencePropertyService

+ Segments *AudienceSegmentService

+ Topics *AudienceTopicService

+ type AudienceTopic struct

+ ContactsCount int

+ CreatedAt *string

+ DefaultSubscription string

+ Description *string

+ ID string

+ Name string

+ Visibility string

+ type AudienceTopicResponse struct

+ Data AudienceTopic

+ Message string

+ type AudienceTopicService struct

+ func (s *AudienceTopicService) Create(ctx context.Context, params *CreateAudienceTopicRequest) (*AudienceTopicResponse, error)

+ func (s *AudienceTopicService) Delete(ctx context.Context, topicID string) error

+ func (s *AudienceTopicService) Get(ctx context.Context, topicID string) (*AudienceTopicResponse, error)

+ func (s *AudienceTopicService) List(ctx context.Context, params *ListAudienceTopicsParams) (*ListAudienceTopicsResponse, error)

+ func (s *AudienceTopicService) Update(ctx context.Context, topicID string, params *UpdateAudienceTopicRequest) (*AudienceTopicResponse, error)

+ type BulkAttachContactsToListsData struct

+ AlreadyAttached int

+ Attached int

+ TotalPairs int

+ type BulkAttachContactsToListsResponse struct

+ Data BulkAttachContactsToListsData

+ Message string

+ type BulkContactsListsRequest struct

+ ContactIDs []string

+ ListIDs []string

+ type BulkCreateAudienceContactsData struct

+ AlreadyExisted int

+ Created int

+ type BulkCreateAudienceContactsRequest struct

+ Emails []string

+ ListID *string

+ Properties map[string]string

+ type BulkCreateAudienceContactsResponse struct

+ Data BulkCreateAudienceContactsData

+ Message string

+ type BulkDeleteAudienceListsData struct

+ Deleted int

+ type BulkDeleteAudienceListsRequest struct

+ ListIDs []string

+ type BulkDeleteAudienceListsResponse struct

+ Data BulkDeleteAudienceListsData

+ Message string

+ type BulkDetachContactsFromListsData struct

+ Detached int

+ NotPresent int

+ TotalPairs int

+ type BulkDetachContactsFromListsResponse struct

+ Data BulkDetachContactsFromListsData

+ Message string

type Client

+ Audience *AudienceService

+ type ContactProperties map[string]string

+ func (p *ContactProperties) UnmarshalJSON(data []byte) error

+ type CreateAudienceContactRequest struct

+ DoubleOptIn *DoubleOptInConfig

+ Email string

+ ListID *string

+ Properties map[string]string

+ type CreateAudienceListRequest struct

+ Name string

+ type CreateAudiencePropertyRequest struct

+ FallbackValue *string

+ Name string

+ Type string

+ type CreateAudienceSegmentRequest struct

+ Conditions SegmentConditionsInput

+ ListID *string

+ Name string

+ type CreateAudienceTopicRequest struct

+ DefaultSubscription string

+ Description *string

+ Name string

+ Visibility string

+ type DoubleOptInConfig struct

+ From string

+ FromName *string

+ RedirectURL string

+ Subject string

+ TemplateSlug string

type Error

+ func (e *Error) UnmarshalJSON(data []byte) error

+ type ListAudienceContactsData struct

+ Contacts []AudienceContact

+ Pagination PagePagination

+ type ListAudienceContactsParams struct

+ ListID string

+ Page int

+ PerPage int

+ Search string

+ SegmentID string

+ Status string

+ type ListAudienceContactsResponse struct

+ Data ListAudienceContactsData

+ Message string

+ type ListAudienceListsData struct

+ Lists []AudienceList

+ Pagination PagePagination

+ type ListAudienceListsParams struct

+ Page int

+ PerPage int

+ type ListAudienceListsResponse struct

+ Data ListAudienceListsData

+ Message string

+ type ListAudiencePropertiesData struct

+ Pagination PagePagination

+ Properties []AudienceProperty

+ type ListAudiencePropertiesParams struct

+ Page int

+ PerPage int

+ type ListAudiencePropertiesResponse struct

+ Data ListAudiencePropertiesData

+ Message string

+ type ListAudienceSegmentsData struct

+ Pagination PagePagination

+ Segments []AudienceSegment

+ type ListAudienceSegmentsParams struct

+ ListID string

+ Page int

+ PerPage int

+ type ListAudienceSegmentsResponse struct

+ Data ListAudienceSegmentsData

+ Message string

+ type ListAudienceTopicsData struct

+ Pagination PagePagination

+ Topics []AudienceTopic

+ type ListAudienceTopicsParams struct

+ Page int

+ PerPage int

+ type ListAudienceTopicsResponse struct

+ Data ListAudienceTopicsData

+ Message string

+ type NullString struct

+ String string

+ Valid bool

+ func NewNullString(s string) *NullString

+ func (n *NullString) MarshalJSON() ([]byte, error)

+ type SegmentCondition struct

+ Field string

+ Operator string

+ Value *string

+ type SegmentConditionGroup struct

+ Conditions []SegmentCondition

+ type SegmentConditionsInput struct

+ Groups []SegmentConditionGroup

+ type UpdateAudienceContactRequest struct

+ Email string

+ Properties map[string]*string

+ Status string

+ type UpdateAudienceListRequest struct

+ Name string

+ type UpdateAudiencePropertyRequest struct

+ FallbackValue *NullString

+ type UpdateAudienceSegmentRequest struct

+ Conditions *SegmentConditionsInput

+ ListID *NullString

+ Name string

+ type UpdateAudienceTopicRequest struct

+ Description *NullString

+ Name string

+ Visibility string

v1.1.0

Apr 22, 2026

Changes in this version

+ const EventEngagementAmpClick

+ const EventEngagementAmpInitialOpen

+ const EventEngagementAmpOpen

+ const EventEngagementClick

+ const EventEngagementInitialOpen

+ const EventEngagementOpen

+ const EventGenerationFailure

+ const EventGenerationRejection

+ const EventMessageBounce

+ const EventMessageDelay

+ const EventMessageDelivery

+ const EventMessageInjection

+ const EventMessageOutOfBand

+ const EventMessagePolicyRejection

+ const EventMessageSpamComplaint

+ const EventRelayDelivery

+ const EventRelayInjection

+ const EventRelayPermfail

+ const EventRelayRejection

+ const EventRelayTempfail

+ const EventUnsubscribeLink

+ const EventUnsubscribeList

type UpdateWebhookRequest

+ URL string

v1.0.0

Apr 20, 2026

v0

v0.3.0

Apr 18, 2026

v0.2.0

Apr 17, 2026

Changes in this version

+ type CancelScheduledResponse struct

+ Message string

type Client

+ Projects *ProjectService

+ type CreateWebhookRequest struct

+ AuthPassword string

+ AuthType string

+ AuthUsername string

+ Events []string

+ EventsMode string

+ Name string

+ OAuthClientID string

+ OAuthClientSecret string

+ OAuthTokenURL string

+ URL string

+ type CreateWebhookResponse struct

+ Data Webhook

+ Message string

+ type DeleteTemplateParams struct

+ ProjectID int

+ type DeleteTemplateResponse struct

+ Message string

+ type DeleteWebhookResponse struct

+ Message string

+ type DmarcValidationResult struct

+ CoveredByParentPolicy bool

+ Error *string

+ FoundAtDomain *string

+ IsValid bool

+ Policy *string

+ Record *string

+ Status string

+ SubdomainPolicy *string

+ type DnsProviderInfo struct

+ Error *string

+ Nameservers []string

+ Provider string

+ ProviderLabel string

type DomainDKIM

+ Headers string

+ SigningDomain string

type DomainDetail

+ DmarcStatus *string

+ DnsProvider *DnsProviderInfo

+ IsPrimaryDomain bool

+ SpfStatus *string

+ type DomainDnsVerificationView struct

+ CnameError *string

+ CnameRecord *string

+ DkimError *string

+ DkimRecord *string

+ DmarcError *string

+ DmarcRecord *string

+ SpfError *string

+ SpfRecord *string

type DomainService

+ func (s *DomainService) Verify(ctx context.Context, domain string) (*VerifyDomainResponse, error)

+ type DomainVerificationView struct

+ CnameStatus string

+ DNS *DomainDnsVerificationView

+ DkimStatus string

+ Dmarc *DmarcValidationResult

+ DmarcStatus string

+ Domain string

+ IsPrimaryDomain bool

+ OwnershipVerified *string

+ Spf *SpfValidationResult

+ SpfStatus string

type EmailEvent

+ AbTestID *string

+ AbTestVersion *string

+ AmpEnabled *bool

+ BounceClass *int

+ CampaignID *string

+ DelvMethod *string

+ DeviceToken *string

+ GeoIp *GeoIp

+ InitialPixel *bool

+ IpAddress *string

+ IpPool *string

+ MsgFrom *string

+ NumRetries *int

+ OutboundTls *string

+ QueueTime *int

+ RcptTags []string

+ RcptType *string

+ RecvMethod *string

+ RoutingDomain *string

+ ScheduledTime *string

+ TargetLinkName *string

+ TargetLinkURL *string

+ TemplateID *string

+ TemplateVersion *string

+ UserAgent *string

+ UserAgentParsed *UserAgentParsed

type EmailService

+ func (s *EmailService) CancelScheduled(ctx context.Context, transmissionID string) (*CancelScheduledResponse, error)

+ func (s *EmailService) GetScheduled(ctx context.Context, transmissionID string) (*GetScheduledEmailResponse, error)

+ func (s *EmailService) ListEvents(ctx context.Context, params *ListEmailEventsParams) (*ListEmailEventsResponse, error)

+ func (s *EmailService) Schedule(ctx context.Context, params *ScheduleEmailRequest) (*ScheduleEmailResponse, error)

+ type GeoIp struct

+ City string

+ Country string

+ Latitude float64

+ Longitude float64

+ PostalCode string

+ Region string

+ Zip string

+ type GetEmailParams struct

+ From string

+ To string

+ type GetMergeTagsData struct

+ MergeTags []MergeTag

+ ProjectID int

+ TemplateSlug string

+ Version int

+ type GetMergeTagsParams struct

+ ProjectID int

+ Version int

+ type GetMergeTagsResponse struct

+ Data GetMergeTagsData

+ Message string

+ type GetScheduledEmailResponse struct

+ Data ScheduledTransmission

+ Message string

+ type GetTemplateHtmlData struct

+ Html string

+ MergeTags []HtmlMergeTag

+ Subject *string

+ type GetTemplateHtmlParams struct

+ ProjectID int

+ Slug string

+ type GetTemplateHtmlResponse struct

+ Data GetTemplateHtmlData

+ Success bool

+ type GetTemplateParams struct

+ ProjectID int

+ type GetTemplateResponse struct

+ Data TemplateDetail

+ Message string

+ type HtmlMergeTag struct

+ Key string

+ Name string

+ Required bool

+ type ListEmailEventsData struct

+ Events ListEmailEventsEvents

+ type ListEmailEventsEvents struct

+ Data []EmailEvent

+ From string

+ Pagination CursorPagination

+ To string

+ TotalCount int

+ type ListEmailEventsParams struct

+ BounceClasses []int

+ Cursor string

+ Events []string

+ From string

+ PerPage int

+ Recipients []string

+ To string

+ Transmissions string

+ type ListEmailEventsResponse struct

+ Data ListEmailEventsData

+ Message string

type ListEmailsData

+ Events ListEmailsEvents

+ type ListEmailsEvents struct

+ Data []EmailEvent

+ From string

+ Pagination CursorPagination

+ To string

+ TotalCount int

type ListEmailsResponse

+ Success bool

+ type ListProjectsData struct

+ Pagination PagePagination

+ Projects []Project

+ type ListProjectsParams struct

+ Page int

+ PerPage int

+ type ListProjectsResponse struct

+ Data ListProjectsData

+ Message string

+ Success bool

type MergeTag

+ Children []MergeTagChild

+ Type string

+ type MergeTagChild struct

+ Key string

+ Type string

+ type Project struct

+ CreatedAt string

+ Emoji *string

+ ID int

+ Name string

+ TeamID int

+ UpdatedAt string

+ type ProjectService struct

+ func (s *ProjectService) List(ctx context.Context, params *ListProjectsParams) (*ListProjectsResponse, error)

+ type ScheduleEmailData struct

+ Accepted int

+ Rejected int

+ RequestID string

+ type ScheduleEmailRequest struct

+ ScheduledAt string

+ type ScheduleEmailResponse struct

+ Data ScheduleEmailData

+ Message string

+ type ScheduledTransmission struct

+ Events []EmailEvent

+ From string

+ FromName *string

+ NumRecipients int

+ Recipients []string

+ ScheduledAt *string

+ State string

+ Subject string

+ TransmissionID string

type SendEmailOptions

+ InlineCss *bool

+ PerformSubstitutions *bool

type SendEmailRequest

+ AmpHtml string

+ Bcc []string

+ Cc []string

+ Headers map[string]string

+ ReplyTo string

+ ReplyToName string

+ Tag string

+ type SpfValidationResult struct

+ Error *string

+ IncludesSparkpost bool

+ IsValid bool

+ Record *string

+ Status string

+ type TemplateDetail struct

+ ActiveVersion *int

+ CreatedAt string

+ FolderID int

+ Html string

+ ID int

+ Json string

+ Name string

+ ProjectID int

+ Slug string

+ UpdatedAt string

+ VersionsCount int

type TemplateService

+ func (s *TemplateService) Delete(ctx context.Context, slug string, params *DeleteTemplateParams) (*DeleteTemplateResponse, error)

+ func (s *TemplateService) Get(ctx context.Context, slug string, params *GetTemplateParams) (*GetTemplateResponse, error)

+ func (s *TemplateService) GetHtml(ctx context.Context, params *GetTemplateHtmlParams) (*GetTemplateHtmlResponse, error)

+ func (s *TemplateService) GetMergeTags(ctx context.Context, slug string, params *GetMergeTagsParams) (*GetMergeTagsResponse, error)

+ func (s *TemplateService) Update(ctx context.Context, slug string, params *UpdateTemplateRequest) (*UpdateTemplateResponse, error)

+ type UpdateTemplateData struct

+ ActiveVersion int

+ CreatedAt string

+ FolderID int

+ ID int

+ MergeTags []MergeTag

+ Name string

+ ProjectID int

+ Slug string

+ UpdatedAt string

+ type UpdateTemplateRequest struct

+ Html string

+ Json string

+ Name string

+ ProjectID *int

+ type UpdateTemplateResponse struct

+ Data UpdateTemplateData

+ Message string

+ type UpdateWebhookRequest struct

+ Active *bool

+ AuthPassword string

+ AuthType string

+ AuthUsername string

+ Events []string

+ Name string

+ OAuthClientID string

+ OAuthClientSecret string

+ OAuthTokenURL string

+ Target string

+ type UpdateWebhookResponse struct

+ Data Webhook

+ Message string

+ type UserAgentParsed struct

+ AgentFamily string

+ DeviceBrand string

+ DeviceFamily string

+ IsMobile bool

+ IsPrefetched bool

+ IsProxy bool

+ OsFamily string

+ OsVersion string

+ type VerifyDomainResponse struct

+ Data DomainVerificationView

+ Message string

type WebhookService

+ func (s *WebhookService) Create(ctx context.Context, params *CreateWebhookRequest) (*CreateWebhookResponse, error)

+ func (s *WebhookService) Delete(ctx context.Context, webhookID string) (*DeleteWebhookResponse, error)

+ func (s *WebhookService) Update(ctx context.Context, webhookID string, params *UpdateWebhookRequest) (*UpdateWebhookResponse, error)

v0.1.0

Feb 7, 2026

Changes in this version

+ const Version

+ func IsNotFound(err error) bool

+ func IsUnauthorized(err error) bool

+ func IsValidationError(err error) bool

+ type Attachment struct

+ Data string

+ Name string

+ Type string

+ type AuthCheckData struct

+ TeamID int

+ Timestamp string

+ type AuthCheckResponse struct

+ Data AuthCheckData

+ Message string

+ type Client struct

+ Domains *DomainService

+ Emails *EmailService

+ Templates *TemplateService

+ Webhooks *WebhookService

+ func NewClient(apiKey string) *Client

+ func NewClientWithHTTPClient(apiKey string, httpClient *http.Client) *Client

+ func (c *Client) HealthCheck(ctx context.Context) (*HealthCheckResponse, error)

+ func (c *Client) SetBaseURL(rawURL string) error

+ func (c *Client) ValidateAPIKey(ctx context.Context) (*AuthCheckResponse, error)

+ type CreateDomainData struct

+ DKIM *DomainDKIM

+ Domain string

+ Status string

+ StatusLabel string

+ type CreateDomainRequest struct

+ Domain string

+ type CreateDomainResponse struct

+ Data CreateDomainData

+ Message string

+ type CreateTemplateData struct

+ ActiveVersion int

+ CreatedAt string

+ FolderID int

+ ID int

+ MergeTags []MergeTag

+ Name string

+ ProjectID int

+ Slug string

+ type CreateTemplateRequest struct

+ FolderID *int

+ Html string

+ Json string

+ Name string

+ ProjectID *int

+ type CreateTemplateResponse struct

+ Data CreateTemplateData

+ Message string

+ type CursorPagination struct

+ NextCursor *string

+ PerPage int

+ type Domain struct

+ CanSend bool

+ CnameStatus *string

+ CreatedAt string

+ DkimStatus *string

+ Domain string

+ Status string

+ StatusLabel string

+ UpdatedAt string

+ type DomainDKIM struct

+ Public string

+ Selector string

+ type DomainDNS struct

+ DKIM *DomainDKIM

+ type DomainDetail struct

+ CanSend bool

+ CnameStatus *string

+ CreatedAt string

+ DNS *DomainDNS

+ DkimStatus *string

+ Domain string

+ Status string

+ StatusLabel string

+ TrackingDomain *string

+ UpdatedAt string

+ type DomainService struct

+ func (s *DomainService) Create(ctx context.Context, params *CreateDomainRequest) (*CreateDomainResponse, error)

+ func (s *DomainService) Delete(ctx context.Context, domain string) error

+ func (s *DomainService) Get(ctx context.Context, domain string) (*GetDomainResponse, error)

+ func (s *DomainService) List(ctx context.Context) (*ListDomainsResponse, error)

+ type EmailEvent struct

+ ClickTracking bool

+ ErrorCode *string

+ EventID string

+ FriendlyFrom string

+ InjectionTime string

+ MailboxProvider string

+ MailboxProviderRegion string

+ MessageID string

+ MsgSize int

+ OpenTracking bool

+ RawRcptTo string

+ RawReason *string

+ RcptMeta map[string]interface{}

+ RcptTo string

+ Reason *string

+ RecipientDomain string

+ RequestID string

+ SendingDomain string

+ SendingIP string

+ Subject string

+ Timestamp string

+ Transactional bool

+ Type string

+ type EmailService struct

+ func (s *EmailService) Get(ctx context.Context, requestID string) (*GetEmailResponse, error)

+ func (s *EmailService) List(ctx context.Context, params *ListEmailsParams) (*ListEmailsResponse, error)

+ func (s *EmailService) Send(ctx context.Context, params *SendEmailRequest) (*SendEmailResponse, error)

+ type Error struct

+ ErrorCode string

+ Errors map[string][]string

+ Message string

+ StatusCode int

+ func (e *Error) Error() string

+ type GetDomainResponse struct

+ Data DomainDetail

+ Message string

+ type GetEmailData struct

+ Results []EmailEvent

+ TotalCount int

+ type GetEmailResponse struct

+ Data GetEmailData

+ Message string

+ type GetWebhookResponse struct

+ Data Webhook

+ Message string

+ type HealthCheckData struct

+ Status string

+ Timestamp string

+ type HealthCheckResponse struct

+ Data HealthCheckData

+ Message string

+ type ListDomainsData struct

+ Domains []Domain

+ type ListDomainsResponse struct

+ Data ListDomainsData

+ Message string

+ type ListEmailsData struct

+ Pagination CursorPagination

+ Results []EmailEvent

+ TotalCount int

+ type ListEmailsParams struct

+ Cursor string

+ From string

+ PerPage int

+ Recipients string

+ To string

+ type ListEmailsResponse struct

+ Data ListEmailsData

+ Message string

+ type ListTemplatesData struct

+ Pagination PagePagination

+ Templates []Template

+ type ListTemplatesParams struct

+ Page int

+ PerPage int

+ ProjectID int

+ type ListTemplatesResponse struct

+ Data ListTemplatesData

+ Message string

+ type ListWebhooksData struct

+ Webhooks []Webhook

+ type ListWebhooksResponse struct

+ Data ListWebhooksData

+ Message string

+ type MergeTag struct

+ Key string

+ Required bool

+ type PagePagination struct

+ CurrentPage int

+ LastPage int

+ PerPage int

+ Total int

+ type SendEmailData struct

+ Accepted int

+ Rejected int

+ RequestID string

+ type SendEmailOptions struct

+ ClickTracking *bool

+ OpenTracking *bool

+ Transactional *bool

+ type SendEmailRequest struct

+ Attachments []Attachment

+ From string

+ FromName string

+ Html string

+ Metadata map[string]interface{}

+ Options *SendEmailOptions

+ ProjectID *int

+ Subject string

+ SubstitutionData map[string]interface{}

+ TemplateSlug string

+ TemplateVersion *int

+ Text string

+ To []string

+ type SendEmailResponse struct

+ Data SendEmailData

+ Message string

+ type Template struct

+ CreatedAt string

+ FolderID int

+ ID int

+ Name string

+ ProjectID int

+ Slug string

+ UpdatedAt string

+ type TemplateService struct

+ func (s *TemplateService) Create(ctx context.Context, params *CreateTemplateRequest) (*CreateTemplateResponse, error)

+ func (s *TemplateService) List(ctx context.Context, params *ListTemplatesParams) (*ListTemplatesResponse, error)

+ type Webhook struct

+ AuthType string

+ Enabled bool

+ EventTypes []string

+ HasAuthCredentials bool

+ ID string

+ LastFailureAt *string

+ LastStatus *string

+ LastSuccessfulAt *string

+ Name string

+ URL string

+ type WebhookService struct

+ func (s *WebhookService) Get(ctx context.Context, webhookID string) (*GetWebhookResponse, error)

+ func (s *WebhookService) List(ctx context.Context) (*ListWebhooksResponse, error)

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