mailgun

Documentation

Overview

Package mailgun implements mailer.Sender on the Mailgun HTTP API (v3) with no dependency beyond the standard library.

Index

• Constants
• type Client
  • func New(domain, apiKey string, opts ...Option) *Client
  • func (c *Client) Send(ctx context.Context, m *mailer.Message) (*mailer.Result, error)
• type Option
  • func WithBaseURL(u string) Option
  • func WithHTTPClient(h *http.Client) Option
  • func WithTimeout(d time.Duration) Option

Constants

const (
	// DefaultBaseURL serves US-region domains. EU-region domains must use
	// WithBaseURL(EUBaseURL).
	DefaultBaseURL = "https://api.mailgun.net"
	EUBaseURL      = "https://api.eu.mailgun.net"
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client sends messages through a single Mailgun domain. It is safe for concurrent use.

func New

func New(domain, apiKey string, opts ...Option) *Client

New returns a Client for the given sending domain and private API key.

func (*Client) Send

func (c *Client) Send(ctx context.Context, m *mailer.Message) (*mailer.Result, error)

Send posts the message to /v3/{domain}/messages as multipart form data.

type Option

type Option func(*Client)

Option configures a Client.

func WithBaseURL

func WithBaseURL(u string) Option

WithBaseURL overrides the API base URL (EU region, tests, proxy).

func WithHTTPClient

func WithHTTPClient(h *http.Client) Option

WithHTTPClient injects a custom *http.Client.

func WithTimeout

func WithTimeout(d time.Duration) Option

WithTimeout sets the HTTP client timeout.