README
¶
Go Mailer
Go Mailer is a simple and flexible Go package for sending HTML emails via SMTP.
It provides an easy way to render HTML templates with dynamic data and send them as emails.
📦 Installation
go get github.com/phzeng0726/go-mailer@v0.1.4
🚀 Example Usage
package main
import (
"log"
"github.com/phzeng0726/go-mailer"
)
func main() {
// Initialize Mail Manager
manager, err := gomailer.NewManager("smtp.example.com", "587", "you@example.com", "./templates", "./templates/css")
if err != nil {
log.Fatalf("failed to create manager: %v", err)
}
// Render template with dynamic data
body, err := manager.RenderTemplate("welcome.html", map[string]any{
"Name": "Someone",
})
if err != nil {
log.Fatalf("failed to render template: %v", err)
}
// Send the email
err = manager.SendMail(gomailer.MailMessage{
Subject: "Hello",
Message: body,
To: []string{"someone@example.com"},
})
if err != nil {
log.Fatalf("failed to send mail: %v", err)
}
log.Println("Mail sent successfully!")
}
✨ Features
- Simple API for sending emails
- HTML template rendering with dynamic data
- Support for template helper functions
- Lightweight and easy to integrate
📘 API Reference
NewManager
func NewManager(smtpServer, smtpPort, smtpSender, templatePath, cssPath string) (*Manager, error)
Creates a new mail manager instance.
smtpServer: SMTP server address (e.g.,smtp.example.com)smtpPort: SMTP server port (e.g.,587)smtpSender: Sender's email addresstemplatePath: Root directory of your template filescssPath: Root directory of your css files
SendMail
func (m *Manager) SendMail(mm MailMessage) error
Sends an email.
mm: AMailMessagestruct containing subject, message body, and recipient addresses.
RenderTemplate
func (m *Manager) RenderTemplate(tmplFile string, data any) (string, error)
Renders an HTML template using the provided data.
RenderTemplateWithFuncs
func (m *Manager) RenderTemplateWithFuncs(tmplFile string, data any) (string, error)
Renders an HTML template with additional template functions like add.
RenderTemplateWithCSS
func (m *Manager) RenderTemplateWithCSS(tmplFile, cssFile string, data any) (string, error)
Renders an HTML template using the provided data and an external CSS file, automatically converting the CSS to inline styles.
RenderTemplateWithFuncsAndCSS
func (m *Manager) RenderTemplateWithFuncsAndCSS(tmplFile, cssFile string, data any) (string, error)
Renders an HTML template with additional template functions like add and an external CSS file, automatically converting the CSS to inline styles.
✉️ MailMessage Struct
type MailMessage struct {
Subject string // Email subject
Message string // HTML email content
To []string // Recipient email addresses
}
📝 Example Template (hello.html)
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Hello, {{.Name}}</title>
</head>
<body>
<h1>Hello, {{.Name}}!</h1>
<p>Welcome to our service.</p>
</body>
</html>
This template will be rendered with the Name field provided in the data map.
🪪 License
Documentation
¶
Index ¶
- type MailManager
- type MailMessage
- type Manager
- func (m *Manager) RenderTemplate(tmplFile string, data any) (string, error)
- func (m *Manager) RenderTemplateWithCSS(tmplFile, cssFile string, data any) (string, error)
- func (m *Manager) RenderTemplateWithFuncs(tmplFile string, data any) (string, error)
- func (m *Manager) RenderTemplateWithFuncsAndCSS(tmplFile, cssFile string, data any) (string, error)
- func (m *Manager) SendMail(mm MailMessage) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MailManager ¶
type MailManager interface {
SendMail(mm MailMessage) error
RenderTemplate(tmplFile string, data any) (string, error)
RenderTemplateWithFuncs(tmplFile string, data any) (string, error)
RenderTemplateWithCSS(tmplFile, cssFile string, data any) (string, error)
RenderTemplateWithFuncsAndCSS(tmplFile, cssFile string, data any) (string, error)
}
type MailMessage ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func NewManager ¶
func (*Manager) RenderTemplate ¶
func (*Manager) RenderTemplateWithCSS ¶
func (*Manager) RenderTemplateWithFuncs ¶
func (*Manager) RenderTemplateWithFuncsAndCSS ¶
func (*Manager) SendMail ¶
func (m *Manager) SendMail(mm MailMessage) error
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.