README
¶
gomail
This is a Go package for sending emails. It provides functionality to send emails using the SMTP protocol.
Installation
To use the package, you need to have Go installed and Go modules enabled in your project. Then you can add the package to your project by running the following command:
go get -u github.com/mstgnz/gomail
Usage
package main
import (
"github.com/mstgnz/gomail"
)
func main() {
// Create a Mail struct and set the necessary fields
mail := &Mail{
from: "sender@example.com",
name: "Sender Name",
host: "smtp.example.com",
port: "587",
user: "username",
pass: "password",
}
// Send the email with text
err := mail.SetSubject("Test Email").
SetContent("This is a test email.").
SetTo([]string{"recipient@example.com"}).
SendText()
if err != nil {
// Handle error
}
// Send the email with HTML
err = mail.SetSubject("Test Email").
SetContent("<html><body><h1>This is a test email.</h1></body></html>").
SetTo("recipient@example.com").
SendHTML()
if err != nil {
// Handle error
}
// Send the email with attachment
attachments := map[string][]byte{
"file.txt": []byte("Attachment content"),
}
err = mail.SetSubject("Test Email with Attachment").
SetContent("This is a test email with attachment.").
SetTo("recipient@example.com").
SetAttachment(attachments).
SendText()
if err != nil {
// Handle error
}
}
Features
- Uses the SMTP protocol for sending emails.
- Provides error handling mechanism during email sending process.
- Allows setting basic parameters required for email sending.
Contributing
Contributions are welcome! For any feedback, bug reports, or contributions, please submit an issue or pull request to the GitHub repository.
License
This package is licensed under the MIT License. See the LICENSE file for more information.
Documentation
¶
Index ¶
- type Mail
- func (m *Mail) SendHTML() error
- func (m *Mail) SendText() error
- func (m *Mail) SetAttachment(attachments map[string][]byte) *Mail
- func (m *Mail) SetBcc(bcc ...string) *Mail
- func (m *Mail) SetCc(cc ...string) *Mail
- func (m *Mail) SetContent(content string) *Mail
- func (m *Mail) SetFrom(from string) *Mail
- func (m *Mail) SetHost(host string) *Mail
- func (m *Mail) SetKeepAlive(keepAlive time.Duration) *Mail
- func (m *Mail) SetName(name string) *Mail
- func (m *Mail) SetPass(pass string) *Mail
- func (m *Mail) SetPort(port string) *Mail
- func (m *Mail) SetSubject(subject string) *Mail
- func (m *Mail) SetTimeout(timeout time.Duration) *Mail
- func (m *Mail) SetTo(to ...string) *Mail
- func (m *Mail) SetUser(user string) *Mail
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Mail ¶
type Mail struct {
From string
Name string
Host string
Port string
User string
Pass string
Subject string
Content string
To []string
Cc []string
Bcc []string
Attachments map[string][]byte
Timeout time.Duration
KeepAlive time.Duration
}
func (*Mail) SetAttachment ¶
SetAttachment sets the email attachments
func (*Mail) SetContent ¶
SetContent sets the email content
func (*Mail) SetSubject ¶
SetSubject sets the email subject
Source Files
Click to show internal directories.
Click to hide internal directories.