Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adueck/mimemailer
Easily create and send MIME emails in Go 📬
https://github.com/adueck/mimemailer
Last synced: about 2 months ago
JSON representation
Easily create and send MIME emails in Go 📬
- Host: GitHub
- URL: https://github.com/adueck/mimemailer
- Owner: adueck
- License: mit
- Created: 2019-07-02T08:57:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-16T19:54:33.000Z (over 5 years ago)
- Last Synced: 2024-10-12T19:35:52.335Z (3 months ago)
- Language: Go
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mimemailer
[](https://travis-ci.org/adueck/mimemailer)
[](https://goreportcard.com/report/github.com/adueck/mimemailer)
[](https://godoc.org/github.com/adueck/mimemailer)
> Easily create and send MIME emails in Go
Mimemailer provides a way to easily create send multi-part MIME email messages as specified by RFC 2045 and RFC 2046. It is inspired by [nodemailer](https://nodemailer.com/about/) but it much more limited and minimal.
Mimemailer takes a HTML email message, parses into an html - text multi-part MIME message, and sends it over SMTP
This package takes care of:
* [x] Connecting to a SMTP server through TLS
* [x] Creating a text version of an HTML email
* [x] Converting the HTML and Text versions to [Quoted Printable](https://en.wikipedia.org/wiki/Quoted-printable) format
* [x] Put together whole email according to [RFC 2045](https://www.ietf.org/rfc/rfc2045.txt) and [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt)
Given an email like this:
```
Email{
ToAddress: "[email protected]",
ToName: "Test Recipient",
Subject: "Test Email",
Date: time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC),
HTML: `
Hello 🌍. This email wíll be formatted as a MIME message as per RFC 2045 and RFC 2046 📧
`,
}
```
It will generate and send a multi-part MIME message over SMTP like this:
```
Subject: Test Email
From: "Sender Name"
To: "Test Recipient"
Date: Tue, 10 Nov 2009 23:00:00 +0000
MIME-Version: 1.0
Content-Type: multipart/alternative; boundary=boundary42
--boundary42
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Hello =F0=9F=8C=8D. This email w=C3=ADll be formatted as a MIME message as =
per RFC 2045 and RFC 2046 =F0=9F=93=A7
--boundary42
Content-Type: text/html; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Hello =F0=9F=8C=8D. This email w=C3=ADll be formatted as a MIME message =
as per RFC 2045 and RFC 2046 =F0=9F=93=A7
--boundary42--
```
The text version is generated automatically, and the message is converted
into quoted printable format with CRLF line endings.
After connecting to a SMTP server, you can send multiple messages and re-use
the same connection.
Example Usage:
```
import (
"log"
"github.com/adueck/mimemailer"
)
func main() {
Step 1 - Create a new mailer instance with config for SMTP
m, err := mimemailer.NewMailer(mimemailer.Config{
Host: "smtp.example.com",
Port: "576",
Username: "myusername",
Password: "mysecretpassword",
SenderName: "My Name",
SenderAddress: "[email protected]",
})
if err != nil {
log.Fatal(err)
}
Step 2 - Connect to SMTP Server
err = m.Connect()
if err != nil {
log.Fatal(err)
}
Step 3 - Send message(s)
err = m.SendEmail(mimemailer.Email{
ToAddress: "[email protected]",
ToName: "Bob Smith",
Subject: "Example Mail",
HTML: "
Hello Bob
",
Date: time.Now(),
})
if err != nil {
log.Print(err)
}
...
You can send more messages on the persistent connection
When you are done, disconnect from the SMTP server
Step 4 - Disconnect from SMTP server
err = m.Disconnect()
if err != nil {
log.Fatal(err)
}
}
```
## Documentation
[https://godoc.org/github.com/adueck/mimemailer](https://godoc.org/github.com/adueck/mimemailer)