Eventum:Email integration
Contents |
[edit] Overview
Eventum's email integration features allow emails to be sent from and received by Eventum.
Incoming emails are input to the system in one of two ways:
- A cron job (scheduled task) that checks a POP mail account, or a particular folder of an IMAP account
- A email routing interface that is run on-demand by an email system (MTA) such as postfix in response to newly received messages
Outgoing emails are put into a queue, and sent out by a cron job (scheduled task). If the mail server is not available, the emails remain in the queue.
See the installation guide for information on setting up the cron jobs, and Email Routing Interface for information on setting up that feature.
[edit] Incoming mail
Once inside Eventum, incoming email messages can be associated with issues:
- By inspecting the email's headers (for example, if the email is a reply to another email already associated with an issue)
- By inspecting the email's subject line for reference to an issue id in the format [#1234] (optional feature, inactive by default)
- When processed by the Email Routing Interface, by extracting the issue id from the address (ex: issue-234@example.com)
- By auto-creating a new issue if the email cannot be automatically associated with an existing issue using the above methods (optional feature)
- By manually associating the email with an issue from the queue of unassociated emails (assuming the auto-create feature is not active)
Note that the email integration features expect that one email address will be set up for each project. A single email address can be used for multiple projects using the multiple project email workaround.
[edit] Who is automatically assigned an issue? How do I change which user gets a new issue?
Go to Administration -> Manage Email Accounts. Under "Existing Accounts", go to "Auto-Creation of Issues" and click on the "Enabled" link to see options for this e-mail account. Change the user who is auto-assigned new tickets.
[edit] How To Receive Email For Issues That Are Assigned To You
It is simple to receive email for issues which are assigned to you. Go to Preferences for your user account and indicate if you wish to "Receive emails when all issues are created", or "Receive emails when new issues are assigned to you". Each of these options has a radio button for yes or no for each project you have been assigned to, so it is easy to specify the exact kind of email notifications you receive.
In order for the email function to work, the "SMTP (Outgoing Email) Settings" in Administration->General Preference needs to be configured properly. You also need to use a valid email address as your login ID for Eventum.
[edit] Troubleshooting
A common mistake for the email integration is forgetting to set the mail scripts to run. The scripts are:
./crons/download_emails.php(Downloads e-mail to Eventum)./crons/process_mail_queue.php(Sends e-mail from Eventum)
For user on a Unix/Linux system, the timing is generally set using cron. For Windows, use either the Task Scheduler, or find a "cron equivalent" program.
Look in the INSTALL file for information on how to set up the mail scripts.
If you are running under PHP5 on Unix/Linux, you may have a problem getting the process_mail_queue.php script to work. Edit your local configuration file (php.ini) and increase the amount of memory a script may have (memory_limit). The default is 8M. I have increased mine to 32M, though if memory is tight, you may want to experiment to find the minimum that will work. You may also want to increase max_execution_time and max_input_time in the php.ini to allow the scripts enough time on complete. Finally, if only command line script OR web invocation is not working, make sure you are using the same php.ini for both web and command line interface.
The download_emails.php script requires some parameters. Look in the source of that file or run from commandline to see what they are (username, hostname). You must provide these parameters when setting up your cron.
- Notes about Japanese character sets and E-mail integration.
[edit] Email Blocking
To prevent inappropriate emails reaching the notification list, only users that are assigned to the issue are allowed to email through Eventum. If an un-authorized user sends an email to issue-XXXX@example.com it is converted into a note and stored for later use. This note can be converted into an email at a later date.
[edit] Customizing the System Generated Mail Messages
Eventum uses the Smarty Template Engine. See the Online Documentation for Smarty templating syntax.
You should also check out Eventum:Localization:Templates to understand what the {t} {/t} tags are for.
File names are pretty much self-explanatory. Location: ../path_to_eventum/templates/notifications/
- account_details.tpl.text
- assigned.tpl.text
- closed.tpl.text
- files.tpl.text
- new_auto_created_issue.tpl.text
- new_issue.tpl.text
- new.tpl.text
- new_user.tpl.text
- notes.tpl.text
- password_confirmation.tpl.text
- updated_account.tpl.text
- updated_password.tpl.text
- updated.tpl.text
- visitor_account.tpl.text