Skip to content

docs: about how to prevent sending certain notifications type through email #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: about how to prevent sending certain notifications type through email #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94275c1
docs: about how to prevent sending certain notifications type through…
aleortega Aug 26, 2024
2ee296b
apply PR feedback
aleortega Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,12 @@ sequenceDiagram
> If the email sent in the `PUT /set-email` request is an empty string, the email will be removed from the subscription and email notifications will be
> deactivated for the user.

### Prevent sending emails for certain type of notifications
Currently, the service broadcasts notifications both via email and in-world/in-app inbox. Whenever a new notification is added, the service attempts to deliver it through both channels. However, certain notifications should be broadcast exclusively in-world to avoid cluttering users' email inboxes.

The service will attempt to send email notifications if a corresponding template is available in the `processor/src/adapters/email-templates/` directory. To prevent a notification from being sent via email and only broadcast it in-world, simply avoid adding or remove the email template for that notification from this directory.

Additionally, the service tests must be adjusted since they automatically check for a matching template for every notification type. For notifications intended to be broadcast only in-world, they must be excluded from `/common/src/types.ts` and the test suite located at `/processor/test/unit/adapters/email-renderer.spec.ts`, as has already been done for the `BADGE_GRANTED` notification type.

# Run locally

Expand Down
Loading