Provides a simple endpoint for Postal to deliver inbound emails to Discourse
You should install the plugin via the current Discourse plugin instructions - https://meta.discourse.org/t/install-a-plugin/19157
You will require a Postal instance, with a configured domain, HTTP endpoint, and routing to the endpoint.
The important bits of the HTTP endpoint settings are:
- encoding: Sent in the body as JSON
- format: Delivered as a hash (not that kind of hash delivery...)
Installing this plugin should be as simple as following the Discourse Plugin installation tutorial
_Note: I didn't setup these tests when I adapted the plugin from the mailgun one, they probably don't work out the box... _
In order to run tests you'll need a Discourse development environment such as the vagrant one.
You can then run the tests with rake plugin:spec[discourse-postal]
Once the plugin is installed, you'll need to configure a few things:
- Postal webhook public key - I can't remember where I had to get this from...
- Discourse Base URL - the URL where your discourse is available
- Discourse API key - you can create one in the discourse admin panel
- Discourse API username
You can do this in the plugin settings page.
You'll also need to enable "manual polling enabled" in your discourse email settings admin panel.
Once that is done, you need to configure Postal your postal routing to forward messages to http://your-discourse-url/postal/incoming
- Atom - The editor used
- Ruby on Rails - Application framework
- Discourse Plugins - Plugin framework for Discourse
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Tiago Macedo - Initial work - Really Really Inc
- Nick Sellen - Adapted mailgun plugin to work for postal - nicksellen.co.uk
See also the list of contributors who participated in this project.
This project is licensed under the Apache 2.0 - see the LICENSE.md file for details