Documentation ¶
Index ¶
- type Channel
- func (email *Channel) AddDomain(ctx context.Context, req models.AddEmailDomainRequest) (resp models.AddEmailDomainResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) DeleteDomain(ctx context.Context, domainName string) (respDetails models.ResponseDetails, err error)
- func (email *Channel) GetDeliveryReports(ctx context.Context, queryParams models.GetEmailDeliveryReportsParams) (resp models.GetEmailDeliveryReportsResponse, ...)
- func (email *Channel) GetDomain(ctx context.Context, domainName string) (resp models.GetEmailDomainResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) GetDomains(ctx context.Context, queryParams models.GetEmailDomainsParams) (resp models.GetEmailDomainsResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) GetLogs(ctx context.Context, queryParams models.GetEmailLogsParams) (resp models.GetEmailLogsResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) GetSentBulks(ctx context.Context, queryParams models.GetSentEmailBulksParams) (resp models.SentEmailBulksResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) GetSentBulksStatus(ctx context.Context, queryParams models.GetSentEmailBulksStatusParams) (resp models.SentEmailBulksStatusResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) RescheduleMessages(ctx context.Context, req models.RescheduleEmailRequest, ...) (resp models.RescheduleEmailResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) Send(ctx context.Context, msg models.EmailMsg) (msgResp models.SendEmailResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) UpdateDomainTracking(ctx context.Context, domainName string, ...) (resp models.UpdateEmailDomainTrackingResponse, ...)
- func (email *Channel) UpdateScheduledMessagesStatus(ctx context.Context, req models.UpdateScheduledEmailStatusRequest, ...) (resp models.UpdateScheduledStatusResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) ValidateAddresses(ctx context.Context, req models.ValidateEmailAddressesRequest) (resp models.ValidateEmailAddressesResponse, respDetails models.ResponseDetails, ...)
- func (email *Channel) VerifyDomain(ctx context.Context, domainName string) (respDetails models.ResponseDetails, err error)
- type Email
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Channel ¶
type Channel struct {
ReqHandler internal.HTTPHandler
}
func (*Channel) AddDomain ¶
func (email *Channel) AddDomain( ctx context.Context, req models.AddEmailDomainRequest, ) (resp models.AddEmailDomainResponse, respDetails models.ResponseDetails, err error)
func (*Channel) DeleteDomain ¶
func (*Channel) GetDeliveryReports ¶
func (email *Channel) GetDeliveryReports( ctx context.Context, queryParams models.GetEmailDeliveryReportsParams, ) (resp models.GetEmailDeliveryReportsResponse, respDetails models.ResponseDetails, err error)
func (*Channel) GetDomain ¶
func (email *Channel) GetDomain( ctx context.Context, domainName string, ) (resp models.GetEmailDomainResponse, respDetails models.ResponseDetails, err error)
func (*Channel) GetDomains ¶
func (email *Channel) GetDomains( ctx context.Context, queryParams models.GetEmailDomainsParams, ) (resp models.GetEmailDomainsResponse, respDetails models.ResponseDetails, err error)
func (*Channel) GetLogs ¶
func (email *Channel) GetLogs( ctx context.Context, queryParams models.GetEmailLogsParams, ) (resp models.GetEmailLogsResponse, respDetails models.ResponseDetails, err error)
func (*Channel) GetSentBulks ¶
func (email *Channel) GetSentBulks( ctx context.Context, queryParams models.GetSentEmailBulksParams, ) (resp models.SentEmailBulksResponse, respDetails models.ResponseDetails, err error)
func (*Channel) GetSentBulksStatus ¶
func (email *Channel) GetSentBulksStatus( ctx context.Context, queryParams models.GetSentEmailBulksStatusParams, ) (resp models.SentEmailBulksStatusResponse, respDetails models.ResponseDetails, err error)
func (*Channel) RescheduleMessages ¶
func (email *Channel) RescheduleMessages( ctx context.Context, req models.RescheduleEmailRequest, queryParams models.RescheduleEmailParams, ) (resp models.RescheduleEmailResponse, respDetails models.ResponseDetails, err error)
func (*Channel) Send ¶
func (email *Channel) Send( ctx context.Context, msg models.EmailMsg, ) (msgResp models.SendEmailResponse, respDetails models.ResponseDetails, err error)
func (*Channel) UpdateDomainTracking ¶
func (email *Channel) UpdateDomainTracking( ctx context.Context, domainName string, req models.UpdateEmailDomainTrackingRequest, ) (resp models.UpdateEmailDomainTrackingResponse, respDetails models.ResponseDetails, err error)
func (*Channel) UpdateScheduledMessagesStatus ¶
func (email *Channel) UpdateScheduledMessagesStatus( ctx context.Context, req models.UpdateScheduledEmailStatusRequest, queryParams models.UpdateScheduledEmailStatusParams, ) (resp models.UpdateScheduledStatusResponse, respDetails models.ResponseDetails, err error)
func (*Channel) ValidateAddresses ¶
func (email *Channel) ValidateAddresses( ctx context.Context, req models.ValidateEmailAddressesRequest, ) (resp models.ValidateEmailAddressesResponse, respDetails models.ResponseDetails, err error)
func (*Channel) VerifyDomain ¶
type Email ¶
type Email interface { // GetDeliveryReports gets one-time delivery reports for all sent emails. GetDeliveryReports(ctx context.Context, queryParams models.GetEmailDeliveryReportsParams) ( resp models.GetEmailDeliveryReportsResponse, respDetails models.ResponseDetails, err error) // GetLogs gets email logs of sent Email messagesId for request. Logs are available for the last 48 hours. GetLogs(ctx context.Context, queryParams models.GetEmailLogsParams) ( resp models.GetEmailLogsResponse, respDetails models.ResponseDetails, err error) // GetSentBulks gets the scheduled time of your Email messages. GetSentBulks(ctx context.Context, queryParams models.GetSentEmailBulksParams) ( resp models.SentEmailBulksResponse, respDetails models.ResponseDetails, err error) // GetSentBulksStatus returns status of scheduled email messages. GetSentBulksStatus(ctx context.Context, queryParams models.GetSentEmailBulksStatusParams) ( resp models.SentEmailBulksStatusResponse, respDetails models.ResponseDetails, err error) // RescheduleMessages changes the date and time for scheduled messages. RescheduleMessages( ctx context.Context, req models.RescheduleEmailRequest, queryParams models.RescheduleEmailParams) ( resp models.RescheduleEmailResponse, respDetails models.ResponseDetails, err error) // Send sends an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled. Send(ctx context.Context, req models.EmailMsg) ( resp models.SendEmailResponse, respDetails models.ResponseDetails, err error) // UpdateScheduledMessagesStatus updates status or completely cancels sending of scheduled messages. UpdateScheduledMessagesStatus( ctx context.Context, req models.UpdateScheduledEmailStatusRequest, queryParams models.UpdateScheduledEmailStatusParams) ( resp models.UpdateScheduledStatusResponse, respDetails models.ResponseDetails, err error) // ValidateAddresses validates to identify poor quality emails to clear up your recipient list. ValidateAddresses(ctx context.Context, req models.ValidateEmailAddressesRequest) ( resp models.ValidateEmailAddressesResponse, respDetails models.ResponseDetails, err error) // GetDomains returns all domains associated with the account. It also provides details of the retrieved domain // like the DNS records, tracking details, active/blocked status, etc. GetDomains(ctx context.Context, queryParams models.GetEmailDomainsParams) ( resp models.GetEmailDomainsResponse, respDetails models.ResponseDetails, err error) // AddDomain adds new domains with a limit to create a maximum of 10 domains in a day. AddDomain(ctx context.Context, req models.AddEmailDomainRequest) ( resp models.AddEmailDomainResponse, respDetails models.ResponseDetails, err error) // GetDomain returns the details of the domain like the DNS records, tracking details, active/blocked status, etc. GetDomain(ctx context.Context, domainName string) ( resp models.GetEmailDomainResponse, respDetails models.ResponseDetails, err error) // DeleteDomain deletes an existing domain. DeleteDomain(ctx context.Context, domainName string) ( respDetails models.ResponseDetails, err error) // UpdateDomainTracking updates the tracking events for the provided domain. Tracking events can be updated // only for CLICKS, OPENS and UNSUBSCRIBES. UpdateDomainTracking(ctx context.Context, domainName string, req models.UpdateEmailDomainTrackingRequest) ( resp models.UpdateEmailDomainTrackingResponse, respDetails models.ResponseDetails, err error) // VerifyDomain verifies records(TXT, MX, DKIM) associated with the provided domain. VerifyDomain(ctx context.Context, domainName string) ( respDetails models.ResponseDetails, err error) }
Click to show internal directories.
Click to hide internal directories.