[jira] [Commented] (WHIMSY-178) Update email notification body to mention that it's automated

["Shane Curcuru (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/WHIMSY-178?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16853688#comment-16853688 ] 

Shane Curcuru commented on WHIMSY-178:
--------------------------------------

I plan to refactor all 5 of the above files to use a central roster-mailer utility function - the code using the Mail gem is identical in each.

I'll also be refactoring mail body into erb templates and including a standard [LDAP] prefix to subject lines, as discussed here:
https://lists.apache.org/thread.html/5bf02c15880f5ceb2add72afd7057abd0eda1c9874e7765095528ea7@%3Cprivate.incubator.apache.org%3E

> Update email notification body to mention that it's automated
> -------------------------------------------------------------
>
>                 Key: WHIMSY-178
>                 URL: https://issues.apache.org/jira/browse/WHIMSY-178
>             Project: Whimsy
>          Issue Type: Improvement
>          Components: Mail, Roster
>            Reporter: Christopher Tubbs
>            Priority: Major
>
> Today, I updated our project's roster with a new PMC member for our PMC Chair, and an email notification went to our private list notifying us of the change:
> [https://lists.apache.org/api/source.lua/90e0d135515ec7c90d0780b8baad6f85df72f58a8938e21db323673f@%3Cprivate.accumulo.apache.org%3E]
> However, that email appeared to come from me, and gave no indication that it was an automated email. It can create confusion when users are unable to easily distinguish between automated notifications and human emails, and it makes it difficult for users to filter and prioritize incoming email... something critical to a community centered around mailing lists.
> In addition, the body did not contain all the details of the action, relying on users inferring things from the From address and the Subject line.
> I propose a few suggestions:
> 1. Add a tag to the beginning of the subject, like "[ROSTER] ...." or "[WHIMSY] ...."
> 2. Begin the body with a notice similar to git/svn commit notices: "This is an automated email from the ASF project roster management tool at https://whimsy.apache.org"
> 3. Copy the subject information "<Person> added to <Project> PMC list" into the body of the email in addition to being in the subject line.
> 4. Include information in the body about who triggered this notification.
> 5. (optional) have the From address represent some no-reply Whimsy email address, instead of the user's individual address which triggered the action.
> Item 3 isn't really about distinguishing automated notifications from humans... it's just a generally good practice to include all the information in the body of an email, instead of relying on the body being read immediately after reading the subject line (which is not always convenient, depending on the email client software).
> Item 4 is important for the same reason Item 3 is: the body should contain all the necessary information.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)