mails

README

mails-go

Golang library for email sending.

Providers

List of available providers:

• Sendgrid
• Mandrill
• Mailgun
• SMTP
• log
• file

Usage

package main

import (
	"context"
	"time"

	"github.com/spacetab-io/configuration-structs-go/v2/configuration/mimetype"
	"github.com/spacetab-io/configuration-structs-go/v2/mailing"
	"github.com/spacetab-io/mails-go/contracts"
	"github.com/spacetab-io/mails-go/providers"
)

func main() {
	// 1. Get Provider config (with should implement mailing.MailProviderConfigInterface
	// For Example, Sendgrid Config
	sendgridCfg := mailing.SendgridConfig{
		Enabled:     true,
		Key:         "APIKey",
		SendTimeout: 5 * time.Second,
	}

	// 2. Initiate provider
	// Sendgrid provider
	sendgrid, err := providers.NewSendgrid(sendgridCfg)
	if err != nil {
		panic(err)
	}

	// 3. Prepare Message with should implement contracts.MessageInterface
	msg := contracts.Message{
		To: mailing.MailAddressList{
			{Email: "toOne@spacetab.io", Name: "To One"},
			{Email: "totwo@spacetab.io", Name: "To Two"},
		},
		MimeType: mime.TextPlain,
		Subject:  "Test email",
		Content:  []byte("test email content"),
	}

	// 4. Send message
	if err := sendgrid.Send(context.Background(), msg); err != nil {
		panic(err)
	}
}

Documentation

Index

• type Mailing
  • func NewMailing(providerCfg mailing.MailProviderConfigInterface, ...) (Mailing, error)
  • func NewMailingForProvider(provider contracts.ProviderInterface, msgCfg mailing.MessagingConfigInterface) Mailing
  • func (m Mailing) Send(ctx context.Context, msg contracts.MessageInterface) error
• type MockLogger
  • func NewLogger(writer io.Writer) MockLogger
  • func (m MockLogger) Print(log string)
  • func (m MockLogger) Printf(format string, args ...interface{})

Types

type Mailing

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

func NewMailing

func NewMailing(providerCfg mailing.MailProviderConfigInterface, msgCfg mailing.MessagingConfigInterface) (Mailing, error)

func NewMailingForProvider

func NewMailingForProvider(provider contracts.ProviderInterface, msgCfg mailing.MessagingConfigInterface) Mailing

func (Mailing) Send

func (m Mailing) Send(ctx context.Context, msg contracts.MessageInterface) error

type MockLogger

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

func NewLogger

func NewLogger(writer io.Writer) MockLogger

func (MockLogger) Print

func (m MockLogger) Print(log string)

func (MockLogger) Printf

func (m MockLogger) Printf(format string, args ...interface{})