You are here

Home » API reference » Mandrill 6

README.txt in Mandrill 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
Integration with Mandrill transactional emails, a service by the folks behind
MailChimp. Learn more about Mandrill and how to sign up on [their website](http://mandrill.com).

## Settings

### Mandrill Mail interface status
#### On
Routes all site emails through the STS API.

#### Test
Enables an alternate mail interface, TestingMailChimpMandrillMailSystem, that
displays a message and logs the event without sending any emails.

#### Off
Disables Mandrill and routes all email through the site's server.

### Email Options
* **Email from address:** The email address that emails should be sent from
* **From name:** The name to use for sending
* **_Input format_:** An optional input format to apply to the message body before sending emails

### Send Options
* **Track opens:** Toggles open tracking for messages
* **Track clicks:** Toggles click tracking for messages
* **Strip query string:** Strips the query string from URLs when aggregating tracked URL data

### Google Analytics
* **Domains:** One or more domains for which any matching URLs will
automatically have Google Analytics parameters appended to their query string.
Separate each domain with a comma.
* **Campaign:** The value to set for the utm_campaign tracking parameter. If
empty, the from address of the message will be used instead.

## Reports sub-module has not been ported to 6.x-1.x

### Dashboard
Displays charts that show volume and engagement, along with a tabular list of
URL interactions for the past 30 days.

### Account Summary
Shows account information, quotas, and all-time usage stats.

File

README.txt
View source 
  1. Integration with Mandrill transactional emails, a service by the folks behind

  2. MailChimp. Learn more about Mandrill and how to sign up on [their website](http://mandrill.com).

  3. 

  4. ## Settings

  5. 

  6. ### Mandrill Mail interface status

  7. #### On

  8. Routes all site emails through the STS API.

  9. 

  10. #### Test

  11. Enables an alternate mail interface, TestingMailChimpMandrillMailSystem, that

  12. displays a message and logs the event without sending any emails.

  13. 

  14. #### Off

  15. Disables Mandrill and routes all email through the site's server.

  16. 

  17. ### Email Options

  18. * **Email from address:** The email address that emails should be sent from

  19. * **From name:** The name to use for sending

  20. * **_Input format_:** An optional input format to apply to the message body before sending emails

  21. 

  22. ### Send Options

  23. * **Track opens:** Toggles open tracking for messages

  24. * **Track clicks:** Toggles click tracking for messages

  25. * **Strip query string:** Strips the query string from URLs when aggregating tracked URL data

  26. 

  27. ### Google Analytics

  28. * **Domains:** One or more domains for which any matching URLs will

  29. automatically have Google Analytics parameters appended to their query string.

  30. Separate each domain with a comma.

  31. * **Campaign:** The value to set for the utm_campaign tracking parameter. If

  32. empty, the from address of the message will be used instead.

  33. 

  34. ## Reports sub-module has not been ported to 6.x-1.x

  35. 

  36. ### Dashboard

  37. Displays charts that show volume and engagement, along with a tabular list of

  38. URL interactions for the past 30 days.

  39. 

  40. ### Account Summary

  41. Shows account information, quotas, and all-time usage stats.