Skip to content
forked from keighl/mandrill

Simple package for sending emails, templates and subaccounts through the Mandrill API.

License

Notifications You must be signed in to change notification settings

kakysha/mandrill

 
 

Repository files navigation

Mandrill API via Golang

Build Status Coverage Status

Stripped down package for sending emails through the Mandrill API. Inspired by @mostafah's implementation.

Installation

go get -u github.com/kakysha/mandrill

Documentation

http://godoc.org/github.com/kakysha/mandrill

Regular Message

https://mandrillapp.com/api/docs/messages.JSON.html#method=send

import (
    m "github.com/kakysha/mandrill"
)

client := m.ClientWithKey("XXXXXXXXX")

message := &m.Message{}
message.AddRecipient("[email protected]", "Bob Johnson", "to")
message.FromEmail = "[email protected]"
message.FromName = "Kyle Truscott"
message.Subject = "You won the prize!"
message.HTML = "<h1>You won!!</h1>"
message.Text = "You won!!"

responses, err := client.MessagesSend(message)

Message Using Template (template_content version)

https://mandrillapp.com/api/docs/messages.JSON.html#method=send-template

templateContent := map[string]string{"header": "Bob! You won the prize!"}
responses, err := client.MessagesSendTemplate(message, "you-won", templateContent)

Message Using Template (per recipient merge_vars version)

https://mandrillapp.com/api/docs/messages.JSON.html#method=send-template

// build per-recipient merge vars
merge_values := make(map[string]interface{})
merge_values["discount"] = site.Discount
merge_values["promocode"] = site.Promocode
merge_values["url_tag"] = site.Url_Tag
// bind vars to recipient's email
rcpt_merge_vars := mandrill.MapToRecipientVars(email, merge_values)
// append this recipient vars to all merge_vars
all_merge_vars = append(all_merge_vars, rcpt_merge_vars)
// fill template struct and send
message.MergeVars = all_merge_vars
responses, err := client.MessagesSendTemplate(message, "template-slug", nil)

Templates API

https://mandrillapp.com/api/docs/templates.JSON.html

  • AddTemplate()
  • UpdateTemplate()
  • DeleteTemplate()
  • TemplateInfo()
template := &m.Template{
	Name:      "Example Template",
	Subject:   "Account Activation",
	HTML:      "<h1>You've signed up for *|SITE_NAME|*</h1>",
	Text: "You've signed up for *|SITE_NAME|*",
	FromEmail: "[email protected]",
	FromName:  "Site Account System",
	Labels: []string{"account", "account-activation"}
}

res, err := client.UpdateTemplate(template)
if err != nil {
	res, err = client.AddTemplate(template)
}

Subaccounts API

https://mandrillapp.com/api/docs/subaccounts.JSON.html

  • AddSubaccount()
  • UpdateSubaccount()
  • DeleteSubaccount()
  • SubaccountInfo()
subaccount := &m.Subaccount{
	Id:           "cust-123",
	Name:         "ABC Widgets, Inc.",
	Notes:        "Free plan user, signed up on 2013-01-01 12:00:00",
	Quota:        42,
}

res, err := client.UpdateSubaccount(subaccount)
if err != nil {
	res, err = client.AddSubaccount(subaccount)
}

Including Merge Tags

http://help.mandrill.com/entries/21678522-How-do-I-use-merge-tags-to-add-dynamic-content-

// Global vars
message.GlobalMergeVars = m.MapToVars(map[string]interface{}{"name": "Bob"})

// Recipient vars
bobVars := m.MapToRecipientVars("[email protected]", map[string]interface{}{"name": "Bob"})
jillVars := m.MapToRecipientVars("[email protected]", map[string]interface{}{"name": "Jill"})
message.MergeVars = []*m.RcptMergeVars{bobVars, jillVars}

Integration Testing Keys

You can pass special API keys to the client to mock success/err responses from MessagesSend or MessagesSendTemplate.

// Sending messages will be successful, but without a real API request
c := ClientWithKey("SANDBOX_SUCCESS")

// Sending messages will error, but without a real API request
c := ClientWithKey("SANDBOX_ERROR")

About

Simple package for sending emails, templates and subaccounts through the Mandrill API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%