diff --git a/example_test.go b/example_test.go
index a09ca73..61a75ad 100644
--- a/example_test.go
+++ b/example_test.go
@@ -2,7 +2,9 @@ package gomail_test
import (
"fmt"
+ "html/template"
"io"
+ "log"
"time"
"gopkg.in/gomail.v2-unstable"
@@ -25,6 +27,7 @@ func Example() {
}
}
+// A daemon that listens to a channel and sends all incoming messages.
func Example_daemon() {
ch := make(chan *gomail.Message)
@@ -47,13 +50,15 @@ func Example_daemon() {
open = true
}
if err := gomail.Send(s, m); err != nil {
- panic(err)
+ log.Print(err)
}
// Close the connection to the SMTP server if no email was sent in
// the last 30 seconds.
case <-time.After(30 * time.Second):
if open {
- s.Close()
+ if err := s.Close(); err != nil {
+ panic(err)
+ }
open = false
}
}
@@ -66,6 +71,34 @@ func Example_daemon() {
close(ch)
}
+// Efficiently send a customized newsletter to a list of recipients.
+func Example_newsletter() {
+ // The list of recipient.
+ var list []struct {
+ Name string
+ Address string
+ }
+
+ d := gomail.NewPlainDialer("smtp.example.com", "user", "123456", 587)
+ s, err := d.Dial()
+ if err != nil {
+ panic(err)
+ }
+
+ m := gomail.NewMessage()
+ for _, r := range list {
+ m.SetHeader("From", "no-reply@example.com")
+ m.SetAddressHeader("To", r.Address, r.Name)
+ m.SetHeader("Subject", "Newsletter #1")
+ m.SetBody("text/html", fmt.Sprintf("Hello %s!", r.Name))
+ if err := gomail.Send(s, m); err != nil {
+ log.Printf("Could not send email to %q: %v", r.Address, err)
+ }
+ m.Reset()
+ }
+}
+
+// Send an email using a local SMTP server.
func Example_noAuth() {
m := gomail.NewMessage()
m.SetHeader("From", "from@example.com")
@@ -73,12 +106,13 @@ func Example_noAuth() {
m.SetHeader("Subject", "Hello!")
m.SetBody("text/plain", "Hello!")
- d := gomail.Dialer{Host: "smtp.example.com", Port: 587}
+ d := gomail.Dialer{Host: "localhost", Port: 587}
if err := d.DialAndSend(m); err != nil {
panic(err)
}
}
+// Send an email using an API or postfix.
func Example_send() {
m := gomail.NewMessage()
m.SetHeader("From", "from@example.com")
@@ -101,3 +135,62 @@ func Example_send() {
// From: from@example.com
// To: [to@example.com]
}
+
+var m *gomail.Message
+
+func ExampleSetCharset() {
+ m = gomail.NewMessage(gomail.SetCharset("ISO-8859-1"))
+}
+
+func ExampleSetEncoding() {
+ m = gomail.NewMessage(gomail.SetEncoding(gomail.Base64))
+}
+
+func ExampleMessage_SetHeaders() {
+ m.SetHeaders(map[string][]string{
+ "From": {m.FormatAddress("alex@example.com", "Alex")},
+ "To": {"bob@example.com", "cora@example.com"},
+ "Subject": {"Hello"},
+ })
+}
+
+func ExampleMessage_FormatAddress() {
+ m.SetHeader("To", m.FormatAddress("bob@example.com", "Bob"), m.FormatAddress("cora@example.com", "Cora"))
+}
+
+func ExampleMessage_SetDateHeader() {
+ m.SetDateHeader("X-Date", time.Now())
+}
+
+func ExampleMessage_AddAlternative() {
+ m.SetBody("text/plain", "Hello!")
+ m.AddAlternative("text/html", "Hello!
")
+}
+
+func ExampleMessage_AddAlternativeWriter() {
+ t := template.Must(template.New("example").Parse("Hello {{.}}!"))
+ m.AddAlternativeWriter("text/plain", func(w io.Writer) error {
+ return t.Execute(w, "Bob")
+ })
+}
+
+func ExampleSetHeader() {
+ h := map[string][]string{"Content-ID": {""}}
+ m.Attach("foo.jpg", gomail.SetHeader(h))
+}
+
+func ExampleSetCopyFunc() {
+ m.Attach("foo.txt", gomail.SetCopyFunc(func(w io.Writer) error {
+ _, err := w.Write([]byte("Content of foo.txt"))
+ return err
+ }))
+}
+
+func ExampleMessage_Attach() {
+ m.Attach("/tmp/image.jpg")
+}
+
+func ExampleMessage_Embed() {
+ m.Embed("/tmp/image.jpg")
+ m.SetBody("text/html", `
`)
+}
diff --git a/message.go b/message.go
index 2ccf4e1..a041400 100644
--- a/message.go
+++ b/message.go
@@ -69,10 +69,6 @@ func (m *Message) applySettings(settings []MessageSetting) {
type MessageSetting func(m *Message)
// SetCharset is a message setting to set the charset of the email.
-//
-// Example:
-//
-// m := gomail.NewMessage(gomail.SetCharset("ISO-8859-1"))
func SetCharset(charset string) MessageSetting {
return func(m *Message) {
m.charset = charset
@@ -80,10 +76,6 @@ func SetCharset(charset string) MessageSetting {
}
// SetEncoding is a message setting to set the encoding of the email.
-//
-// Example:
-//
-// m := gomail.NewMessage(gomail.SetEncoding(gomail.Base64))
func SetEncoding(enc Encoding) MessageSetting {
return func(m *Message) {
m.encoding = enc
@@ -121,14 +113,6 @@ func (m *Message) encodeString(value string) string {
}
// SetHeaders sets the message headers.
-//
-// Example:
-//
-// m.SetHeaders(map[string][]string{
-// "From": {"alex@example.com"},
-// "To": {"bob@example.com", "cora@example.com"},
-// "Subject": {"Hello"},
-// })
func (m *Message) SetHeaders(h map[string][]string) {
for k, v := range h {
m.SetHeader(k, v...)
@@ -210,11 +194,6 @@ func (m *Message) SetBody(contentType, body string) {
// send HTML emails that default to the plain text version for backward
// compatibility.
//
-// Example:
-//
-// m.SetBody("text/plain", "Hello!")
-// m.AddAlternative("text/html", "Hello!
")
-//
// More info: http://en.wikipedia.org/wiki/MIME#Alternative
func (m *Message) AddAlternative(contentType, body string) {
m.parts = append(m.parts,
@@ -230,13 +209,6 @@ func (m *Message) AddAlternative(contentType, body string) {
// AddAlternativeWriter adds an alternative part to the message. It can be
// useful with the text/template and html/template packages.
-//
-// Example:
-//
-// t := template.Must(template.New("example").Parse("Hello {{.}}!"))
-// m.AddAlternativeWriter("text/plain", func(w io.Writer) error {
-// return t.Execute(w, "Bob")
-// })
func (m *Message) AddAlternativeWriter(contentType string, f func(io.Writer) error) {
m.parts = []part{
{
@@ -271,11 +243,6 @@ type FileSetting func(*file)
//
// Mandatory headers are automatically added if they are not set when sending
// the email.
-//
-// Example:
-//
-// h := map[string][]string{"Content-ID": {""}}
-// m.Attach("foo.jpg", gomail.SetHeader(h))
func SetHeader(h map[string][]string) FileSetting {
return func(f *file) {
for k, v := range h {
@@ -289,13 +256,6 @@ func SetHeader(h map[string][]string) FileSetting {
// It should copy the content of the file to the io.Writer.
// The default copy function opens the file with the given filename, and copy
// its content to the io.Writer.
-//
-// Example:
-//
-// m.Attach("foo.txt", gomail.SetCopyFunc(func(w io.Writer) error {
-// _, err := w.Write([]byte("Content of foo.txt"))
-// return err
-// }))
func SetCopyFunc(f func(io.Writer) error) FileSetting {
return func(fi *file) {
fi.CopyFunc = f
@@ -331,20 +291,11 @@ func (m *Message) appendFile(list []*file, name string, settings []FileSetting)
}
// Attach attaches the files to the email.
-//
-// Example:
-//
-// m.Attach("/tmp/image.jpg")
func (m *Message) Attach(filename string, settings ...FileSetting) {
m.attachments = m.appendFile(m.attachments, filename, settings)
}
// Embed embeds the images to the email.
-//
-// Example:
-//
-// m.Embed("/tmp/image.jpg")
-// m.SetBody("text/html", ``)
func (m *Message) Embed(filename string, settings ...FileSetting) {
m.embedded = m.appendFile(m.embedded, filename, settings)
}