user_settings: Automate 'Include realm name in missedmessage email subject'.

[prakhar1144]

Under Settings > Notifications, currently, there is a checkbox setting for whether to "Include realm name in subject of message notification emails".

This commit replaces the checkbox setting with a dropdown: Automatic [default], Always, Never

The Automatic option includes the realm name if, and only if, there are multiple Zulip realms associated with the user's email.

Tests are added and(or) modified.

Fixes: #19905.

---

Screenshots and screen captures:

Following four cases are possible:

Always

Never

2 cases in Automatic

User part of a single org

User part of multiple orgs

Settings Changes

Current

Updated

Dropdown

---

Second Commit

Current Doc

Updated Doc

---

Self-review checklist

• Self-reviewed the changes for clarity and maintainability
  (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

• Explains differences from previous plans (e.g., issue description).
• Highlights technical choices and bugs encountered.
• Calls out remaining decisions and concerns.
• Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

• Each commit is a coherent idea.
• Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

• Visual appearance of the changes.
• Responsiveness and internationalization.
• Strings and tooltips.
• End-to-end functionality of buttons, interactions and flows.
• Corner cases, error conditions, and easily imagined bugs.

[zulipbot]

Hello @zulip/server-settings members, this pull request was labeled with the "area: settings (user)" label, so you may want to check it out!

[prakhar1144]

@alya Can you please review this PR?

[alya]

Thanks! Could you please add a screenshot of the settings changes as well?

[prakhar1144]

@alya Added -- Thanks.

[alya]

Sorry, where's the screenshot?

[prakhar1144]

@alya
Ah, extremely sorry. Actually, I somehow forgot to click the update comment button after preview and closed the tab.
Please have a look now.

[alya]

Thanks!

@sahil839 Would you be up for reviewing this one?

I think we'll want to migrate users who haven't toggled this setting to "Automatic", as the issue suggests. I don't know if that's included in the PR already.

[prakhar1144]

I think we'll want to migrate users who haven't toggled this setting to "Automatic", as the issue suggests. I don't know if that's included in the PR already.

Yes, It is included here in this file.

[sahil839]

Posted a couple of comments. Looks good overall.

Also, we do not set the old values for this setting in RealmUserDefault in the migration. Is there any particular reason for that?

Also I think we can have a better name for the migration file than the current name. (Recently such migrations were divided into multiple files - like one for adding new field, second for setting the new field to values of old fields and third for removing the old field, but I think this makes more sense only when we are renaming the field and having a single file should work fine here.)

[prakhar1144]

@sahil839

Also, we do not set the old values for this setting in RealmUserDefault in the migration. Is there any particular reason for that?

I have corrected this. -- Thanks. (I missed that earlier :) )

Also I think we can have a better name for the migration file

I have updated it to 0423_alter_and_migrate_realm_name_in_notifications.py
Does it look better?

[sahil839]

Looks good. (I have not reviewed the docs changes).

I have updated it to 0423_alter_and_migrate_realm_name_in_notifications.py
Does it look better?

Yes.

[alya]

@timabbott This PR has been reviewed by @sahil839 and me, and is ready for you to take a look.

Please don't merge the documentation commit; I will tweak it once the feature has been integrated.

[prakhar1144]

@timabbott This is ready to review.

Update in the recent push:

• Use of intermediate variable in migration removed.
• renamed realm_name_in_notifications_policy to realm_name_in_email_notifications_policy (comment)
• renamed realm_name_allowed_in_missedmessage_emails_subject to include_realm_name_in_missedmessage_email_subject (comment)
• Update a comment -- function description .
• Both RemoveField operations at the end in migration. (comment)
• Update API feature level

Comments which needs your attention (potential followup PR)

• comment 1
• comment 2

[prakhar1144]

@timabbott This PR is ready to review after the minor changes.

Updates in the recent push

• API docs update after discussion in CZO -- api design (comment-2)
• Prep commit to fix linter behaviour (comment)

---

Also, earlier Alya said:

Please don't merge the documentation commit; I will tweak it once the feature has been integrated.

So, the first two commit would be good to merge (if it LGTM).

[timabbott]

Dropped the documentation commit and marked this to merge once CI passes. Thanks so much for all the work on this @prakhar1144!

Here's the original draft of that change:

commit 11944208adfa9fcf3b1312d40d68ed369cc9a944
Author: Prakhar Pratyush <prakhar841301@gmail.com>
Date:   Sun Jan 15 15:48:43 2023 +0530

    docs: Update 'Include organization name in subject line' settings' docs.
    
    This commit updates the help page 'email-notification.md' to reflect
    the change in #24075 from a checkbox to a dropdown for the
    'Include organisation name in subject line' setting.

diff --git a/help/email-notifications.md b/help/email-notifications.md
index 400cd61bd3..31b266343a 100644
--- a/help/email-notifications.md
+++ b/help/email-notifications.md
@@ -57,15 +57,25 @@ To configure the delay for message notification emails:
 If you belong to multiple Zulip organizations, it can be helpful to have the
 name of the organization in the subject line of your message notification emails.
 
+By default, Zulip includes the organization name if, and only if, your email is
+associated with multiple Zulip organizations.
+
+You can configure Zulip to always or never include the organization name in the
+subject line.
+
 {start_tabs}
 
 {settings_tab|notifications}
 
-1. Under **Email message notifications**, toggle
+1. Under **Email message notifications**, configure
    **Include organization name in subject of message notification emails**.
 
 {end_tabs}
 
+The default is **Automatic**, which includes the organization name if, and only if, your email is
+associated with multiple Zulip organizations. **Always** and **Never** either include or don't include
+the organization name, regardless of how many organizations you are part of.
+
 
 ### Hide message content
 

[prakhar1144]

Thanks.

@alya

Since the PR is merged, following comments need your attention:

• Update Documentation
• help_link_widget

ps: The PR description contains an image of updated docs (which I earlier proposed). In case that's helpful in any way.

[alya]

Thanks! I don't want to dig through the comment thread -- what happened to the documentation commit (prakhar1144@c193fd4) you had before?

[alya]

Assuming it hasn't been merged, you can put it up as a new PR, and I'll use that as a starting point.

[prakhar1144]

@alya

Here's the PR #24696 (with the description -- what happened to the documentation commit I had before)