Project

General

Profile

Actions

Design/UX #22840

open

Email Documentation & Design Updates

Added by Sara Cannon 5 months ago. Updated 20 days ago.

Status:
New
Priority name:
Normal
Assignee:
Category name:
Email Notifications
Target version:
Start date:
2025-09-07
Due date:
% Done:

0%

Estimated time:
(Total: 0.00 h)
Deployment actions:

Description

Here is the google sheet that I created for the emails that the commons sends. I've noted some emails that do not have formatting. Designs for these emails are linked in the google sheet.

https://docs.google.com/spreadsheets/d/1sh-mSy1wodhmNnPLP2Eu3e3RCVy6dB5ytSwyXQ2QiOo/edit?usp=sharing

This list will be ongoing just incase we get a rogue email that is not formatted. Current formatting is needed on:

New Friendship Request
New File in Group
New Message
Reply By Email Error (design forthcoming)
Reply To Topic


Files

New Message.png (551 KB) New Message.png Sara Cannon, 2025-05-27 04:59 PM
Reply To Topic.png (578 KB) Reply To Topic.png Sara Cannon, 2025-05-27 04:59 PM
New Friendship Request.png (496 KB) New Friendship Request.png Sara Cannon, 2025-05-27 04:59 PM
New File in Group.png (635 KB) New File in Group.png Sara Cannon, 2025-05-27 04:59 PM
new-message.png (84.2 KB) new-message.png Raymond Hoh, 2025-07-22 11:29 AM
new-topic.png (105 KB) new-topic.png Raymond Hoh, 2025-07-22 11:29 AM
new-friendship-request.png (88.7 KB) new-friendship-request.png Raymond Hoh, 2025-07-22 11:29 AM
new-file.png (101 KB) new-file.png Raymond Hoh, 2025-07-22 11:30 AM
new-event.png (102 KB) new-event.png Raymond Hoh, 2025-07-22 11:34 AM
buddypress-emails.png (236 KB) buddypress-emails.png Raymond Hoh, 2025-07-22 11:34 AM
invite-member.png (203 KB) invite-member.png Raymond Hoh, 2025-09-30 05:38 AM
invite-non-member.png (238 KB) invite-non-member.png Raymond Hoh, 2025-09-30 05:38 AM

Subtasks 1 (1 open0 closed)

Bug #23376: Add support to disable some email notification optionsStaged for Production ReleaseRaymond Hoh2025-09-07

Actions
Actions #1

Updated by Raymond Hoh 3 months ago

I've started work on the email redesign that Sara has made mockups for. I've attached some screenshots that I took from GMail (web client) so the look-and-feel will not look 1:1 to the mockups due to the missing Google fonts, but for capable email clients, the font will display if you have allowed external fonts to be loaded. This is available for testing on cdev.

Notes for Sara:
  • There are a bunch more emails that are not styled. Check out https://commons.gc.cuny.edu/members/me/settings/notifications/ to see which other emails are being sent. Also see the attached screenshot named buddypress-emails.png for a master list of all other emails potentially being sent out. Some of the emails in this list might not be in use on the Commons. Will need an audit. If you need any help with this, feel free to reach out to myself or Boone.
  • For the New Message email, I've changed the "New Message" email heading to reference the private message subject line that is used when composing a private message. I've also added message attachments to the body of the email.
  • For the New Friendship Request email, I've changed the verbiage and button text to reference the Action Center page since that is where users should be managing their incoming friendship requests.
  • The New File In Group email is sent when a file is uploaded to the group's Library, so I've removed the "View Discussion" button. However, if an attachment is added to a Forum Reply, then the attachment is listed at the end of the Forum Reply email.
  • I've added a New Group Event email. The styling is mostly the same as the New File email, but it has a "Download iCalendar File" button instead of the "Download File" button.
  • I've also added a Friendship Accepted email. No screenshot for this one.
  • I still need to adjust the email footer so the Unsubscribe link is aligned to the right for applicable emails. I'll work on that on upcoming revisions.
Notes for Boone:
  • I've created a new branch for this work at feature/22840-email-design and have merged the branch to 2.6.x. Commits can be viewed here: https://github.com/cuny-academic-commons/cac/compare/master...feature/22840-email-design.
  • I'm reusing the email template made for the registration, activation and password reset emails. See here.
  • I added a "Date Modified" column to the BuddyPress Emails admin page since it wasn't clear which emails have been touched and modified in the backend. See https://github.com/cuny-academic-commons/cac/commit/14b611c9f65065337613340f3f391ea26afa2fd7.
  • caniemail.com is a good reference guide for which CSS rules and HTML elements can be used in email. To achieve the avatar overlay in the mockups, I'm using the group avatar as a background image and a padding offset for the user avatar.
  • Gravatars do not show up in Thunderbird, but do in GMail. Uploaded avatars show up fine in Thunderbird. I haven't tested other email clients yet.
  • I chose to use the existing email post types in the DB so when it is time to deploy to production, the post content for the various email post types will need to be updated. I can provide a list of what needs to be updated once the team has signed off after testing.

I think next steps are we need to determine which other emails we will need to redesign and then, plan accordingly.

Actions #2

Updated by Colin McDonald 2 months ago

I've added rows to Sara's Google Sheet attempting to get all of these in one place with no repeats:

- The emails she'd already listed there
- The emails in the settings page that Ray linked above
- The emails in the Buddypress emails screenshot that ray included above

https://docs.google.com/spreadsheets/d/1sh-mSy1wodhmNnPLP2Eu3e3RCVy6dB5ytSwyXQ2QiOo/edit?usp=sharing

I also extended the sheet drop-down for whether a given email needs formatting (Yes, No, In Review, and a new Low Priority option I added for emails that seem obvious to me that we can disregard for now due to low usage).

Sara and Ray, can you let me know what you think about prioritizing these new emails in the sheet? I also added some notes/questions of mine. Feel free to add another column with your own notes/responses or post things here in the ticket.

Actions #3

Updated by Colin McDonald 2 months ago

Adding watchers just to make sure my last update goes around.

Actions #4

Updated by Raymond Hoh 20 days ago

Just to update, all emails located on the "Account Settings > Notifications" page are now covered, as well as the two emails from the Invitations modal. The Invitations modal emails proved to be the most difficult to implement due to the dynamic nature of the invited content and having to use <table> HTML markup. I've attached just screenshots of the Invitations modal emails for now. These screenshots were taken from Thunderbird with remote fonts and images enabled.

The next two on my priority list for 2.6.0 are the Pending Registration email (#21647) and a barebones conversion of the Group Email Digest email.

For later maintenance releases, the Group Email Digest email layout can be tweaked, and support for the remaining emails from the spreadsheet can be added.

Actions

Also available in: Atom PDF