| Name | Email This Issue |
|---|---|
| Vendor | META-INF (website) |
| Version | 1.3 |
| Product Versions | 3.12+ |
| Author(s) | Tibor Hegyi |
| Homepage | http://confluence.atlassian.com/display/JIRAEXT/Email+This+Issue |
| Price | Free |
| License | BSD |
| IssueTracking | http://developer.atlassian.com/jira/browse/JETI |
| Download JAR | email-this-issue-plugin-1.3.jar Java 1.4 compatible version: email-this-issue-plugin-jdk1.4-1.3.jar |
| Download Source | http://svn.atlassian.com/svn/public/contrib/jira/email-this-issue/trunk |
Description/Features
Email an issue from JIRA to arbitrary recipients
This plugin addresses this feature request fulfilling considerable amount (currently 30) of user votes.
The plugin contains an issue operation component that allows users to compose an email and send the issue to arbitrary recipients.
Most important features are:
- send email with issue details to email addresses outside JIRA, assignee, reporter and watchers.
- attach issue attachments to email
- control who can invoke the operation through a project role
- text and html email format are supported, email body understands Confluence wiki markup
- email template can be customized per project and issue type
- a comment is created reflecting the event of sending an email (body, recipients, etc) - see below
- i18n-enabled, the plugin can be translated, it is currently available in English, German and Hungarian.
- you have options like "CC to me" and "Reply to me" to receive a copy of the email or to receive replies to the email.
- email options may be reused, i.e. there is no need to check all your options every time you send an email
Compose email
You can look up recipients using the JIRA User Picker or enter arbitrary email addresses as comma-separated values.
Furthermore, you can specify if you want to send emails to the Assignee, the Reporter or the Watchers. Copy recipients (CC) can also be defined.
You can add your email subject and email body. The latter can use wiki-markup. You have the preview functionality to check how the email will look like.
If the Issue has attachments, you can select those you want to attach to the email.
Email Format
The content and format of the emails can be defined using velocity template files. The default (bundled) template contains the most important issue attributes, such as Key, Type, Summary, Status, Resolution, Priority, Assignee, Reporter, Description.
HTML and plain text emails are supported.
Besides the default templates (email-this-issue.vm), you can add project and/or issue type specific variations easily.
Simply name them as "email-this-issue.<project key>.<issue type id>.vm". Both <project key> and <issue type id> are optional.
E.g. "email-this-issue.SITE.vm" will be used for all issues in the SITE project, similarly, "email-this-issue.SITE.1.vm" will be used for all Bugs in SITE project.
The template name resolution is as follows:
- locate "email-this-issue.<project key>.<issue type id>.vm"
- if not found, locate "email-this-issue.<issue type id>.vm"
- if not found, locate "email-this-issue.<project key>.vm"
- if not found, use "email-this-issue.vm"
Create Comment
Comments are added to the issue if the user sends the email. The comment includes recipients' email address, email subject, list of attachments and the email body.
Comments are created using Velocity templates. There is a template for text based comments (templates/emailissue/comment/text/email-this-issue-comment.vm) and one for wiki markup comments (templates/emailissue/comment/wiki/email-this-issue-comment.vm) bundled in the plugin jar. You can easily customize them to create a format you like.
Security
The operation will be displayed for all issues in all projects, unless you specify a Project Role with the name IssueMailSender and assign users to it in your projects.
If a project role with this name is used in your project and the current user is member of this role, then the operation will be displayed, otherwise not. If you don't define members of this role in a project, the operation is displayed always for issues of this project.
Translation
All UI label are defined in resource bundles (properties files) with the name: com.metainf.jira.plugin.emailissue.i18n.emailIssue, you can add variations for your locale.
Languages currently supported: English, German and Hungarian
Remember Settings
There is a new checkbox on the email form: Remember Settings. If it is checked, settings of "Send to", "Copy to", email format, "Reply to me" are saved to a cookie.
The saved values serve as default values next time you open the email form again. Unchecking "Remember settings" will delete the cookie.
Installation
- Download the jar file and copy it to $JIRA_HOME/atlassian-jira/WEB-INF/lib
- Extract the below template files from the JAR:
- <plugin jar>/templates/emailissue/email/html/email-this-issue.vm, copy it to $JIRA_HOME/atlassian-jira/WEB-INF/classes/templates/email/html
- <plugin jar>/templates/emailissue/email/text/email-this-issue.vm, copy it to $JIRA_HOME/atlassian-jira/WEB-INF/classes/templates/email/text
Add your template variations also to under JIRA, next to the files you have just copied.
Usage
Once successfully installed and if you are authorized, the operation link is displayed. Clicking the link will lead you to the screen where you can compose the email.
Here you can click the Send or Cancel buttons.
Issues
Atlassian Developer Network JIRA
(6 issues)
|
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| T | Key | Summary | Assignee | Reporter | Pr | Status | Res | Created | Updated | Due |
|
JETI-6 | Changing the format of the comment generated by a JETI operation | Tibor Hegyi | Patrick Gover |
|
 Closed
|
FIXED | Jun 04, 2008 | Jun 25, 2008 | |
|
JETI-5 | German translation | Tibor Hegyi | Manuel Küblböck |
|
Closed
|
FIXED | Apr 28, 2008 | Jun 05, 2008 | |
|
JETI-4 | Problem installing JETI | Tibor Hegyi | Jay Compton |
|
Closed
|
FIXED | Apr 27, 2008 | Apr 30, 2008 | |
|
|
JETI-3 | Sending mail causes dump | Tibor Hegyi | Allen Worthington |
|
Closed
|
WON'T FIX | Mar 28, 2008 | Jun 05, 2008 | |
|
JETI-2 | Add comment to Issue when sending email | Tibor Hegyi | Tibor Hegyi |
|
Closed
|
FIXED | Feb 20, 2008 | Jun 05, 2008 | |
|
JETI-1 | Base plugin source on Maven 2 Archetypes | Tibor Hegyi | Tibor Hegyi |
|
Closed
|
FIXED | Feb 20, 2008 | Jun 05, 2008 | |
Examples
Version History
| Plugin Version | Tested against JIRA Enterprise Version |
|---|---|
| 1.3.x | 3.11.x and above |
| 1.2.x | 3.11.x and above |
| 1.1.x | 3.11.x and above |
| 1.0.x | 3.11.x and above |
Open Issues
Screenshots
|
Screenshots (view as slideshow) |
||||||
|---|---|---|---|---|---|---|
|
|
|
||||
| Email This Issue Operation Link | Example of the bundled HTML email template | Example of the bundled TEXT email template | ||||
|
||||||
| Email Editor Form with new features | ||||||
Comments (66)
Jan 29
Yoav Shapira says:
Tibor, thank you for writing and sharing this great plugin! I just installed th...Tibor, thank you for writing and sharing this great plugin!
I just installed the Email This Issue plugin on JIRA (Enterprise 3.12.1), and it's not working. The installation was fine, and the "Email This Issue" item shows up on the left-hand side of all issues. Clicking on it works OK, filling out the form works OK, but the emails don't get sent. There is one error in the logs (catalina.out) for every time I try to send a message:
2008-01-29 22:06:53,206 http-8888-Processor25 ERROR [velocity] Left side ($action.emailIssueFormat) of '==' operation has null value. If a reference, it may not be in the context. Operation not possible. templates/emailissue/operation/input.vm [line 213, column 172]
In addition, there is one warning message on startup:
2008-01-29 22:06:49,132 http-8888-Processor25 WARN [plugin.emailissue.operation.EmailIssueOperation] ProjectRole with name 'IssueMailSender' not found.
This message is true, I haven't this role or any users with it. I think this should be an INFO notice, not a warning, if it's logged at all. I think most people would not bother to define the IssueMailSender role.
Jan 30
Tibor Hegyi says:
Hi Yoav, Thank you for your feedback. You are right in both points, there was a...Hi Yoav,
Thank you for your feedback. You are right in both points, there was a bug in the velocity template that I have fixed. And the logging severity was too high for the role.
On the other hand, neither of the above affects sending the email.
Please make sure the following:
1. You have copied the email templates from the JAR to the proper location under WEB-INF/classes/template/email.
2. You have an SMTP server configured in JIRA
3. You see log output something like:
Let me know,
Tibor
Jan 30
Yoav Shapira says:
Thank you Tibor. I believe I did a proper installation, and I have an SMTP serve...Thank you Tibor. I believe I did a proper installation, and I have an SMTP server configured in JIRA. Other JIRA email notifications are going out just fine, no problem.
I do not see the two INFO statements in the log at all, no matter how many times or variations I try with the Email This Issue plugin ;(
Jan 31
Tibor Hegyi says:
Hi Yoav, I have fixed the bug in the email editor form template and lowered the...Hi Yoav,
I have fixed the bug in the email editor form template and lowered the log level to INFO of the log that reports the lack of the role (that is anyway optional to have). Simply replace the 1.0 jar with the newly uploaded 1.0.1 jar in WEB-INF/lib. Email templates have not changed, so there is nothing else to do.
Please get to JIRA Administration and change the log level of package "com.atlassian" to INFO in order to see the log output I referred to above.
Do you test the plugin with an email address typed in manually or do you check the Reporter/Assignee/Watchers checkboxes?
I attached a screenshot showing the layout of the bundled HTML email template.
Please let me know what log you see,
Tibor
Jan 31
John Smith says:
Hi Tibor, Great plugin\! I have 2 questions though: 1) How can force only text e...Hi Tibor,
Great plugin! I have 2 questions though:
1) How can force only text emails - do I just leave out copying /html/email-this-issue.vm?
2) I have noticed that searching for contacts as a regular user does not work (i.e. I get the login pop-up window if I click on the contact icon).
Searching contacts when logged on as admin is no problem (i.e. I get the normal user drop down list as I start typing names)
Jan 31
Tibor Hegyi says:
Hi John, Thanks for the feedback. Both are very good points. 1) HTML format ...Hi John,
Thanks for the feedback. Both are very good points.
1) HTML format is the default one. At the moment you cannot force email format. How would you prefer to do that? Configuration or shall I make the default format preselected according to the current user's preference in JIRA?
2) It is a reproducible bug, I'm attempting to fix.
The plugin is going to have its JIRA project where all issues can be created and tracked.
Cheers,
Tibor
Jan 31
John Smith says:
Tibor, Default format preselected according to the current user's preference in ...Tibor,
Default format preselected according to the current user's preference in JIRA would be the way to go, as that makes it
consistent with all emails being sent out from Jira. The user will always have the option to send as html (or text) from the email
form using the radio buttons anyway.
John
Jan 31
Tibor Hegyi says:
John, Concerning 2) the following can be done by you. JIRA has a Global Permiss...John,
Concerning 2) the following can be done by you. JIRA has a Global Permission called Browse Users.
Your JIRA user must be assigned this Permission in order to use the user pickers. Both the popup and the autocomplete versions. This means, the user pickers may not only work for admins but for any jira users if you want.
Of course, this is just a workaround. I'll remove the user picker icon if the user does not have this permission.
Tibor
Jan 31
Tibor Hegyi says:
Uploaded new version that hides the user picker icon if current user does not ha...Uploaded new version that hides the user picker icon if current user does not have Browse User permission.
Tibor
Feb 13
Robert Jahrling says:
When I click the Cancel button, I get the following error: "At least one Recipie...When I click the Cancel button, I get the following error: "At least one Recipient or Copy Recipient must be defined."
When I define a Recipient and click Cancel again, the email is generated anyway.
Robert
Feb 13
Tibor Hegyi says:
Thank you, Robert! I'm fixing it very soon. TiborThank you, Robert!
I'm fixing it very soon.
Tibor
Feb 16
Tibor Hegyi says:
Hi Robert, The version linked above contains it the fix. Thanks again for repor...Hi Robert,
The version linked above contains it the fix.
Thanks again for reporting the problem.
Tibor
Feb 22
Robert Jahrling says:
Thanks, Tibor\!Thanks, Tibor!
Feb 17
Support Services says:
Hi Tibor,...Hi Tibor,
First of all thanks for the plugin
I have just installed this in our test environment and have noticed that the user search icons don't display and the search functionality does not work (I get a "Page cannot be found" pop-up)
I am trying this as a user who has the browse users global permission.
However, if I start typing the name of a user it successfully detects the user for me in the To: and CC: fields.
Also, the preview icon doesn't initially display, though the functionality works and the icon appears after you click it.
The email itself works fine.
The only thing I can think of if that our test environment is not installed in the default JIRA directory (our live and test environment are on the same server, with our live environment being installed into the default directory)
Is it possible that your plugin is looking into the default installation directory for the user search icons (and initially the preview icon) and functionality?
I cannot install the plugin in our live environment to see if it works there (company policy unfortunately)
Please let me know if you need further information (hopefully there's a simple solution)
Jason
Feb 18
Tibor Hegyi says:
Hi Jason, You were correct with your assumption. It was my fault. I'll fix it ...Hi Jason,
You were correct with your assumption. It was my fault.
I'll fix it soon.
Thank you for reporting it.
Tibor
Feb 19
Tibor Hegyi says:
Hi Jason, Version 1.0.2 (linked above) fixes the issue you reported. Cheers, ...Hi Jason,
Version 1.0.2 (linked above) fixes the issue you reported.
Cheers,
Tibor
Feb 19
Support Services says:
Hi Tibor, Excellent work, thanks for the quick fix. Everything appears to be wor...Hi Tibor,
Excellent work, thanks for the quick fix. Everything appears to be working fine now, so far the testers are happy
Jason
Feb 19
Yoav Shapira says:
Tibor, version 1.0.2 works very well! No errors in the log, emails go out. Both ...Tibor, version 1.0.2 works very well! No errors in the log, emails go out. Both the user picker and just typing in email address works nicely!
We would love to have the JIRA issue updated with a comment when you send an email about that issue. The comment would just say "Email sent to (addresses) on (date sent) with content: (email body)" and that's it.
Is that hard / complicated to do? Do you plan to do it for this plugin? If not, how would one go about doing it? I can program in Java, I don't mind helping out with this implementation.
Feb 20
Tibor Hegyi says:
Hi Yoav, Thanks for the feedback....Hi Yoav,
Thanks for the feedback.
It was my original intention too to add a comment to the issue (as you see above in the features section) but I just skipped it because I was not sure if anybody would be interested in it (just as with the optional Project Role based authorization feature).
But now, there is one demand for this which justifies my idea
Although, I don't think it would be difficult to implement this, I'm going to publish the sources once I added the dependencies to the maven project.xml (currently it is extending the parent file in Jira Development Kit 3.11) and you'll be welcome to share your time and efforts.
I also wanted to base the source on the Maven 2 architecture (as described in How to Build an Atlassian Plugin) but Atlassian's maven repository seems to be corrupted. I could not create a a JIRA plugin archetype...
Do you have any experience with the new methods to build Maven 2 based JIRA plugins?
So keep an eye on this page and you'll see when the source is published.
Cheers,
Tibor
Feb 20
Yoav Shapira says:
That's great, thank you Tibor.That's great, thank you Tibor.
Feb 20
Rainer Bugow says:
Hi Tibor, thank you for providing this great plugin it works fine (Jira 3.12.1)....Hi Tibor,
thank you for providing this great plugin - it works fine (Jira 3.12.1). It would be really helpful if you could implement the issue update as described by Yoav. This would enable us to perform and track e-mail communication related to customer support issues within Jira. (esp. in combination with Jira's powerful mail handlers). Project Role based authorization is also necessary for us as we are using Jira as an enterprise wide application.
Rainer
Feb 21
Tibor Hegyi says:
Hi Rainer, Thanks for your feedback and justification for the idea of Role Base...Hi Rainer,
Thanks for your feedback and justification for the idea of Role Based authorization, which has already been available since 1.0 (see section Security above).
The feature adding a comment to the issue may be problematic if the current user is not authorized to add comments. If s/he is, it'll be alright.
So, keep an I on this page and / or on the JIRA issue for the comment feature.
Cheers,
Tibor
Feb 20
Tibor Hegyi says:
Hi, A JIRA projectHi,
A JIRA project has been set up for this plugin to track feature requests and bug reports.
Tibor
Feb 25
Tibor Hegyi says:
Hi, Version 1.0.3 linked above implements the "Add Comment to Issue" feature. ...Hi,
Version 1.0.3 linked above implements the "Add Comment to Issue" feature.
Cheers,
Tibor
Feb 25
Rainer Bugow says:
Thanks, Tibor\!Thanks, Tibor!
Feb 29
Tibor Hegyi says:
Hi Rainer, Version 1.0.4 includes attachments in comments, and the comments ar...Hi Rainer,
Version 1.0.4 includes attachments in comments, and the comments are created using velocity templates (see above in page).
Cheers,
Tibor
Mar 03
Rainer Bugow says:
Thanks again \!\!(y) Rainer Thanks again !!
Rainer
Mar 04
Will Phillipson says:
Hi Tibor, Fantastic plugin\! Thank you\! Can you give me a hint how to modify th...Hi Tibor,
Fantastic plugin! Thank you!
Can you give me a hint how to modify the subject? I'd like to add the issue key into the subject, so when someone responds to the message, I can have a handler auto add it as a comment...
Many thanks!
w.
Mar 04
Tibor Hegyi says:
Hi Will, Thank you for your feedback. This is a very good point! It absolutel...Hi Will,
Thank you for your feedback.
This is a very good point! It absolutely makes sense to add issue key to the subject.
I'll look into it.
Cheers,
Tibor