{"id":25209806,"url":"https://github.com/backdrop-contrib/mandrill","last_synced_at":"2025-04-05T05:24:21.085Z","repository":{"id":29365363,"uuid":"32899968","full_name":"backdrop-contrib/mandrill","owner":"backdrop-contrib","description":"Integrates Backdrop's mail system with Mandrill transactional emails, a service by the folks behind MailChimp","archived":false,"fork":false,"pushed_at":"2024-10-29T08:48:56.000Z","size":701,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":33,"default_branch":"1.x-2.x","last_synced_at":"2024-10-29T09:56:58.505Z","etag":null,"topics":["backdropcms","mailchimp","mandrill-api"],"latest_commit_sha":null,"homepage":"https://backdropcms.org/project/mandrill","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/backdrop-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-26T01:05:34.000Z","updated_at":"2024-10-29T08:48:57.000Z","dependencies_parsed_at":"2025-02-10T13:28:40.979Z","dependency_job_id":null,"html_url":"https://github.com/backdrop-contrib/mandrill","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fmandrill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fmandrill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fmandrill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fmandrill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/backdrop-contrib","download_url":"https://codeload.github.com/backdrop-contrib/mandrill/tar.gz/refs/heads/1.x-2.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247290539,"owners_count":20914691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backdropcms","mailchimp","mandrill-api"],"created_at":"2025-02-10T13:18:36.165Z","updated_at":"2025-04-05T05:24:21.077Z","avatar_url":"https://github.com/backdrop-contrib.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mandrill\n\nIntegrates Backdrop's mail system with Mandrill transactional emails, a service\nby the folks behind MailChimp. Learn more about Mandrill and how to sign up at\n[their website](http://mandrill.com). (Or don't, but then this module isn't\nterribly useful...)\n\n## Requirements\n\n- Mailsystem\n\nTwo of the submodules require entity_plus and entity_ui.\n\n## Installation\n\n- Install this module using the official \n  [Backdrop CMS instructions](https://backdropcms.org/guide/modules)\n- You need to have a Mandrill API Key.\n\n## Configuration\n\n### Set Mandrill API Key\nStart by loading up the Mandrill admin page at Configuration -\u003e Web\nServices (or admin/config/services/mandrill) and adding your API key from\nhttp://mandrillapp.com. Then you'll see more configuration options.\n\n### Email Options\n* **From address:** The email address that emails should be sent from\n* **From name:** The name to use for sending (optional)\n* **Subaccount:** This selection box appears if you have configured subaccounts\non your Mandrill account, and can be used to select the outgoing subaccount to\nuse for Mandrill sending.\n* **_Input format_:** An optional input format to apply to the message body\nbefore sending emails\n\n### Send Options\n* **Track opens:** Toggles open tracking for messages\n* **Track clicks:** Toggles click tracking for messages\n* **Strip query string:** Strips the query string from URLs when aggregating\ntracked URL data\n* **Log sends that are not registered in mailsystem:** Useful for configuring\nMail System and getting more granular control over emails coming from various\nmodules. Enable this and set the system default in Mail System to Mandrill,\nthen trigger emails from various modules and functions on your site. You'll\nsee Mandrill writing log messages identifying the modules and keys that are\ntriggering each email. Now you can add these keys in Mail System and control\neach email-generating module/key pair specifically. WARNING: If you leave this\nenabled, you may slow your site significantly and clog your log files. Enable\nonly during configuration.\n\n### Google Analytics\n* **Domains:** One or more domains for which any matching URLs will\nautomatically have Google Analytics parameters appended to their query string.\nSeparate each domain with a comma.\n* **Campaign:** The value to set for the utm_campaign tracking parameter. If\nempty, the from address of the message will be used instead.\n\n### Asynchronous Options\n* **Queue Outgoing Messages** Drops all messages sent through Mandrill into a\nqueue without sending them. When Cron is triggered, a number of queued messages\nare sent equal to the specified Batch Size.\n* **Batch Size** The number of messages to send when Cron triggers. Must be\ngreater than 0.\n\n### Send test mail\n\nThe Send Test Email function is pretty self-explanatory. The To: field will\naccept multiple addresses formatted in any Backdrop mail system approved way.\nBy configuring the Mandrill Test module/key pair in Mail System, you can\nuse this tool to test outgoing mail for any installed mailer.\n\n### Update Mail System settings\nMandrill Mail interface is enabled by using the\n[Mail System module](https://backdropcms.org/project/mailsystem). Go to the\n[Mail System configuration page](admin/config/system/mailsystem) to start\nsending emails through Mandrill. Once you do this, you'll see a list of the\nmodule keys that are using Mandrill listed near the top of the Mandrill\nsettings page.\n\nOnce you set the site-wide default (and any other module classes that may be\nlisted) to MandrillMailSystem, your site will immediately start using Mandrill\nto deliver all outgoing email.\n\n### Module/key pairs\nThe key is optional: not every module or email uses a key. That is why on the\nmail system settings page, you may see some modules listed without keys. For\nmore details about this, see the help text on the mail system configuration\npage.\n\n## Sub-modules\n\n### Templates\n\nIn order to use the mandrill_template module, start by creating some templates\nin your Mandrill account. Once you do, you can add one or more Mandrill\nTemplate Maps for that template, specifying where in the template to place\nthe email content and which module/key pair should be sent using the template.\nIf you want to send multiple module/key pairs through the same Template, you\ncan make Mandrill the default mail system and make that Template Map the\ndefault template, or you can clone the Template Map for each module/key pair\nand assign them individually.\n\nTo send values from Backdrop to Mandrill that will be used to substitute the\ntemplate regions you should implement hook_mail_alter() and add your values in\nthe 'mandrill_template_content' key in the $message array as an array with two\nkeys: name and content.\n\nFor example, for sending the value 'foo value' for the region 'foo' you\ncan use this code:\n\n```php\n/**\n * Implements hook_mail_alter();\n */\nfunction mymodule_mail_alter(\u0026$message) {\n  $message['mandrill_template_content'][] = array(\n    'name' =\u003e 'foo',\n    'content' =\u003e 'foo value',\n  );\n}\n```\n\nYou should also consider enabling the css-inline feature in your Mandrill\naccount under Settings -\u003e Sending Options. For more info, see\n\"http://help.mandrill.com/entries/24460141-Does-Mandrill-inline-CSS-automatically-\".\n\n### Reports\nThe mandrill_reports sub-module provides reports on various metrics. It may\ntake a long time to load. This module is due for some attention.\n\n#### Dashboard\nDisplays charts that show volume and engagement, along with a tabular list of\nURL interactions for the past 30 days.\n\n#### Account Summary\nShows account information, quotas, and all-time usage stats.\n\n### Activity\nThe Mandrill Activity sub-modules allows users to view email activity for any\nBackdrop entity with a valid email address. Configuration and usage details are in\nsub-module's README file.\n\n### Advanced Options\nIf you would like to use additional template (or other) Mandrill API\nvariables not implemented in this module, set them in hook_mail_alter under:\n$params['mandrill']. Have a look at mandrill.mail.inc to learn more.\n(Search for \"mandrill parameters\".)\n\n## Issues\n\nBugs and Feature requests should be reported in the\n[Issue Queue](https://github.com/backdrop-contrib/mandrill/issues)\n\n## Current Maintainers\n\n- [Indigoxela](https://github.com/indigoxela)\n- Seeking additional maintainers\n\n## Credits\n\nThis module is based on the Mandrill module for Drupal, originally written and\nmaintained by a large number of contributors, including:\n\n- levelos https://www.drupal.org/u/levelos\n- ruscoe https://www.drupal.org/u/ruscoe\n- gcb https://www.drupal.org/u/gcb\n\n## License\n\nThis project is GPL v2 software. See the [LICENSE.txt](https://github.com/backdrop-contrib/i18n/blob/1.x-1.x/LICENSE.txt) \nfile in this directory for complete text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackdrop-contrib%2Fmandrill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackdrop-contrib%2Fmandrill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackdrop-contrib%2Fmandrill/lists"}