JEMH Usage Guide
Terminology
Term |
Description |
|---|---|
Service Configuration |
The Jira service configuration for the handler, has mandatory definition of the handler parameter configFile=emh.properties, it can be named anything. |
Configuration |
The mandatory configuration file used to currently provide the Email Handler with all its setup information and is expected to be found in atlassian-jira/WEB-INF/classes. |
an entry in the Configuration or the Service parameters not in the email. |
|
an incantation in the email used to trigger a manipulation of an issue |
|
The implementations that are responsible for extracting Directives and their values into a common map for processing. Several implementations are provided in JEMH. See also JEMH Example Configuration and mail content |
|
Hint |
When JEMH runs into questionable data, like Priority:rhubarb, JEMH will email the send with hints saying what went wrong. JEMH will not reject emails for minor problems, as they can usually be fixed after the fact (through further emails even). Hints can be fatal, indicating they are the cause of an emails rejection (its been tested but rejected and may have been deleted, if the deleteMail option is set true). |
additional configuration options specified in the Service Configuration will override whatever is in the Configuration file, CSV with 
valdiated on Linux only Configuration File
Use it
There is too much configuration info to use the service parameters only. It won't work. Setup the config file based on the bundled example, use service params for override values, as discussed in the next section.
Starting with a blank configuration file?
You will most likely forget to add something critical, save yourself and me time by starting with the example and going from there.
The configuration file has a lot of options. I've tried to ensure that its safe to comment out things you don't care about, essentially disabling whole chunks of functionality. Some things are required like default values. Perhaps in time the config file will be replaced with a UI component in Jira.
Every release contains an example_emh.properties file, this file is for information, is updated as required, and should be contrasted at update time to take advantage of new features/tweaks to existing config options (amalgamation/obsolescence).
Bugs?
There are lots of combinations, I test as much as I can. If you find something isn't quite working as documented (or expected) then feel free to raise an issue (see Reporting Problems). The code is free, but my free time is limited. I help where I can but specific problem solving is something I do under contract.
Documentation not up to date?
It happens. Please comment and I'll fix.
Need a feature?
If you need some email integration feature in JEMH, please log in the project issue tracker
Space Map
Table Of Contents