mandrill

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func New(apiKey, subAccount, fromEmail, fromName string) *Client

func (m *Client) APIKey() string

func (m *Client) SendMessage(html, subject, toEmail, toName string, tags []string) ([]*SendResponse, error)

func (m *Client) SendMessageWithAttachments(html, subject, toEmail, toName string,
	tags []string, attachments []*MessageAttachment) ([]*SendResponse, error)

func (m *Client) SendMessageWithReader(html, subject, toEmail, toName string,
	tags []string, fname string, r io.Reader) ([]*SendResponse, error)

func (m *Client) SubAccount() string

type Message ¶

type Message struct {
	Html                    string                      `json:"html,omitempty"`
	Text                    string                      `json:"text,omitempty"`
	Subject                 string                      `json:"subject,omitempty"`
	FromEmail               string                      `json:"from_email,omitempty"`
	FromName                string                      `json:"from_name,omitempty"`
	To                      []*MessageTo                `json:"to,omitempty"`
	Headers                 *MessageHeaders             `json:"headers,omitempty"`
	Important               bool                        `json:"important,omitempty"`
	TrackOpens              bool                        `json:"track_opens,omitempty"`
	TrackClicks             bool                        `json:"track_clicks,omitempty"`
	AutoText                bool                        `json:"auto_text,omitempty"`
	AutoHtml                bool                        `json:"auto_html,omitempty"`
	InlineCss               bool                        `json:"inline_css,omitempty"`
	UrlStripQs              bool                        `json:"url_strip_qs,omitempty"`
	PreserveRecipients      bool                        `json:"preserve_recipients,omitempty"`
	ViewContentLink         bool                        `json:"view_content_link,omitempty"`
	BccAddress              string                      `json:"bcc_address,omitempty"`
	TrackingDomain          string                      `json:"tracking_domain,omitempty"`
	SigningDomain           string                      `json:"signing_domain,omitempty"`
	ReturnPathDomain        string                      `json:"return_path_domain,omitempty"`
	Merge                   bool                        `json:"merge,omitempty"`
	GlobalMergeVars         []*MessageMergeItem         `json:"global_merge_vars,omitempty"`
	MergeVars               []*MessageMergeWrapper      `json:"merge_vars,omitempty"`
	Tags                    []string                    `json:"tags,omitempty"`
	SubAccount              string                      `json:"subaccount,omitempty"`
	GoogleAnalyticsDomains  []string                    `json:"google_analytics_domains,omitempty"`
	GoogleAnalyticsCampaign string                      `json:"google_analytics_campaign,omitempty"`
	MetaData                *MessageMetaData            `json:"metadata,omitempty"`
	RecipientMetaData       []*MessageRecipientMetaData `json:"recipient_metadata,omitempty"`
	Attachments             []*MessageAttachment        `json:"attachments,omitempty"`
	Images                  []*MessageAttachment        `json:"images,omitempty"`
}

*

• Message struct
• ==============
• Html The full HTML content to be sent
• Text Optional full text content to be sent
• Subject The message subject
• FromEmail The sender email address
• FromName Optional from name to be used
• To An array of recipient information
• Headers Optional extra headers to add to the message (most headers are allowed)
• Important Whether or not this message is important, and should be delivered ahead of non-important messages
• TrackOpens Whether or not to turn on open tracking for the message
• TrackClicks Whether or not to turn on click tracking for the message
• AutoText Whether or not to automatically generate a text part for messages that are not given text
• AutoHtml Whether or not to automatically generate an HTML part for messages that are not given HTML
• InlineCss Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size
• UrlStripQs Whether or not to strip the query string from URLs when aggregating tracked URL data
• PreserveRecipients Whether or not to expose all recipients in to "To" header for each email
• ViewContentLink Set to false to remove content logging for sensitive emails
• BccAddress An optional address to receive an exact copy of each recipient's email
• TrackingDomain A custom domain to use for tracking opens and clicks instead of mandrillapp.com
• SigningDomain A custom domain to use for SPF/DKIM signing instead of mandrill (for "via" or "on behalf of" in email clients)
• ReturnPathDomain A custom domain to use for the messages's return-path
• Merge Whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
• GlobalMergeVars Global merge variables to use for all recipients. You can override these per recipient.
• MergeVars Per-recipient merge variables, which override global merge variables with the same name.
• Tags An array of string to tag the message with. Stats are accumulated using tags. (Do not start tag with an underscore, reserved for Manrill internal use)
• SubAccount The unique id of a subaccount for this message - must already exist or will fail with an error
• GoogleAnalyticsDomains An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
• GoogleAnalyticsCampaign Optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead.
• MetaData Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval.
• In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
• RecipientMeteData Per-recipient metadata that will override the global values specified in the metadata parameter.
• Attachments An array of supported attachments to add to the message
• Images An array of embedded images to add to the message

type MessageAttachment ¶

type MessageAttachment struct {
	Type    string `json:"type,omitempty"`
	Name    string `json:"name,omitempty"`
	Content string `json:"content,omitempty"`
}

func AttachmentFromReader(fname string, r io.Reader) (*MessageAttachment, error)

type MessageHeaders ¶

type MessageHeaders struct {
	ReplyTo string `json:"Reply-To,omitempty"`
}

type MessageMergeItem ¶

type MessageMergeItem struct {
	Name    string `json:"name,omitempty"`
	Content string `json:"content,omitempty"`
}

type MessageMergeWrapper ¶

type MessageMergeWrapper struct {
	Recipient string              `json:"rcpt,omitempty"`
	Vars      []*MessageMergeItem `json:"vars,omitempty"`
}

type MessageMetaData ¶

type MessageMetaData struct {
	Website string `json:"website,omitempty"`
}

type MessageRecipientMetaData ¶

type MessageRecipientMetaData struct {
	Recipient string                          `json:"rcpt,omitempty"`
	Values    *MessageRecipientMetaDataValues `json:"values,omitempty"`
}

type MessageRecipientMetaDataValues ¶

type MessageRecipientMetaDataValues struct {
	UserId int `json:"user_id,omitempty"`
}

type MessageTo ¶

type MessageTo struct {
	Email string `json:"email,omitempty"`
	Name  string `json:"name,omitempty"`
	Type  string `json:"type,omitempty"`
}

type SendRequest ¶

type SendRequest struct {
	Key     string   `json:"key,omitempty"`
	Message *Message `json:"message,omitempty"`
	Async   bool     `json:"async,omitempty"`
	IpPool  string   `json:"ip_pool,omitempty"`
	SendAt  string   `json:"send_at,omitempty"`
}

*

• SendRequest struct
• ==============
• Key Api key
• Message The information on the message to send
• Async Enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status
• of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event.
• Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously,
• regardless of the value of async.
• IpPool The name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs,
• this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
• SendAt When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past,
• the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts
• with a positive balance.

type SendResponse ¶

type SendResponse struct {
	Email        string `json:"email,omitempty"`
	Status       string `json:"status,omitempty"`
	Id           string `json:"_id,omitempty"`
	RejectReason string `json:"reject_reason,omitempty"`

	// Used for errors
	Code    int    `json:"code,omitempty"`
	Name    string `json:"name,omitempty"`
	Message string `json:"message,omitempty"`
}