Phabricator SparkPost

Phabricator Sparkpost is a mail adapter for Phabricator and enables the usage of SparkPost for sending outbound email.

Note

The Phabricator upstream does officially not offer support with extension development. This means that upgrading your Phabricator instance while running this library can cause trouble because of upstream API changes. Always test your Phabricator instance after upgrading while using this library to ensure it still works like a new Tesla. If it does not work as expected, please open a new issue.

Installation

Installation of Phabricator SparkPost is fairly easy because it is build as a libphutil library.

1. git clone Phabricator SparkPost next to your arcanist, libphutil and phabricator folders.

   root@box:/$ ls -l
   drwxr-xr-x  8 root root 4096 May 17 18:20 arcanist
   drwxr-xr-x  9 root root 4096 May 17 18:20 libphutil
   drwxr-xr-x 11 root root 4096 May 18 06:05 phabricator
   root@box:/$ git clone https://github.com/hiddeco/phabricator-sparkpost.git

2. Link phabricator-sparkpost with your Phabricator instance. You do this by adding phabricator-sparkpost to your load-libraries config key. E.g.

   root@box:phabricator/$ ./bin/config set load-libraries '{"phabricator-sparkpost": "phabricator-sparkpost\/src\/"}'

3. Set your sparkpost.api-key. Note: this API key needs Transmissions: Read/Write permissions.

   root@box:phabricator/$ ./bin/config set sparkpost.api-key <key>

4. Configure Phabricator to use PhabricatorMailImplementationSparkPostAdapter as the mail adapter by setting metamta.mail-adapter

   root@box:phabricator/$ ./bin/config set metamta.mail-adapter PhabricatorMailImplementationSparkPostAdapter

5. Test sending email.

   root@box:phabricator/$ ./bin/mail send-test

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email hello@hidde.co instead of using the issue tracker.

Credits

• Hidde Beydals
• All Contributors

License

Licensed under the Apache License, Version 2.0. Please see License for more information.