Use an enum for user email notification types

Open on Drupal.org →

Created on 8 October 2015, about 9 years ago

Updated 13 September 2024, about 1 month ago

Problem/Motivation

The _user_mail_notify() function is responsible for sending out notification emails to users.
It has these types of emails:

register_admin_created: Welcome message for user created by the admin.
register_no_approval_required: Welcome message when user self-registers.
register_pending_approval: Welcome message, user pending admin approval.
password_reset: Password recovery request.
status_activated: Account activated.
status_blocked: Account blocked.
cancel_confirm: Account cancellation request.
status_canceled: Account canceled.

They are simple strings and so any change to them can break some contrib codes. Therefore these should be enum. If nothing will change (ie. no code breaks in the future) they should nonetheless become constants.

Proposed resolution

They currently exist as strings, in order to allow adding/modifying/deleting these values, and make code more referential (IDE completion, static analysis), the possible values should be converted to an enum. This also prevents using this internal (underscore prefixed) function for values it is not intended to handle.

Remaining tasks

Create an enum, doesnt need to be string backed as values are only used in-memory.
Convert string usages to enum.
Add backwards compatible string/enum parameter just like FileSystem.

User interface changes

Nil

Introduced terminology

Nil

API changes

Existing usages converted
Deprecation

Data model changes

Nil

Release notes snippet

@todo, A release note snippet and changelog should be created

✨ Feature request

Status

Needs work

Version

11.0 🔥

Component

User system →

Last updated 1 day ago

Maintained by
🇺🇸United States @moshe weitzman
🇧🇪Belgium @kristiaanvandeneynde

Created by

Live updates comments and jobs are added and updated live.

DX (Developer Experience)
Enhances developer experience.

Incomplete comments

Sign in to follow issues

Merge Requests

!8989Use an enum for user email notification types
Open
🇮🇳India arunkumark
updated 3 months ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 3 months ago →
🇦🇺Australia dpi Perth, Australia
In 2024, this should be an enum.

We also have an established backward compatibility pattern used by FileRepository (10.3 & 11.0) in 📌 Create enums for File exists options and deprecate consts RTBC which allows int|Enum, which we can adapt to string|Enum here.
Comment 3 months ago →
🇦🇺Australia dpi Perth, Australia
Reformatting, retitling
First commit to issue fork.
Assigned to arunkumark
Comment 3 months ago →
🇮🇳India arunkumark Coimbatore
Merge request !8989Creating Enum for the User mail constants → (Open) created by arunkumark
Pipeline finished with Failed
3 months ago
Total: 984s
#238492
Status changed to Needs review 3 months ago3:19pm 30 July 2024
Comment 3 months ago →
🇮🇳India arunkumark Coimbatore
I created MR by introducing the new Enum for the user notification emails. The Enumeration file is placed under Core Utility (core/lib/Drupal/Core/Utility/UserEmailNotification.php)

Replaced all the possible places with the enum value.
Pipeline finished with Success
3 months ago
#238519
Issue was unassigned.
Comment 3 months ago →
🇮🇳India arunkumark Coimbatore
Comment about 2 months ago →
🇺🇸United States smustgrave
Add backwards compatible string/enum parameter just like FileSystem.

Not sure I see this part.
Status changed to Needs work about 1 month ago10:51pm 13 September 2024
Comment about 1 month ago →
🇺🇸United States smustgrave

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024