Connectors Reference

Mandrill

Mandrill is a transactional email API for MailChimp users. It's reliable, powerful, and ideal for sending data driven emails, including targeted e-commerce and personalized one-to-one messages.

 

Status: Production

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

CurrentUser ()

Current user info

SentMessageInfo (string Id)

Recently sent message

SendMessage (SendMessageRequest sendMessageRequest)

Send mail

ScheduledMessageInfo (ListScheduledRequest listScheduledRequest)

List scheduled message

TestConnection ()

Execute TestConnection operation

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AttachmentInfo

 

ClickInfo

 

ListScheduledInfo

 

ListScheduledRequest

 

MessageInfo

 

OpenedDetail

 

RecipientInfo

 

SendMessageInfo

 

SendMessageRequest

 

SendMessageResponse

 

SmtpEventInfo

 

Stats

 

StatStruct

 

TagInfo

 

UserInfo

 

 

Actions:

CurrentUser

Summary: Current user info

Description: Return the information about the API-connected user.

 

Syntax:

Mandrill.CurrentUser ()

 

Returns:

          Type:UserInfo

          Description: the user information including username, key, reputation, quota, and historical sending stats

 

SentMessageInfo

Summary: Recently sent message

Description: Get the information for a single recently sent message.

 

Syntax:

Mandrill.SentMessageInfo (string Id)

 

Parameters:

Name

Type

Summary

Required

Related Action

Id

string

 

 

True

 

Returns:

          Type:MessageInfo

          Description: Information for the message

 

SendMessage

Summary: Send mail

Description: Send a new transactional message through Mandrill.

 

Syntax:

Mandrill.SendMessage (SendMessageRequest sendMessageRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

sendMessageRequest

SendMessageRequest

 

Information for the message for each recipient containing the key "email" with the email address, and details of the message status for that recipient

True

 

Returns:

          Type:array of (SendMessageResponse)

 

ScheduledMessageInfo

Summary: List scheduled message

Description: Queries your scheduled emails.

 

Syntax:

Mandrill.ScheduledMessageInfo (ListScheduledRequest listScheduledRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

listScheduledRequest

ListScheduledRequest

 

Parameters to restrict list of scheduled emails search

True

 

Returns:

          Type:array of (ListScheduledInfo)

 

TestConnection

Summary: Execute TestConnection operation

Description: Execute TestConnection operation.

 

Syntax:

Mandrill.TestConnection ()

 

Returns:

 


 

AttachmentInfo

Summary:

Description: Information for the message

 

          Properties:

Name

Type

Summary

type

string

MIME Type

MIME type of the attachment

name

string

File Name

File name of the attachment

content

string(byte)

Content

Content of the attachment


 

ClickInfo

Summary:

Description: Information on an individual click

 

          Properties:

Name

Type

Summary

ts

integer(int32)

Time Stamp

Unix timestamp from when the message was clicked

url

string

Clicked URL

URL that was clicked on

ip

string

IP Address

IP address that generated the click

location

string

Location

Approximate region and country that the clicking IP is located

ua

string

Opening Browser

Email client of browser data of the click


 

ListScheduledInfo

Summary:

Description: Information about a specific smtp event

 

          Properties:

Name

Type

Summary

email

string

Recipient's Email

Email address of the recipient

status

string

Recipient's Status

Sending status of the recipient - either "sent", "queued", "scheduled", "rejected", or "invalid"  Values: [, sent, queued, scheduled, rejected, or invalid]

reject_reason

string

Rejection Reason

Reason for the rejection if the recipient status is "rejected" - one of "hard-bounce", "soft-bounce", "spam", "unsub", "custom", "invalid-sender", "invalid", "test-mode-limit", "unsigned", or "rule"  Values: [, hard-bounce, soft-bounce, spam, unsub, custom, invalid-sender, invalid, test-mode-limit, unsigned, or rule]

_id

string

Message ID

Message's unique id


 

ListScheduledRequest

Summary:

Description: Parameters to restrict list of scheduled emails search

 

          Properties:

Name

Type

Summary

To

string

To

Optional recipient email address to restrict results to


 

MessageInfo

Summary:

Description: Information for the message

 

          Properties:

Name

Type

Summary

ts

integer(int32)

Time Stamp

Unix timestamp from when this message was sent

_id

string

Message ID

Message's unique id

sender

string

Sender's Email

Email address of the sender

template

string

Template Name

Unique name of the template userd, if any

subject

string

Subject

Message's subject line

email

string

Recipient's Email

Recipient email address

tags

array of (TagInfo)

Tags

List of tags in this message

opens

integer(int32)

Opened

How many times has this message been opened

opens_details

array of (OpenedDetail)

Opened Details

List of individual opens for the message

clicks

string

Clicks

How many times has a link been clicked in this message

clicks_detail

array of (ClickInfo)

Click Details

List of individual clicks for the message

state

string

Sending State

Sending status of this message: sent, bounced, rejected  Values: [, sent, bounced, rejected]

smtp_events

array of (SmtpEventInfo)

SMTP Events

Log of up to 3 smtp events for the message


 

OpenedDetail

Summary:

Description: Information on an individual

 

          Properties:

Name

Type

Summary

ts

string

Time Stamp

Unix timestamp from when the message was opened

ip

string

IP Address

IP address that generated the open

location

string

Location

Approximate region and country that the opening IP is located

ua

string

Opening Browser

Email client of browser data of the open


 

RecipientInfo

Summary:

Description: Single recipient's information

 

          Properties:

Name

Type

Summary

email

string

Email

Email address of the recipient

name

string

Name

Display name of the recipient

type

string

Send As

Send type (to, cc, bcc)  Values: [to, cc, bcc]


 

SendMessageInfo

Summary:

Description: Information on the message to send

 

          Properties:

Name

Type

Summary

html

string

HTML Text

Full HTML content to be sent

text

string

Text content of the message

Full text content to be sent

subject

string

Subject

Message subject

from_email

string

From Email

Sender email address

from_name

string

From Name

Sender email name

to

array of (RecipientInfo)

Send To

Array of recipients

headers

string

Extra headers

Extra headers to add to the message (most headers are allowed)

important

boolean

Is this message Important (true/false)?

Whether or not this message is important, and should be delivered ahead of non-important messages

track_opens

boolean

Track when message opens (true/false)?

Whether or not to turn on open tracking for the message

track_clicks

boolean

Track clicks for this message (true/false)?

Whether or not to turn on click tracking for the message

auto_text

boolean

Fill text message if not present (true/false)?

Whether or not to automatically generate a text part for messages that are not given text

auto_html

boolean

Fill HTML message if not present (true/false)?

Whether or not to automatically generate an HTML part for messages that are not given HTML

inline_css

boolean

Inline CSS Styles in Html message (true/false)?

Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size

url_strip_qs

boolean

Strip query string from URL in aggregated data (true/false)?

Whether or not to strip the query string from URLs when aggregating tracked URL data

preserve_recipients

boolean

Show all recipients in 'To' line (true/false)?

Whether or not to expose all recipients in to "To" header for each email

view_content_link

boolean

Remove content logging (true/false)?

Whether or not to log content. Set to false to remove content logging for sensitive emails

bcc_address

string

Optional BCC address

Optional address to receive an exact copy of each recipient's email

tracking_domain

string

Custom domaing for tracking

Custom domain to use for tracking opens and clicks instead of mandrillapp.com

tags

array of (string)

Tags

Array of strings to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.

attachments

array of (AttachmentInfo)

Attachments

Attachments to add to the message


 

SendMessageRequest

Summary:

Description: Information for the message for each recipient containing the key "email" with the email address, and details of the message status for that recipient

 

          Properties:

Name

Type

Summary

message

SendMessageInfo

 

Information on the message to send

send_at

string

Send At

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.

async

boolean

Enable async (true/false)?

Enable a background sending mode that is optimized for bulk sending

ip_pool

string

Dedicated Ip Pool name

Name of the dedicated ip pool that should be used to send the message


 

SendMessageResponse

Summary:

Description: Information for the message for each recipient containing the key "email" with the email address, and details of the message status for that recipient

 

          Properties:

Name

Type

Summary

email

string

Email

Email address of the recipient

status

string

Sending Status

Sending status of the recipient - either "sent", "queued", "scheduled", "rejected", or "invalid"

reject_reason

string

Reject Reason

Reason for the rejection if the recipient status is "rejected" - one of "hard-bounce", "soft-bounce", "spam", "unsub", "custom", "invalid-sender", "invalid", "test-mode-limit", "unsigned", or "rule

_id

string

Message ID

message's unique id


 

SmtpEventInfo

Summary:

Description: Information about a specific smtp event

 

          Properties:

Name

Type

Summary

ts

integer(int32)

Time Stamp

Unix timestamp when the event occurred

type

string

Message's State

Message's state as a result of this event

diag

string

SMTP Response

SMTP response from the recipient's server


 

Stats

Summary:

Description: aggregate summary of the account's sending stats

 

          Properties:

Name

Type

Summary

today

StatStruct

 

Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time

last_7_days

StatStruct

 

Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time

last_30_days

StatStruct

 

Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time

last_60_days

StatStruct

 

Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time

last_90_days

StatStruct

 

Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time

all_time

StatStruct

 

Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time


 

StatStruct

Summary:

Description: Struct to hold stat information, this struct is shared across stats for today, last_7_days, last_30_days, last_60_days, last_90_days and all_time

 

          Properties:

Name

Type

Summary

sent

integer(int32)

Sent

Number of emails sent for this user

hard_bounces

integer(int32)

Hard Bounces

Number of emails hard bounced for this user

soft_bounces

integer(int32)

Soft Bounces

Number of emails soft bounced for this user

rejects

integer(int32)

Rejects

Number of emails rejected for sending this user

complaints

integer(int32)

Complaints

Number of spam complaints for this user

unsubs

integer(int32)

Unsubscribes

Number of unsubscribes for this user

unique_opens

integer(int32)

Unique Opens

Number of times emails have been opened for this user

clicks

integer(int32)

Clicks

Number of URLS that have been clicked for this user so far today

unique_clicks

integer(int32)

Unique Clicks

Number of unique clicks for emails sent for this user


 

TagInfo

Summary:

Description: Individual tag on a message

 

          Properties:

Name

Type

Summary

tag

string

Tag

Individual tag on a message


 

UserInfo

Summary:

Description: the user information including username, key, reputation, quota, and historical sending stats

 

          Properties:

Name

Type

Summary

username

string

User Name

Username of the user (used for SMTP authentication)

created_at

string

Created at

Date and time that the user's Mandrill account was created as a UTC string in YYYY-MM-DD HH:MM:SS format

public_id

string

Public id

Unique, permanent identifier for this user

reputation

integer(int32)

Reputation

Reputation of the user on a scale from 0 to 100, with 75 generally being a "good" reputation

hourly_quota

integer(int32)

Hourly Quota

Maximum number of emails Mandrill will deliver for this user each hour. Any emails beyond that will be accepted and queued for later delivery. Users with higher reputations will have higher hourly quotas

backlog

integer(int32)

Backlog

Number of emails that are queued for delivery due to exceeding your monthly or hourly quotas

stats

Stats

 

aggregate summary of the account's sending stats