mail

README

Mailing Module for Golang

A Golang module for sending emails seamlessly using AWS or Send Grid.

Features

• AWS SES Integration: Send transactional emails via AWS SES.
• Send Grid Support: Integrate with SendGrid for email delivery.
• Simple API: Easy-to-use interface for developers.

---

Installation

Get started by installing the package:

go get github.com/fsobh/mail

---

Usage

Initialize the Mailer

Before sending emails, configure the mailer with your provider's credentials.

Ensure that the sender email has been verified with its respective provider :

1. AWS SES guide here
2. Send Grid guide here

package main

import (
	"fmt"
	"github.com/fsobh/mail"
)

func main() {

	/*
	 Never paste your credentials directly in the code for safety reasons
	 Recommended : Store these in environment variables using [viper](https://github.com/spf13/viper)
	*/

	senderEmail := "example@sender.com"
	sesRegion :=  "us-east-1"
	sgAPIKey := "<your-api-key>"
	sgAppName := "<your-app-name>"

	//Initialize a new AWS SES mailer
	mailerSES := mail.NewSESSender(sesRegion, senderEmail)

	//Initialize a new Send Grid mailer
	mailerSendGrid := mail.NewSendGridSender(sgAPIKey, sgAppName, senderEmail)

	subject := "Email Subject"
	contentHtml := fmt.Sprintf("<h1>Email HTML content</h1>")
	to := []string{"reciever@email.com"}
	cc := []string{"cc@email.com"}
	bcc := []string{"bcc@email.com>"}
	attachments := []string{"../files/example.txt"}

	// SES example
	err := mailerSES.SendMail(subject, contentHtml, to, cc, bcc, nil) //can't do attachments on SES

	if err != nil {
		_ = fmt.Errorf("error sending email via SES: %s", err)
	}

	// Send Grid example
	err = mailerSendGrid.SendMail(subject, contentHtml, to, cc, bcc, attachments)

	if err != nil {
		_ = fmt.Errorf("error sending email via Send Grid: %s", err)
	}

	fmt.Println("Email sent successfully")

}

Notes

To test AWS SES sends locally, you must export your IAM roles Access ID & Secret :

1. Follow this guide to generate the credentials for your IAM account (make sure you give it the right access policies to send Emails via SES).
2. Export your credentials locally in your terminal

export AWS_ACCESS_KEY_ID="your-access-key-id"
export AWS_SECRET_ACCESS_KEY="your-secret-access-key"
export AWS_DEFAULT_REGION="us-west-2" # Change to your region

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

Index

• type EmailSender
  • func NewSESSender(region string, senderEmail string) EmailSender
  • func NewSendGridSender(apiKey string, appName string, appEmail string) EmailSender
• type SESSender
  • func (s *SESSender) SendMail(subject string, content string, to []string, cc []string, bcc []string, ...) error
• type SMSSender
  • func NewSNSSender(region string, senderPhoneNumber string) SMSSender
  • func NewTwilioSender(accountSID string, authToken string, senderPhoneNumber string) SMSSender
• type SNSSender
  • func (s *SNSSender) SendBulkSMS(message string, to []string) error
  • func (s *SNSSender) SendSMS(message string, to []string) error
• type SendGridSender
  • func (s *SendGridSender) SendMail(subject string, content string, to []string, cc []string, bcc []string, ...) error
• type TwilioSender
  • func (t *TwilioSender) SendBulkSMS(message string, to []string) error
  • func (t *TwilioSender) SendSMS(message string, to []string) error

Types

type EmailSender

type EmailSender interface {
	SendMail(
		subject string,
		content string,
		to []string,
		cc []string,
		bcc []string,
		attachFiles []string,
	) error
}

func NewSESSender

func NewSESSender(region string, senderEmail string) EmailSender

NewSESSender initializes a new SESSender with optional credentials. If AccessKeyID and SecretKey are empty, the AWS SDK will use the default credentials chain.

func NewSendGridSender

func NewSendGridSender(apiKey string, appName string, appEmail string) EmailSender

NewSendGridSender initializes a new SendGridSender.

type SESSender

type SESSender struct {
	Region      string
	SenderEmail string
}

SESSender implements the EmailSender interface for AWS SES.

func (*SESSender) SendMail

func (s *SESSender) SendMail(
	subject string,
	content string,
	to []string,
	cc []string,
	bcc []string,
	attachFiles []string,
) error

type SMSSender

type SMSSender interface {
	SendSMS(
		message string,
		to []string,
	) error

	SendBulkSMS(
		message string,
		to []string,
	) error
}

SMSSender interface defines methods for sending SMS messages

func NewSNSSender

func NewSNSSender(region string, senderPhoneNumber string) SMSSender

NewSNSSender initializes a new SNSSender

func NewTwilioSender

func NewTwilioSender(accountSID string, authToken string, senderPhoneNumber string) SMSSender

NewTwilioSender initializes a new TwilioSender

type SNSSender

type SNSSender struct {
	Region            string
	SenderPhoneNumber string
}

SNSSender implements the SMSSender interface for AWS SNS

func (*SNSSender) SendBulkSMS

func (s *SNSSender) SendBulkSMS(message string, to []string) error

SendBulkSMS sends SMS messages to multiple recipients using AWS SNS

func (*SNSSender) SendSMS

func (s *SNSSender) SendSMS(message string, to []string) error

SendSMS sends an SMS message to a single recipient using AWS SNS

type SendGridSender

type SendGridSender struct {
	APIKey   string
	AppName  string
	AppEmail string
}

SendGridSender implements the EmailSender interface for SendGrid.

func (*SendGridSender) SendMail

func (s *SendGridSender) SendMail(
	subject string,
	content string,
	to []string,
	cc []string,
	bcc []string,
	attachFiles []string,
) error

type TwilioSender

type TwilioSender struct {
	AccountSID        string
	AuthToken         string
	SenderPhoneNumber string
}

TwilioSender implements the SMSSender interface for Twilio

func (*TwilioSender) SendBulkSMS

func (t *TwilioSender) SendBulkSMS(message string, to []string) error

SendBulkSMS sends SMS messages to multiple recipients using Twilio

func (*TwilioSender) SendSMS

func (t *TwilioSender) SendSMS(message string, to []string) error

SendSMS sends an SMS message to a single recipient using Twilio