lib

Documentation

Index

• Variables
• func MustParseURL(rawURL string) *url.URL
• type APIClient
  • func CreateClient(projectSecret string, cfg *Config) *APIClient
• type Config
• type MailRecipient
• type MailSender
• type MailTemplate
• type SendMailOptions
• type SendMailResponse
• type SendMailWithTemplateOptions
• type SendService
  • func (s *SendService) SendMail(ctx context.Context, options SendMailOptions) (SendMailResponse, error)
  • func (s *SendService) SendMailWithTemplate(ctx context.Context, options SendMailWithTemplateOptions) (SendMailResponse, error)

Variables

var SmtpExpressURL string = "https://api.smtpexpress.com"

Functions

func MustParseURL

func MustParseURL(rawURL string) *url.URL

Types

type APIClient

type APIClient struct {
	Send *SendService
	// contains filtered or unexported fields
}

func CreateClient

func CreateClient(projectSecret string, cfg *Config) *APIClient

type Config

type Config struct {
	BaseUrl    *url.URL
	HttpClient *http.Client
}

type MailRecipient

type MailRecipient = MailSender

type MailSender

type MailSender struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

type MailTemplate

type MailTemplate struct {
	ID        string            `json:"id,omitempty"`
	Variables map[string]string `json:"variables,omitempty"`
}

type SendMailOptions

type SendMailOptions struct {
	Subject    string          `json:"subject,omitempty"`
	Message    string          `json:"message,omitempty"`
	Sender     MailSender      `json:"sender,omitempty"`
	Recipients []MailRecipient `json:"recipients,omitempty"`
}

type SendMailResponse

type SendMailResponse struct {
	Message    string `json:"message"`
	StatusCode int    `json:"statusCode"`
	Data       struct {
		Ref string `json:"ref"`
	} `json:"data"`
}

type SendMailWithTemplateOptions

type SendMailWithTemplateOptions struct {
	Subject    string          `json:"subject,omitempty"`
	Template   MailTemplate    `json:"template,omitempty"`
	Sender     MailSender      `json:"sender,omitempty"`
	Recipients []MailRecipient `json:"recipients,omitempty"`
}

type SendService

type SendService service

func (*SendService) SendMail

func (s *SendService) SendMail(ctx context.Context, options SendMailOptions) (SendMailResponse, error)

func (*SendService) SendMailWithTemplate

func (s *SendService) SendMailWithTemplate(ctx context.Context, options SendMailWithTemplateOptions) (SendMailResponse, error)