Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qor/mailer
Mail solution
https://github.com/qor/mailer
Last synced: 5 days ago
JSON representation
Mail solution
- Host: GitHub
- URL: https://github.com/qor/mailer
- Owner: qor
- License: mit
- Created: 2017-07-07T08:52:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-29T08:32:59.000Z (over 6 years ago)
- Last Synced: 2024-06-18T17:12:16.878Z (5 months ago)
- Language: Go
- Homepage:
- Size: 26.4 KB
- Stars: 23
- Watchers: 12
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Mailer
Mail solution
## Usage
### Initailize Mailer
Mailer will support multiple sender adaptors, it works similar, you need to initialize a Mailer first, then use it to send emails.
Here is how to use [gomail](https://github.com/go-gomail/gomail) to send emails
```go
import (
"github.com/qor/mailer"
"github.com/qor/mailer/gomailer"
"github.com/go-gomail/gomail"
)
func main() {
// Config gomail
dailer := gomail.NewDialer("smtp.example.com", 587, "user", "123456")
sender, err := dailer.Dial()
// Initialize Mailer
Mailer := mailer.New(&mailer.Config{
Sender: gomailer.New(&gomailer.Config{Sender: sender}),
})
}
```
### Sending Emails
```go
import "net/mail"
func main() {
Mailer.Send(mailer.Email{
TO: []mail.Address{{Address: "[email protected]", Name: "jinzhu"}},
From: &mail.Address{Address: "[email protected]"},
Subject: "subject",
Text: "text email",
HTML: "html email ![]()
",
Attachments: []mailer.Attachment{{FileName: "gomail.go"}, {FileName: "../test/logo.png", Inline: true}},
})
}
```
### Sending Emails with templates
Mailer is using [Render](github.com/qor/render) to render email templates and layouts, please refer it for How-To.
Emails could have HTML and text version, when sending emails,
It will look up template `hello.html.tmpl` and layout `application.html.tmpl` from view paths, and render it as HTML version's content, and use template `hello.text.tmpl` and layout `application.text.tmpl` as text version's content.
If we haven't find the layout file, we will only render template as the content, and if we haven't find template, we will just skip that version, for example, if `hello.text.tmpl` doesn't exist, we will only send the HTML version.
```go
Mailer.Send(
mailer.Email{
TO: []mail.Address{{Address: Config.DefaultTo}},
From: &mail.Address{Address: Config.DefaultFrom},
Subject: "hello",
},
mailer.Template{Name: "hello", Layout: "application", Data: currentUser},
)
```
### Mailer View Paths
All templates and layouts should be located in `app/views/mailers`, but you could change or register more paths by customizing Mailer's AssetFS.
```go
import "github.com/qor/assetfs"
func main() {
assetFS := assetfs.AssetFS().NameSpace("mailer")
assetFS.RegisterPath("mailers/views")
Mailer := mailer.New(&mailer.Config{
Sender: gomailer.New(&gomailer.Config{Sender: sender}),
AssetFS: assetFS,
})
}
```