What is the "Email This Issue" plugin?
Automatic email notification to issue stakeholders (reporter, assignee, watchers) is governed by the project's notification scheme (see Notification Schemes), but you may want to send emails to individuals not named on the issue or send email to stakeholders that is not related to an issue change. For example, you may need information from someone in order to resolve the issue. The JIRA Email This Issue (JETI) plugin provides the ability to send email from issues to any email address and/or people in a project role.
If the email recipient replies to an email sent using "Email This Issue" and they are in the users group for that project, the reply will be added as a comment to the issue. The person will still not be able to view the issue unless they are the reporter or a consultant/observer within the project.
Email sent using "Email This Issue" will be recorded in the "Email" tab of the issue. Notification emails automatically generated by the notification scheme, and emails sent using "Request for Feedback" do not appear in this email tab.
Using "Email This Issue"
To access "Email this Issue:"
- Navigate to the issue from which you wish to send email.
- Click the "Email" button located in the upper right of the issue screen,
OR select "Email This Issue" by selecting "More" on the workflow menu and then "Email This Issue"
The "Email This Issue" Screen now appears:
Note that a "preview" button is available at the bottom of the Body field. This preview button is only for previewing any text formatting entered into the box for "Body:" It does not preview the entire message.
Use the "View/Hide" button in the upper left-hand corner to display the issue details in the second column (assignee, reporter, summary, status, description, etc.) or hide the issue details from the screen display. This button will affect what issue details are contained in the email sent.
Configure the fields for the email that will be sent:
Caution when sending email using roles
Caution should be used when sending to recipients by role. Selecting the Consultants role from the drop down menus of the second box below the "Recipients (To):" or the "Copy recipients (Cc):' fields can result in a large number of people receiving the notification, if the project in which the issue resides has many users in the Consultant role. Contact the project lead to make sure it is appropriate to send to the Consultants role.
- Recipients (To): You must have at least one email address in this field (it cannot be blank). To select someone who is a user of Orange Tracker, type their username (use netID for SU users), last name, or email address in the first box and select the correct entry from the drop-down list of possible matches that appears. If the intended recipient is not an Orange Tracker user, enter their email address in the top box. If you are sending to more than one person, separate the entries with a comma. If you want to send the email to specific roles within the project (project managers, assignee, reporter, etc.) use the drop-down list of the second box.
- Copy Recipients (cc): Enter one or more people in the top box to be added to the "CC:" line of the email (they will receive a copy of the email). If you want to copy the email to specific roles within the project (project managers, assignee, reporter, etc.) use the drop-down list of the second box.
- Subject: By default, the subject of the email is the Summary field of the issue. The subject can be changed if desired.
- Body: Add text for the body of the email. This body will also be included in the comment generated by "Email this Issue" (unless you specify that the body should not be added as a comment using the Email Options below) As with comments, you can add text formatting to the body of the email. The email must be sent in HTML format (see Email Options below) for the text formatting to be properly translated when the email is sent. See Comments in Orange Tracker for more information on text formatting.
- .Attach More Files: use to attach files (must be selected one at a time) to the email that is sent. The files will also be attached to the issue. Once at least one file has been attached to the email, a new "Attachments" section will appear to list the attached file(s).
- Email Template: Currently, the only template available is "default."
Email Options Button
Use the "Email Options" button in the upper left-hand corner of the issue to further control the behavior and format of the email that is generated.
- Add email recipients as watchers to the issue (note that the recipient must have permissions to view the issue for this to function properly)
- Send email with yourself set as sender (the project email address is used by default)
- Make replies go to you instead of the project issue (any replies will not be added as comments to the issue if you set yourself as the sender)
- Include issue comments in the outgoing email
- Choose HTML or Text for this email (needs to be HTML if using text formatting in body)
- You can choose to prevent the body of the email from appear in the comments by selecting "Thanks, I don't want to comment the issue" under comments settings. Note that the body of the email will still appear under the emails tab.
- You can set the comment visibility under "Comment Settings," but the usefulness of this is limited since the body of the email will be available in the Email tab to anyone who can view the issue. Note that If the default of "All Users" is used, the reporter will still be the only user to see the comment in the issue, since project and issue permissions still apply. Consultants and watchers can also see the comment, just like any other comment.
- If the notification scheme generates notification emails when comments are added, select "suppress event on adding comment" to silently add the comment.
- If you've modified and saved the email options, and want to return to the default settings for this email, use the "Reset to Default" link
NOTE: These eoptions will only affect email sent using the "Email" button. The options do not affect email notifications generated automatically by Orange Tracker and email generated by "Request Feedback."
Previewing Email and Saving Settings
Before sending the email, select the "Preview" button at the bottom of the email to see what the email will look like.
You can also save the options you selected using the "Email Options" button to be used in future emails sent (applies only to email sent using the "Email" button). Use the "Send and Save Settings" button to save the selections you made under "Email Options" (recipients, subject, body, attachments, and template are not part of the saved settings) These settings are per user and browser specific. If you use multiple browsers with Orange Tracker, you will need to set the email options in each browser.
To send an email without saving the email options, use the "Send" button.
Below is a screenshot of an email generated by the "Email" button. The email body will include the following information from the issue:
- text you entered in the "Body:" area
- issue key
- issue type
- created date
- comments (if you elected to include comments in Email Options)
- issue description