email

Documentation

Index

• type Channel
  • func (email *Channel) GetDeliveryReports(ctx context.Context, queryParams models.GetDeliveryReportsOpts) (resp models.EmailDeliveryReportsResponse, respDetails models.ResponseDetails, ...)
  • func (email *Channel) GetLogs(ctx context.Context, queryParams models.GetLogsOpts) (resp models.EmailLogsResponse, respDetails models.ResponseDetails, err error)
  • func (email *Channel) GetSentBulks(ctx context.Context, queryParams models.GetSentBulksOpts) (resp models.SentEmailBulksResponse, respDetails models.ResponseDetails, ...)
  • func (email *Channel) GetSentBulksStatus(ctx context.Context, queryParams models.GetSentBulksStatusOpts) (resp models.SentEmailBulksStatusResponse, respDetails models.ResponseDetails, ...)
  • func (email *Channel) RescheduleMessages(ctx context.Context, req models.RescheduleMessagesRequest, ...) (resp models.RescheduleMessagesResponse, respDetails models.ResponseDetails, ...)
  • func (email *Channel) Send(ctx context.Context, msg models.EmailMsg) (msgResp models.SendEmailResponse, respDetails models.ResponseDetails, ...)
  • func (email *Channel) UpdateScheduledMessagesStatus(ctx context.Context, req models.UpdateScheduledMessagesStatusRequest, ...) (resp models.UpdateScheduledMessagesStatusResponse, ...)
  • func (email *Channel) ValidateAddresses(ctx context.Context, req models.ValidateAddressesRequest) (resp models.ValidateAddressesResponse, respDetails models.ResponseDetails, ...)
• type Email

Types

type Channel

type Channel struct {
	ReqHandler internal.HTTPHandler
}

func (*Channel) GetDeliveryReports

func (email *Channel) GetDeliveryReports(
	ctx context.Context,
	queryParams models.GetDeliveryReportsOpts,
) (resp models.EmailDeliveryReportsResponse, respDetails models.ResponseDetails, err error)

GetDeliveryReports gets one-time delivery reports for all sent emails.

func (*Channel) GetLogs

func (email *Channel) GetLogs(ctx context.Context,
	queryParams models.GetLogsOpts,
) (resp models.EmailLogsResponse, respDetails models.ResponseDetails, err error)

GetLogs gets email logs of sent Email messagesId for request. Logs are available for the last 48 hours.

func (*Channel) GetSentBulks

func (email *Channel) GetSentBulks(ctx context.Context,
	queryParams models.GetSentBulksOpts,
) (resp models.SentEmailBulksResponse, respDetails models.ResponseDetails, err error)

GetSentBulks gets the scheduled time of your Email messages.

func (*Channel) GetSentBulksStatus

func (email *Channel) GetSentBulksStatus(ctx context.Context,
	queryParams models.GetSentBulksStatusOpts,
) (resp models.SentEmailBulksStatusResponse, respDetails models.ResponseDetails, err error)

GetSentBulksStatus returns status of scheduled email messages.

func (*Channel) RescheduleMessages

func (email *Channel) RescheduleMessages(
	ctx context.Context,
	req models.RescheduleMessagesRequest,
	queryParams models.RescheduleMessagesOpts,
) (resp models.RescheduleMessagesResponse, respDetails models.ResponseDetails, err error)

RescheduleMessages changes the date and time for scheduled messages.

func (*Channel) Send

func (email *Channel) Send(
	ctx context.Context,
	msg models.EmailMsg,
) (msgResp models.SendEmailResponse, respDetails models.ResponseDetails, err error)

Send sends an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled.

func (*Channel) UpdateScheduledMessagesStatus

func (email *Channel) UpdateScheduledMessagesStatus(ctx context.Context,
	req models.UpdateScheduledMessagesStatusRequest,
	queryParams models.UpdateScheduledMessagesStatusOpts,
) (resp models.UpdateScheduledMessagesStatusResponse, respDetails models.ResponseDetails, err error)

UpdateScheduledMessagesStatus updates status or completely cancels sending of scheduled messages.

func (*Channel) ValidateAddresses

func (email *Channel) ValidateAddresses(ctx context.Context,
	req models.ValidateAddressesRequest,
) (resp models.ValidateAddressesResponse, respDetails models.ResponseDetails, err error)

ValidateAddresses validates to identify poor quality emails to clear up your recipient list.

type Email

type Email interface {
	GetDeliveryReports(ctx context.Context, queryParams models.GetDeliveryReportsOpts) (
		resp models.EmailDeliveryReportsResponse, respDetails models.ResponseDetails, err error)
	GetLogs(ctx context.Context, queryParams models.GetLogsOpts) (
		resp models.EmailLogsResponse, respDetails models.ResponseDetails, err error)
	GetSentBulks(ctx context.Context, queryParams models.GetSentBulksOpts) (
		resp models.SentEmailBulksResponse, respDetails models.ResponseDetails, err error)
	GetSentBulksStatus(ctx context.Context, queryParams models.GetSentBulksStatusOpts) (
		resp models.SentEmailBulksStatusResponse, respDetails models.ResponseDetails, err error)
	RescheduleMessages(
		ctx context.Context, req models.RescheduleMessagesRequest, queryParams models.RescheduleMessagesOpts) (
		resp models.RescheduleMessagesResponse, respDetails models.ResponseDetails, err error)
	Send(ctx context.Context, req models.EmailMsg) (
		resp models.SendEmailResponse, respDetails models.ResponseDetails, err error)
	UpdateScheduledMessagesStatus(
		ctx context.Context,
		req models.UpdateScheduledMessagesStatusRequest,
		queryParams models.UpdateScheduledMessagesStatusOpts) (
		resp models.UpdateScheduledMessagesStatusResponse, respDetails models.ResponseDetails, err error)
	ValidateAddresses(ctx context.Context, req models.ValidateAddressesRequest) (
		resp models.ValidateAddressesResponse, respDetails models.ResponseDetails, err error)
}