Project

General

Profile

Actions

Feature #1964

closed

Reorganize email notification subject line

Added by Maura Smale over 12 years ago. Updated over 12 years ago.

Status:
Resolved
Priority name:
Normal
Assignee:
Category name:
BuddyPress (misc)
Target version:
Start date:
2012-06-25
Due date:
% Done:

0%

Estimated time:
2.00 h
Deployment actions:

Description

A LILAC colleague has expressed frustration to me recently with the way that email notification subject lines are organized. Because they're so long, it's often the case that the meat of the subject is close to the end, which can get cut off when using browser- or phone-based email clients.

Here's her suggestion for a reorg, but I'm sure there are other possibilities as well:

CURRENT - Subject: Maura A. Smale replied to the forum topic "Get ready for Open Access Week!" in the group "Open Access Publishing Network CUNY (OaPN CUNY)" [CUNY Academic Commons]

REVISED - Subject: re: "Get ready for Open Access Week!" in the group "Open Access Publishing Network CUNY (OaPN CUNY)" [CUNY Academic Commons]

(Apologies if this has come up in the past and been resolved -- I feel like it may have, but when I searched here in Redmine I couldn't find anything matching this.)

Thanks!

Actions #1

Updated by Boone Gorges over 12 years ago

  • Category name set to BuddyPress (misc)
  • Status changed from New to Assigned
  • Assignee set to Boone Gorges
  • Target version set to 1.4
  • Estimated time set to 1.00 h

I agree with the suggestion to reorder, and I like Maura's REVISED order. Anyone have feedback? It would be an easy and impactful change for 1.4.

Actions #2

Updated by Chris Stein over 12 years ago

Thanks for bringing this up Maura. I agree that it could use some revision. The subject line is essentially made up of four parts currently:
USER_NAME, FORUM_TOPIC, GROUP_NAME, [CUNY Academic Commons]

Your revision changes it to:
FORUM_TOPIC, GROUP_NAME, [CUNY Academic Commons]

leaving out the USER_NAME. Also you added the "re:" at the beginning and removed most of the connective words between the parts.

I agree that starting with the forum topic is a good idea. I'm not sure about "re:" and I think the USER_NAME should be added back in, even if at the end. There are times when that info could be important. The connective words are not so important for experienced users but may be helpful for less experienced ones. For example using either forum or topic differentiates it from an announcement.

Some alternate suggestions:
topic TOPIC_NAME in the group GROUP_NAME was updated by USER_NAME [CUNY Academic Commons]
or
topic TOPIC_NAME was updated by USER_NAME in the group GROUP_NAME [CUNY Academic Commons]

"was updated by" could be changed to something like "has a new post by"

The above examples would read
topic "Get ready for Open Access Week" in the group "Open Access Publishing Network CUNY (OaPN CUNY)" was updated by Maura A. Smale [CUNY Academic Commons]

topic "Get ready for Open Access Week" was updated by Maura A. Smale in the group "Open Access Publishing Network CUNY (OaPN CUNY)" [CUNY Academic Commons]

Actions #3

Updated by Matt Gold over 12 years ago

I like the idea of reconsidering and condensing the email subject line, but I agree with Chris that the poster's name is crucial information. When I look at the subject line of the email, the poster's name is more important to me than the message topic.

My proposal:

CURRENT SUBJECT LINE: Maura A. Smale replied to the forum topic "Get ready for Open Access Week!" in the group "Open Access Publishing Network CUNY (OaPN CUNY)" [CUNY Academic Commons]

REVISED SUBJECT LINE: Maura A. Smale replied to "Get ready for Open Access Week!" | Open Access Publishing Network CUNY (OaPN CUNY)

This would be USER_NAME replied to "TOPIC_NAME" | GROUP_NAME

Actions #4

Updated by Matt Gold over 12 years ago

We might also institute a character limit on TOPIC_NAME and abbreviate overly long topic names with ". . ." to keep the subject lines reasonable.

Actions #5

Updated by Boone Gorges over 12 years ago

I like Matt's suggestion, except with "in" instead of a pipe:

USER_NAME replied to "TOPIC_NAME" in GROUP_NAME [CUNY Academic Commons]

For new topics:

USER_NAME started "TOPIC_NAME" in GROUP_NAME [CUNY Academic Commons]

I have a feeling that truncating long topic names will cause confusion. Most email clients can handle long topics just fine, and super-long topic names are probably not that common.

Actions #6

Updated by Maura Smale over 12 years ago

Looks good to me, thanks!

Actions #7

Updated by Matt Gold over 12 years ago

Sounds good. Do you all still think [CUNY Academic Commons] is necessary?

Actions #8

Updated by Chris Stein over 12 years ago

I also like the version with in instead of the pipe and having the name first is good with me too. It seems to make for more economical use of the inbetween words (replied to, started). We're losing the fact that it is a forum but that is probably OK.

I do think we should keep [CUNY Academic Commons] at the end. I'm not totally tied to it by my reasoning is:
Being at the end it's not an issue for this issue we're dealing with
It ensures people know that it is coming from the commons (although the email address also does this)
and it is something people can filter on (again, could do that with email)

Keeping words like forum and [CUNY Academic Commons] are probably more beneficial for new users than experienced ones.

Does everyone think this is a good time to evaluate all of the subject lines for the various emails sent out? The ones I can think of off of the top of my head are:
In Groups
  • Forum (start and reply)
  • Announcement
  • Files
  • Docs (create, update, comment)
  • Invites
Other
  • Messages
Actions #9

Updated by Boone Gorges over 12 years ago

  • Estimated time changed from 1.00 h to 2.00 h

Does everyone think this is a good time to evaluate all of the subject lines for the various emails sent out?

That's fine, though I don't want to hold up the 1.4 release for it. So let's just make some decisions and then move on :) Chris, can you put together suggested formats for these notification types, based on the agreed-upon format for forum topics?

Actions #10

Updated by Chris Stein over 12 years ago

Here are the Subjects with alternatives I was able to track down. I did it kind of quickly, feel free to nitpick.

When someone creates a forum post

USER_NAME started "TOPIC_NAME" in GROUP_NAME [CUNY Academic Commons]
- new wording suggested in this issue

When someone updates a forum post

USER_NAME replied to "TOPIC_NAME" in GROUP_NAME [CUNY Academic Commons]
- new wording suggested in this issue

When someone posts and announcement

New update in GROUP_NAME [CUNY Academic Commons]
- this is current some alternatives below:
New announcement in GROUP_NAME [CUNY Academic Commons]
USER_NAME made an announcement in GROUP_NAME [CUNY Academic Commons]
New announcement by USER_NAME in GROUP_NAME [CUNY Academic Commons]

When someone uploads a file to a group

USER_NAME uploaded the file: FILE_NAME to GROUP_NAME [CUNY Academic Commons]
- this is the current Subject, alternatives below:
USERNAME uploaded file FILE_NAME to GROUP_NAME [CUNY Academic Commons]

When someone edits a file in a group

USER_NAME edited the file: FILE_NAME in GROUP_NAME [CUNY Academic Commons]
- this is the current Subject, alternatives below
USER_NAME edited file FILE_NAME in GROUP_NAME [CUNY Academic Commons]

When someone creates a BP Doc

USER_NAME created the doc DOC_NAME in the group GROUP_NAME [CUNY Academic Commons]
- this is the current Subject, alternatives below
USER_NAME created doc DOC_NAME in GROUP_NAME [CUNY Academic Commons]

When someone edits a BP Doc

USER_NAME edited the doc DOC_NAME in the group GROUP_NAME [CUNY Academic Commons]
- this is the current Subject, alternatives below
USER_NAME edited doc DOC_NAME in GROUP_NAME [CUNY Academic Commons]

When someone comments on a BP Doc

USER_NAME commented on the doc DOC_NAME in the group GROUP_NAME [CUNY Academic Commons]
- this is the current Subject, alternatives below
USER_NAME commented on doc DOC_NAME in GROUP_NAME [CUNY Academic Commons]

When someone invites another person to a group

[CUNY Academic Commons] You have an invitation to the group: GROUP_NAME
- this is the current Subject, alternatives below
You are invited to join GROUP_NAME [CUNY Academic Commons]
USER_NAME invited you to join GROUP_NAME [CUNY Academic Commons]

When someone sends a message to someone else

[CUNY Academic Commons] New message from USER_NAME
- this is the current Subject, alternatives below
New message from USER_NAME [CUNY Academic Commons]
- if we want to include the subject
New message from USER_NAME: SUBJECT [CUNY Academic Commons]

When someone requests friendship

[CUNY Academic Commons] New friendship request from USER_NAME
- this is the current Subject, alternatives below
Friendship request from USER_NAME [CUNY Academic Commons]

Actions #11

Updated by Boone Gorges over 12 years ago

Thanks for the inventory, Chris.

I think your suggestions are good, much better than what we currently have in place. I would suggest going even further, cutting words like 'doc' and 'file', since they don't really provide information that's useful beyond the verb that's already there. So:

USER_NAME edited DOC_NAME in GROUP_NAME [CUNY Academic Commons]
USERNAME uploaded FILE_NAME to GROUP_NAME

etc.

Actions #12

Updated by Chris Stein over 12 years ago

Thanks Boone,
I debated "doc" and "file" myself. I'm not sure it's clear to new users what the difference is so I kept the words in. But I'm not sure if that really addresses the problem. You may be right that it doesn't really provide any more information. Perhaps there could be text inside of the email that lets the user know whether it's an doc or a file (and perhaps we could consider the bodies of the emails later as to not spend more time now).

Taking your suggestion we might also change "edited" to "modified" or "changed" for file and then the verbs would be different between file and doc actions

FILES
USERNAME uploaded FILE_NAME to GROUP_NAME [CUNY Academic Commons]
USER_NAME modified FILE_NAME in GROUP_NAME [CUNY Academic Commons]

DOCS
USER_NAME created DOC_NAME in GROUP_NAME [CUNY Academic Commons]
USER_NAME edited DOC_NAME in GROUP_NAME [CUNY Academic Commons]
USER_NAME commented on DOC_NAME in GROUP_NAME [CUNY Academic Commons]

Looking at it again, if we want to have USER_NAME start all Subjects (this is not necessary just an option) then we can change the last two regarding messages and friendship to something like:

USER_NAME sent you a message [CUNY Academic Commons]
USER_NAME sent you a message: SUBJECT [CUNY Academic Commons]

USER_NAME requests your friendship [CUNY Academic Commons]

Actions #13

Updated by Boone Gorges over 12 years ago

  • Status changed from Assigned to Resolved

I've made the following changes:

- Change subject lines in accordance with Chris's suggestions above. When he gave a couple of suggestions, I took the easiest one (some of his suggestions would have required logic changes in order to provide more information, which takes a lot more work)
- I put a generic filter on outgoing emails so that [CUNY Academic Commons] always appears at the end, rather than the beginning, of subject lines. This provides for greater consistency throughout, and puts the least helpful info at the end of the line.

Changesets:
https://github.com/castiron/cac/commit/21650060576c847db82518536b340b42807220b0
https://github.com/castiron/cac/commit/96a2144c7f89fa2b77c088ce1f817054f85810ed
https://github.com/castiron/cac/commit/3ea1498cf2786cffc8c0b764cf85364342aa6b53

Marking Resolved. If you find issues in the course of testing for the upcoming 1.4 release, please reopen the ticket or open a new one with details.

Actions #14

Updated by Matt Gold over 12 years ago

Great -- thanks, Boone.

Actions #15

Updated by Maura Smale over 12 years ago

Thanks Boone!

Actions

Also available in: Atom PDF