MandrillClient
Begins an export of your activity history.
Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
- the export activity
information about the activity export job that was started
Returns information about an export job.
Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
- the export type
the information about the export
Returns a list of your exports.
Returns a list of your exports.
- the key of the account to use
the account's exports
Begins an export of your rejection blacklist.
Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
- the export job
information about the rejects export job that was started
Begins an export of your rejection whitelist.
Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
- the export job
information about the whitelist export job that was started
Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
- raw MIME document
an array of the information for each recipient in the message (usually one) that matched an inbound route
Add an inbound domain to your account
Add an inbound domain to your account
- the domain to add
information about the domain
Add a new mailbox route to an inbound domain
Add a new mailbox route to an inbound domain
- the domain
the added mailbox route information
Check the MX settings for an inbound domain.
Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
- the domain to check
information about the inbound domain
Delete an inbound domain from the account.
Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
- the domain to delete
information about the inbound domain
Delete an existing inbound mailbox route
Delete an existing inbound mailbox route
- the route to delete
the deleted mailbox route information
List the domains that have been configured for inbound delivery
List the domains that have been configured for inbound delivery
- the key of the account to use
the inbound domains associated with the account
List the mailbox routes defined for an inbound domain
List the mailbox routes defined for an inbound domain
- the domain
the routes associated with the domain
Update the pattern or webhook of an existing inbound mailbox route.
Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
- the route to update
the updated mailbox route information
Cancels the warmup process for a dedicated IP.
Cancels the warmup process for a dedicated IP.
- the isp
Information about the dedicated IP
Creates a pool and returns it.
Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
- the pool
Information about the dedicated ip pool
Deletes a dedicated IP.
Deletes a dedicated IP. This is permanent and cannot be undone.
- the ip
a description of the ip that was removed from your account.
Deletes a pool.
Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
- the pool
information about the status of the pool that was deleted
Retrieves information about a single dedicated ip.
Retrieves information about a single dedicated ip.
- the isp
Information about the dedicated ip
Lists your dedicated IPs.
Lists your dedicated IPs.
- the key of the account to use
an array of structs for each dedicated IP
Lists your dedicated IP pools.
Lists your dedicated IP pools.
- the key of the account to use
the dedicated IP pools for your account, up to a maximum of 1,000
Describes a single dedicated IP pool.
Describes a single dedicated IP pool.
- the ip pool
Information about the dedicated ip pool
Requests an additional dedicated IP for your account.
Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
- the isp
a description of the provisioning request that was created
Configures the custom DNS name for a dedicated IP.
Configures the custom DNS name for a dedicated IP.
- custom dns
information about the dedicated IP's new configuration
Moves a dedicated IP to a different pool.
Moves a dedicated IP to a different pool.
- the isp
Information about the updated state of the dedicated IP
Begins the warmup process for a dedicated IP.
Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
- the isp
Information about the dedicated IP
Cancels a scheduled email
Cancels a scheduled email
- the scheduled mail
information about the scheduled email that was cancelled.
Get the full content of a recently sent message
Get the full content of a recently sent message
- the message info (containing unique id)
the content of the message
Get the information for a single recently sent message
Get the information for a single recently sent message
- the message info (containing unique id)
the information for the message
Queries your scheduled emails by sender or recipient, or both.
Queries your scheduled emails by sender or recipient, or both.
- the recipient address to restrict results to
a list of up to 1000 scheduled emails
Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
- the full MIME document of an email message
the parsed message
Reschedules a scheduled email.
Reschedules a scheduled email.
- the mail to reschedule
information about the scheduled email that was rescheduled.
Search the content of recently sent messages and optionally narrow by date range, tags and senders.
Search the content of recently sent messages and optionally narrow by date range, tags and senders. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.
- the search values
an array of information for a single matching message
Search the content of recently sent messages and return the aggregated hourly stats for matching messages
Search the content of recently sent messages and return the aggregated hourly stats for matching messages
- the search values
the history information
Send a new transactional message through Mandrill
Send a new transactional message through Mandrill
- the message to send
- an of structs for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", or "rejected"
Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
- the full MIME document of an email message
an array for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", or "rejected"
Send a new transactional message through Mandrill using a template
Send a new transactional message through Mandrill using a template
- the message to send
- an of structs for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", or "rejected"
Add a new custom metadata field to be indexed for the account.
Add a new custom metadata field to be indexed for the account.
- the metadata to add
the information saved about the new metadata field
Delete an existing custom metadata field.
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
- the metadata to delete
the information for the deleted metadata field
Get the list of custom metadata fields indexed for the account.
Get the list of custom metadata fields indexed for the account.
- the key of the account to use
the custom metadata fields for the account
Update an existing custom metadata field.
Update an existing custom metadata field.
- the metadata to update
the information for the updated metadata field
Adds an email to your email rejection blacklist.
Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
- info about the mail to blacklist
an object containing the address and the result of the operation
Deletes an email rejection.
Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
- the mail to delete from the blacklist
- an object containing the address and whether the deletion succeeded.
Retrieves your email rejection blacklist.
Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
- information about the list of mails to retrieve
up to 1000 results
Adds a sender domain to your account.
Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
- the domain to add
information about the domain
Checks the SPF and DKIM settings for a domain.
Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
- the domain to add
information about the domain
Returns the sender domains that have been added to this account.
Returns the sender domains that have been added to this account.
- the key of the account to use
the sender domains that have been added to this account.
Return more detailed information about a single sender, including aggregates of recent stats
Return more detailed information about a single sender, including aggregates of recent stats
- the email address of the sender
the detailed information on the sender
Return the senders that have tried to use this account.
Return the senders that have tried to use this account.
- the key of the account to use
the senders that have tried to use this account.
Return the recent history (hourly stats for the last 30 days) for a sender
Return the recent history (hourly stats for the last 30 days) for a sender
- the email address of the sender
the array of history information
Sends a verification email in order to verify ownership of a domain.
Sends a verification email in order to verify ownership of a domain. Domain verification is an optional step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
- the verification email to send
information about the verification that was sent
Asks all the underlying actors to close (waiting for 1 second) and then shut down the system.
Asks all the underlying actors to close (waiting for 1 second) and then shut down the system. Because the blocking client is basically a wrapper of the async one, bot the async and blocking client are supposed to call this method when they are not required or the application using them exit.
Add a new subaccount
Add a new subaccount
- the subaccount to add
the information saved about the new subaccount
Delete an existing subaccount.
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
- the subaccount to delete
the information for the deleted subaccount
Given the ID of an existing subaccount, return the data about it
Given the ID of an existing subaccount, return the data about it
- the existing subaccount
the information about the subaccount
Get the list of subaccounts defined for the account, optionally filtered by a prefix
Get the list of subaccounts defined for the account, optionally filtered by a prefix
- the prefix
the subaccounts for the account, up to a maximum of 1,000
Pause a subaccount's sending.
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
- the subaccount to pause
the information for the paused subaccount
Resume a paused subaccount's sending
Resume a paused subaccount's sending
- the subaccount to resume
the information for the resumed subaccount
Update an existing subaccount
Update an existing subaccount
- the existing subaccount to update
the information for the updated subaccount
Return the recent history (hourly stats for the last 30 days) for all tags
Return the recent history (hourly stats for the last 30 days) for all tags
- the key of the account to use
the recent history (hourly stats for the last 30 days) for all tags
Deletes a tag permanently.
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
- the existing tag info
the tag that was deleted
Return more detailed information about a single tag, including aggregates of recent stats
Return more detailed information about a single tag, including aggregates of recent stats
- the existing tag info
the tag asked
Return all of the user-defined key information
Return all of the user-defined key information
- the key of the account to use
all of the user-defined key information
Return the recent history (hourly stats for the last 30 days) for a tag
Return the recent history (hourly stats for the last 30 days) for a tag
- the existing tag info
the recent history (hourly stats for the last 30 days) for a tag
Add a new template
Add a new template
- the template
the information saved about the new template
Delete a template
Delete a template
- the template
the template that was deleted
Get the information for an existing template
Get the information for an existing template
- the template
the requested template information
Return a list of all the templates available to this user
Return a list of all the templates available to this user
- the template
an array of objects with information about each template
Publish the content for the template.
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
- the template
the template that was published
Inject content and optionally merge fields into a template, returning the HTML that results
Inject content and optionally merge fields into a template, returning the HTML that results
- the template
the result of rendering the given template with the content and merge field values injected
Return the recent history (hourly stats for the last 30 days) for a template
Return the recent history (hourly stats for the last 30 days) for a template
- the template
an array of history information
Update the code for an existing template.
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged
- the template
the template that was updated
Add a tracking domain to your account
Add a tracking domain to your account
- a domain
information about the domain
Checks the CNAME settings for a tracking domain.
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
- an existing tracking domain name
information about the tracking domain
Get the 100 most clicked URLs
Get the 100 most clicked URLs
- the key of the account to use
the 100 most clicked URLs
Return the 100 most clicked URLs that match the search query given
Return the 100 most clicked URLs that match the search query given
- a search query
the 100 most clicked URLs that match the search query given
Return the recent history (hourly stats for the last 30 days) for a url
Return the recent history (hourly stats for the last 30 days) for a url
- a search query
the recent history (hourly stats for the last 30 days) for a url
Get the list of tracking domains set up for this account
Get the list of tracking domains set up for this account
- the key of the account to use
the list of tracking domains set up for this account
Return the information about the API-connected user
Return the information about the API-connected user
- the key of the account to use
the information about the API-connected user
Validate an API key and respond to a ping
Validate an API key and respond to a ping
- the key of the account to use
- the string "PONG!" if successful
Validate an API key and respond to a ping (anal JSON parser version)
Validate an API key and respond to a ping (anal JSON parser version)
- the key of the account to use
- the string "PONG!" if successful
Return the senders that have tried to use this account, both verified and unverified
Return the senders that have tried to use this account, both verified and unverified
- the key of the account to use
the senders that have tried to use this account, both verified and unverified
Add a new webhook
Add a new webhook
the information saved about the new webhook
Delete an existing webhook
Delete an existing webhook
- the webhook to delete
the information saved about the new webhook
Given the ID of an existing webhook, return the data about it
Given the ID of an existing webhook, return the data about it
- the existing webhook
the information saved about the new webhook
Get the list of all webhooks defined on the account
Get the list of all webhooks defined on the account
- the key of the account to use
the webhooks associated with the account
Update an existing webhook
Update an existing webhook
- the existing webhook to update
the information saved about the new webhook
Adds an email to your email rejection whitelist.
Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
- the mail to be added to the whitelist
an object containing the address and the result of the operation
Removes an email address from the whitelist.
Removes an email address from the whitelist.
- the mail to be removed from the whitelist
a status object containing the address and whether the deletion succeeded
Retrieves your email rejection whitelist.
Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results.
- the list of mails to be returned
up to 1000 results
An enumeration of the endpoints for Mandrill API
An enumeration of the endpoints for Mandrill API
https://mandrillapp.com/api/docs/
Trait to define the operations that are allowed by either the Blocking or Async client. Note that each operation return either a Future (in case of the async client) or a Try (in case of the blocking client). It also contains the list of endpoints of the Mandrill API.