mail

go-mail

go-mail: Go library for sending emails, supporting SMTP, attachments, and convenient message building.

Installation

go get github.com/fawwazid/go-mail

Features

• Fluent Message Builder: Easily construct emails with a chainable API.
• Attachments: Support for file attachments and inline files, with automatic base64 encoding.
• SMTP Support: Built-in support for SSL, TLS (StartTLS), and plain connections.
• Mocking: Includes a MockClient for easy unit testing in your application.

Usage

Sending a Simple Email

package main

import (
	"log"

	"github.com/fawwazid/go-mail"
)

func main() {
	// Create a new message
	msg := mail.NewMessage().
		SetFrom("[email protected]").
		AddTo("[email protected]").
		SetSubject("Hello from Go!").
		SetBody("text/plain", "This is a test email sent using go-mail.")

	// Create client (e.g., using Mailtrap, Gmail, etc.)
	// For Gmail usage, you likely need an App Password.
	client := mail.NewClient("smtp.example.com", 587, "user", "pass", mail.EncryptionTLS)

	// Send the email
	if err := client.Send(msg); err != nil {
		log.Fatalf("Failed to send email: %v", err)
	}
}

Sending HTML Email with Attachments

msg := mail.NewMessage().
    SetFrom("[email protected]").
    AddTo("[email protected]").
    SetSubject("Monthly Report").
    SetBody("text/html", "<h1>Report</h1><p>Please find the report attached.</p>")

// Add file from disk
if err := msg.AddAttachment("./report.pdf"); err != nil {
    log.Fatal(err)
}

// Add file from bytes
data := []byte("some content")
msg.AddAttachmentData("data.txt", data, "text/plain")

client := mail.NewClient("smtp.example.com", 465, "user", "pass", mail.EncryptionSSL)
if err := client.Send(msg); err != nil {
    log.Fatal(err)
}

Testing

You can use mail.MockClient to test your code without sending real emails.

mock := mail.NewMockClient()
myCodeThatSendsEmail(mock) // Inject the mock

if len(mock.SentMessages) != 1 {
    t.Errorf("Expected 1 message, got %d", len(mock.SentMessages))
}

License

MIT