go-kit
/
gomail
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved documentation

This commit is contained in:
Alexandre Cesaro 2015-07-16 22:35:43 +02:00
parent 0002611a09
commit d49395d6c9
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
message.go
View File

@ -75,7 +75,7 @@ type MessageSetting func(m *Message)
// //
// Example: // Example:
// //
// m := gomail.NewMessage(SetCharset("ISO-8859-1")) // m := gomail.NewMessage(gomail.SetCharset("ISO-8859-1"))
func SetCharset(charset string) MessageSetting { func SetCharset(charset string) MessageSetting {
return func(m *Message) { return func(m *Message) {
m.charset = charset m.charset = charset
@ -86,7 +86,7 @@ func SetCharset(charset string) MessageSetting {
// //
// Example: // Example:
// //
// m := gomail.NewMessage(SetEncoding(gomail.Base64)) // m := gomail.NewMessage(gomail.SetEncoding(gomail.Base64))
func SetEncoding(enc Encoding) MessageSetting { func SetEncoding(enc Encoding) MessageSetting {
return func(m *Message) { return func(m *Message) {
m.encoding = enc m.encoding = enc
@ -256,7 +256,8 @@ type File struct {
// message it is the name of the attachment. // message it is the name of the attachment.
Name string Name string
// Header represents the MIME header of the message part that contains the // Header represents the MIME header of the message part that contains the
// file content. // file content. It is empty by default. Mandatory headers are automatically
// added if they are not sent when sending the email.
Header map[string][]string Header map[string][]string
// Copier is a function run when the message is sent. It should copy the // Copier is a function run when the message is sent. It should copy the
// content of the file to w. // content of the file to w.
@ -287,6 +288,10 @@ func (f *File) setHeader(field string, value ...string) {
} }
// Attach attaches the files to the email. // Attach attaches the files to the email.
//
// Example:
//
// m.Attach(gomail.NewFile("/tmp/image.jpg"))
func (m *Message) Attach(f ...*File) { func (m *Message) Attach(f ...*File) {
if m.attachments == nil { if m.attachments == nil {
m.attachments = f m.attachments = f