Content
View differences
Updated by Parimal Satyal over 4 years ago
**As a** project member
**I want to** able to configure settings for my daily email reminders and weekly email recaps
**so that** I get the most relevant emails that are not redundant with the notifications I am already receiving via Notification Center
**Note and Scope**
This work package is related to <mention class="mention" data-id="38671" data-type="work_package" data-text="#38671">#38671</mention> , which defines notification settings at a user-account level.
There were discussions around adding more options in the first section "Send me an email reminder" to open up email reminders to other events. This is out of scope for this work package, but we can certainly discuss it further before implementing.
**Visuals**
_Main view (with default values)_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/22402/content"></div></figure>
src="/api/v3/attachments/22307/content"></div></figure>
_Daily reminder send time default:_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="https://community.openproject.org/api/v3/attachments/22251/content"></div></figure>
_Daily reminder time selection drop-down:_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="https://community.openproject.org/api/v3/attachments/22256/content"></div></figure>
_Daily reminder time selection, two times added:_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="https://community.openproject.org/api/v3/attachments/22257/content"></div></figure>
**Acceptance Criteria**
* User account settings now include a new section called "Email reminders". This term replaces the old term "Email notifications".
* There is a new icon for this section (SVG available via the Figma Components Library).
* The first item a section, "Send me an email reminder" with
* One checkbox, _unchecked_ by default "Immediate when someone @mentions me"
* The second item is a section, "Send me daily email reminders for unread notifications" with a second line of explanation of that reminders users that these reminders only contain unread notifications and are sent only at specific hours as configured. This section consists of:
* By default, there will only be one time option enabled (8 am)
* Clicking on “Add time” will add a new line with a checkbox (enabled), and a time drop-down that is in focus (with the drop-down list visible).
* The first three added times has a recommended default selection: 12pm, 3pm and 6pm. For each additional time, the default selection will simply be an hour after the latest previously selected time. (For example, if the latest set time was 7pm, the automatic default setting for a time is is 8pm).
* There is an “x” button after all times, except the first one, to remove that time.
* The times will be displayed with an hourly interval, instead of the half-hour interval previously specified.
* If the user unchecks the first parent check-box (“Enable daily email reminders”), the children checkboxes (times) become disabled, but retain the checked/unchecked status.
* The second section, titled "Receive email reminders on these days", allows the user to define working days on which to receive these daily reminders.
* Seven child checkboxes, one for each day of the week
* The first five (Monday–Friday) are selected by default, the last two (Saturday–Sunday) are unchecked
* The user is free to select/deselect any day day
* The next section is a check "Temporarily pause daily email reminders" that allows users to specify a date range for which they will not receive daily reminders. (Intended use case: when one is on holiday). This will be the standard date range selector used to specify date ranges for work packages.
* The last section is titled "Email alerts for other items (that are not work packages)" and is a temporary solution to enable/disable email alerts concerning items that are not work packages. (Eventually, these alerts will be folded into notifications in Notification Center). The list of items the same as they are today, with small differences in phrasing:
* News added
* Comment added to a news item
* Documents added
* New forum messages
* Wiki page added
* Wiki page updated
* Membership added
* Membership updated
**The following is now out of scope:**
* ~~The next section concerns "Weekly email recaps".~~
* ~~The first check box, enabled and checked by default, is "Send me email recaps with important project updates of the week"~~
* ~~There is a day selector preceded by the word "Every". This allows the user to define which day to receive the the weekly recap. Default is~~ _~~Monday~~_~~.~~
* ~~There is a time selector precededb y the word "At". This allows the user to define which time on the specified day to receive said recap. Default is~~ _~~7am~~_ ~~local time.~~
* ~~The second checkbox, enabled but unchecked by default, "Temporarily pause weekly email recaps". This allows the user to specify a date range for which they will not receive weekly recaps. (Intended use case: when one is on holiday).~~
* ~~The next section is titled "Exclude projects from weekly recaps". A second line explains that certain projects can be manually excluded from these recaps.~~
* ~~A button, "Add project exceptions", allows users to add projects. This opens up the project selector/search drop-down, with a multi-select the user may use to select projects they want to exclude.~~
* ~~Each project that is added is added to a table, with the header "Projects"~~
* ~~Each added project has two elements~~
* ~~Project name, or if it's a sub-project, the name preceeded by an ellipsis (...).~~
* ~~A button to remove that project exception, with the words"Remove exception"followed by an icon. (We are avoiding any phrasing that would imply~~ _~~removing a project~~_ ~~to ensure there is no ambiguity about the fact that removing this exception does nothing to the actual project; in other words, it does not remove the project from one's list of projects).~~
~~**Legacy email alerts** (added 24 August)~~
* ~~Apart from notifications related to work packages, we are currently sending out email "notifications" (to use the current, pre 11,4 phrasing) for certain events unrelated to work packages. Although the goal is to remove automatic emails for these events, we have not yet integrated these into notifications yet. We will thus have to leave the settings for these items on the "Email reminders page", simplified into four items:~~
* ~~News added or updated~~
* ~~Files added~~
* ~~Wiki pages added or updated~~
* ~~Members added or updated This should be the last section of this page, and should reflect users' current settings (currently on the "Notification settings" page).~~
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/22186/content"></div></figure>
**Out of scope**
* There were discussions around adding more options in the first section "Send me an email reminder" to open up email reminders to other events. This is out of scope for this work package, but is naturally open to discussion for a later release.
* Auto-save for preferences not part of this work package (we will keep the the current system with Save and Cancel buttons).
**Mockups in Figma**
Default "Email reminders" view:
https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Settings?node-id=79%3A1247
With project selector drop-down open:
https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Settings?node-id=132%3A5311
With project exceptions added:
https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Settings?node-id=132%3A5894
**I want to** able to configure settings for my daily email reminders and weekly email recaps
**so that** I get the most relevant emails that are not redundant with the notifications I am already receiving via Notification Center
**Note and Scope**
This work package is related to <mention class="mention" data-id="38671" data-type="work_package" data-text="#38671">#38671</mention> , which defines notification settings at a user-account level.
There were discussions around adding more options in the first section "Send me an email reminder" to open up email reminders to other events. This is out of scope for this work package, but we can certainly discuss it further before implementing.
**Visuals**
_Main view (with default values)_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/22402/content"></div></figure>
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="https://community.openproject.org/api/v3/attachments/22251/content"></div></figure>
_Daily reminder time selection drop-down:_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="https://community.openproject.org/api/v3/attachments/22256/content"></div></figure>
_Daily reminder time selection, two times added:_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="https://community.openproject.org/api/v3/attachments/22257/content"></div></figure>
**Acceptance Criteria**
* User account settings now include a new section called "Email reminders". This term replaces the old term "Email notifications".
* There is a new icon for this section (SVG available via the Figma Components Library).
* The first item a section, "Send me an email reminder" with
* One checkbox, _unchecked_ by default "Immediate when someone @mentions me"
* The second item is a section, "Send me daily email reminders for unread notifications" with a second line of explanation of that reminders users that these reminders only contain unread notifications and are sent only at specific hours as configured. This section consists of:
* By default, there will only be one time option enabled (8 am)
* Clicking on “Add time” will add a new line with a checkbox (enabled), and a time drop-down that is in focus (with the drop-down list visible).
* The first three added times has a recommended default selection: 12pm, 3pm and 6pm. For each additional time, the default selection will simply be an hour after the latest previously selected time. (For example, if the latest set time was 7pm, the automatic default setting for a time is is 8pm).
* There is an “x” button after all times, except the first one, to remove that time.
* The times will be displayed with an hourly interval, instead of the half-hour interval previously specified.
* If the user unchecks the first parent check-box (“Enable daily email reminders”), the children checkboxes (times) become disabled, but retain the checked/unchecked status.
* The second section, titled "Receive email reminders on these days", allows the user to define working days on which to receive these daily reminders.
* Seven child checkboxes, one for each day of the week
* The first five (Monday–Friday) are selected by default, the last two (Saturday–Sunday) are unchecked
* The user is free to select/deselect any day
* The next section is a check "Temporarily pause daily email reminders" that allows users to specify a date range for which they will not receive daily reminders. (Intended use case: when one is on holiday). This will be the standard date range selector used to specify date ranges for work packages.
* The last section is titled "Email alerts for other items (that are not work packages)" and is a temporary solution to enable/disable email alerts concerning items that are not work packages. (Eventually, these alerts will be folded into notifications in Notification Center). The list of items the same as they are today, with small differences in phrasing:
* News added
* Comment added to a news item
* Documents added
* New forum messages
* Wiki page added
* Wiki page updated
* Membership added
* Membership updated
**The following is now out of scope:**
* ~~The next section concerns "Weekly email recaps".~~
* ~~The first check box, enabled and checked by default, is "Send me email recaps with important project updates of the week"~~
* ~~There is a day selector preceded by the word "Every". This allows the user to define which day to receive the the weekly recap. Default is~~ _~~Monday~~_~~.~~
* ~~There is a time selector precededb y the word "At". This allows the user to define which time on the specified day to receive said recap. Default is~~ _~~7am~~_ ~~local time.~~
* ~~The second checkbox, enabled but unchecked by default, "Temporarily pause weekly email recaps". This allows the user to specify a date range for which they will not receive weekly recaps. (Intended use case: when one is on holiday).~~
* ~~The next section is titled "Exclude projects from weekly recaps". A second line explains that certain projects can be manually excluded from these recaps.~~
* ~~A button, "Add project exceptions", allows users to add projects. This opens up the project selector/search drop-down, with a multi-select the user may use to select projects they want to exclude.~~
* ~~Each project that is added is added to a table, with the header "Projects"~~
* ~~Each added project has two elements~~
* ~~Project name, or if it's a sub-project, the name preceeded by an ellipsis (...).~~
* ~~A button to remove that project exception, with the words"Remove exception"followed by an icon. (We are avoiding any phrasing that would imply~~ _~~removing a project~~_ ~~to ensure there is no ambiguity about the fact that removing this exception does nothing to the actual project; in other words, it does not remove the project from one's list of projects).~~
~~**Legacy email alerts** (added 24 August)~~
* ~~Apart from notifications related to work packages, we are currently sending out email "notifications" (to use the current, pre 11,4 phrasing) for certain events unrelated to work packages. Although the goal is to remove automatic emails for these events, we have not yet integrated these into notifications yet. We will thus have to leave the settings for these items on the "Email reminders page", simplified into four items:~~
* ~~News added or updated~~
* ~~Files added~~
* ~~Wiki pages added or updated~~
* ~~Members added or updated This should be the last section of this page, and should reflect users' current settings (currently on the "Notification settings" page).~~
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/22186/content"></div></figure>
**Out of scope**
* There were discussions around adding more options in the first section "Send me an email reminder" to open up email reminders to other events. This is out of scope for this work package, but is naturally open to discussion for a later release.
* Auto-save for preferences not part of this work package (we will keep the the current system with Save and Cancel buttons).
**Mockups in Figma**
Default "Email reminders" view:
https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Settings?node-id=79%3A1247
With project selector drop-down open:
https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Settings?node-id=132%3A5311
With project exceptions added:
https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Settings?node-id=132%3A5894