Univention Bugzilla – Bug 46080
Rename descriptions of E-mail-related attributes in UMC
Last modified: 2021-12-30 16:21:55 CET
To reduce confusion, we should adjust the display name of our E-mail-related attributes. I suggest: 1. User -> General old: "Primary e-mail address" new: "Primary e-mail address (mailbox)" 2. User -> [Advanced settings] old: "Alternative e-mail address" new: "E-mail alias address" 3. User -> Contact old: "E-mail address" new: "E-mail address" -> no change, but add a long description, e.g.: "This e-mail adress serves only as contact information. This address has no effect on the UCS mail stack and is not related to a local mailbox." 4. User -> Password Recovery old: "E-mail address" new: "Password recovery e-mail address" This bug addresses the descriptions of the attributes in UMC. I'm fine with leaving the names of the LDAP attributes as they are.
This issue has been filed against UCS 4.2. UCS 4.2 is out of maintenance and many UCS components have changed in later releases. Thus, this issue is now being closed. If this issue still occurs in newer UCS versions, please use "Clone this bug" or reopen it and update the UCS version. In this case please provide detailed information on how this issue is affecting you.
Please change the descriptions as written by Michael in handlers/users/user.py and handlers/settings/usertemplate.py, de.po and fr.po files and in the documentation. To find all relevant files you can use: git grep 'Alternative e-mail address'
Description have been changed with commit commit 29f7fd60e30ee918a67a988cae2408aa7af43937 Bug #46080: renamed e-mail related attribute descriptions on branch troehmey/bug46080 fr.po was not changed. The file is very out of date and my french is not good enough.
Do we really want to change this in an Errata? UCS 5.0 would be better
I am also unhappy with the new labels (short_description). Why can't we adjust / add a long_description instead? - even with more details/description. In "Primary e-mail address (mailbox)" → What does the mailbox mean? Is this then better? I don't think so. "E-mail alias address" → Where is it an alias?
(In reply to Ingo Steuwer from comment #4) > Do we really want to change this in an Errata? > > UCS 5.0 would be better It is only aber the description text. The property names are not touched. What is the reason to not change this in an erratum?
(In reply to Daniel Tröder from comment #6) > (In reply to Ingo Steuwer from comment #4) > > Do we really want to change this in an Errata? > > > > UCS 5.0 would be better > It is only aber the description text. The property names are not touched. > What is the reason to not change this in an erratum? That the patch doesn't change only the description but the labels. And that comment 0 speaks about changing the labels ("display name").
(In reply to Florian Best from comment #7) > (In reply to Daniel Tröder from comment #6) > > (In reply to Ingo Steuwer from comment #4) > > > Do we really want to change this in an Errata? > > > > > > UCS 5.0 would be better > > It is only aber the description text. The property names are not touched. > > What is the reason to not change this in an erratum? > > That the patch doesn't change only the description but the labels. And that > comment 0 speaks about changing the labels ("display name"). Hmm.. yes.. changing the labels - even if they are better - is not good in an erratum. So yes - I guess the developers branch should be merged (or probably cherry-picked) to a UCS 5.0 branch instead.
(In reply to Florian Best from comment #5) > I am also unhappy with the new labels (short_description). > Why can't we adjust / add a long_description instead? - even with more > details/description. I concur, a long_description is desirable. I propose: mailPrimaryAddress: long_description=_('Email address that will be used to create the IMAP/POP3 mailbox and that can be used as login for SMTP/IMAP/POP3 connections. The domain must be one of the UCS hosted email domains.') mailAlternativeAddress: long_description=_('Additional email addresses for which emails will be delivered to the "Primary e-mail address". The domain must be one of the UCS hosted email domains.') > In "Primary e-mail address (mailbox)" → What does the mailbox mean? Is this > then better? I don't think so. Yes it is. In a mail system there are mailboxes and aliases. The mailboxes are the "storage" and the aliases the "addresses". Like an alias the mailbox _name_ can be used to deliver mails to the mailbox... like folders and symlinks. Additionally the mailbox name is the login name that must be used to access the mailbox remotely. When administrators care for email servers, "mailbox" and "alias" are the correct and common terms to use. > "E-mail alias address" → Where is it an alias? See above. An "alias" is another name for the same thing (here a mailbox).
Added long descriptions suggested in comment#9 with commit [troehmey/bug46080] 3fc7a33253 Bug #46080: added long descriptions
(In reply to Toni Röhmeyer from comment #10) > Added long descriptions suggested in comment#9 with commit > > [troehmey/bug46080] 3fc7a33253 Bug #46080: added long descriptions You did not translate them and did not use the gettext functions.
Sorry, I forgot that. Thanks for the remark! Translations added with [troehmey/bug46080] 1cf34a6de0 Bug #46080: added translations
You added an empty messagestring: +msgid "This e-mail address serves only as contact information. This address has no effect on the UCS mail stack and is not related to a local mailbox." +msgstr ""
Sorry for the misunderstanding. Added missing message string with [troehmey/bug46080] 704f628bc7 Bug #46080: added missing msgstr
* Double "Die" in de.po: * missing dot after "E-Mail Domänen sein" in de.po: -------------------------- "als Login für SMTP/IMAP/POP3 Verbindungen verwendet werden kann. Die " "Die Domäne muss eine der von UCS gehosteten E-Mail Domänen sein" -------------------------- * Missing update procedure in 35univention-self-service-passwordreset-umc. An existing extended attribute will not be changed with a 'create' operation. Add a update section to change the shortDescription and translationShortDescription and raise the join script version. * Please revert the "short_description" of "mailAlternativeAddress" to 'E-mail alias address' and only append ' (alias)', similar are was done with 'mailPrimaryAddress'.
Please squash the commits into one commit and rebase it on top of 4.4-7. We'll decide later if it'll be release in 4.4-8 or 5.0-0.
Commits squashed and rebased to 4.4-7 on a new branch troehmey/bug46080_v2 cd186374ed Bug #46080: renamed e-mail related attribute descriptions
The current branch looks good except for the change of the label: management/univention-directory-manager-modules/modules/univention/admin/handlers/settings/usertemplate.py - short_description=_('Primary e-mail address'), + short_description=_('Primary e-mail address (mailbox)'), management/univention-directory-manager-modules/modules/univention/admin/handlers/users/user.py - short_description=_('Primary e-mail address'), + short_description=_('Primary e-mail address (mailbox)'),
I created a new feature branch troehmey/bug46080_5.0 from 5.0-0 and committed the same changes there with: 85515a0e75 Bug #46080: renamed e-mail related attribute descriptions I had many conflicts when trying to rebase troehmey/bug46080_v2 on 5.0-0.
Very good. Two small fixes: * "Die Die" in .../handlers/users/de.po * - Zusätzliche E-Mail Adresse für die E-Mails zur \"Primary e-mail address\" + Zusätzliche E-Mail Adresse für die E-Mails zur \"Primäre E-Mail-Adresse (Mailbox)\" Then squash, merge and build please.
And this one still needs to be reverted!: 'mailPrimaryAddress': univention.admin.property( - short_description=_('Primary e-mail address'), + short_description=_('Primary e-mail address (mailbox)'),
Merged to 5.0 with 4bead9ebb1 Bug #46080: added changelog entries 57e2698fdb Bug #46080: Merge branch 'troehmey/bug46080_5.0' into 5.0-0 build still needs to be done. Sorry I don't know yet to build for 5.0-0 releases... in reply to comment #21 sorry I overlooked that... I'll add that later. But what with Daniels explanation on that in comment #9 ?
(In reply to Florian Best from comment #21) > And this one still needs to be reverted!: > > 'mailPrimaryAddress': univention.admin.property( > - short_description=_('Primary e-mail address'), > + short_description=_('Primary e-mail address (mailbox)'), Why revert this? IMHO that is an important keyword here. See my #comment9.
(In reply to Toni Röhmeyer from comment #22) > Merged to 5.0 with > > 4bead9ebb1 Bug #46080: added changelog entries > 57e2698fdb Bug #46080: Merge branch 'troehmey/bug46080_5.0' into 5.0-0 > > build still needs to be done. Sorry I don't know yet to build for 5.0-0 > releases... ssh ladda repo_admin.py -G git@git.knut.univention.de:univention/ucs.git -b 5.0-0 -P $package -p $path -r 5.0 -s errata5.0-0 && b50-scope errata5.0-0 "$path" > in reply to comment #21 sorry I overlooked that... I'll add that later. > But what with Daniels explanation on that in comment #9 ? hm. I don't see a reason to add this phrase. You can explain it in the long_description. The short_description is also kind of an API for extended attributes. they can be overwritten by defining the short_description string, etc.
I built the packages for now: Package: univention-directory-manager-modules Version: 15.0.11-4A~5.0.0.202106261717 Branch: ucs_5.0-0 Scope: errata5.0-0 Package: univention-self-service Version: 5.0.1-15A~5.0.0.202106261733 Branch: ucs_5.0-0 Scope: errata5.0-0 27c00f7e51 Bug #46080: added advisories
(In reply to Florian Best from comment #24) > The short_description is also kind of an API for extended > attributes. they can be overwritten by defining the short_description > string, etc. I have never heard of this. Can you explain what API that is?
In the documentation for extended attributes nothing like that exists. Improved advisories: [5.0-0 1443defd13] Bug #46080: improve wording and fix build version
OK: code changes OK: translations OK: manual test in the UMC The purpose of the different email related fields is now much better understandable for customers.
REOPEN: the test case https://jenkins.knut.univention.de:8181/job/UCS-5.0/job/UCS-5.0-0/view/Default/job/AutotestJoin/lastCompletedBuild/SambaVersion=no-samba,Systemrolle=master-part-II/testReport/40_mail/71_spaces_in_mail_address/master090/ fails due to the changes. REOPEN: what about documentation? doc/manual/user-management-en.xml: <entry>Primary e-mail address</entry> doc/manual/windows-en.xml:synchronized. <emphasis>Primary e-mail address</emphasis> and <emphasis>Telephone number</emphasis> are
* users/de.po und settings/de.po - "Zusätzliche E-Mail Adresse, für die E-Mails zur \"Primären E-Mail-Addresse " "(Mailbox)\" gesendet werden. Die Domäne muss eine der von UCS gehosteten E-" "Mail Domänen sein." + "E-Mails, die an diese zusätzliche E-Mail-Adresse gerichtet sind, werden ebenfalls an die Mailbox des Benutzers zugestellt. Der Domänenteil der Adresse muss einer der von UCS gehosteten E-Mail-Domänen entsprechen."
(In reply to Florian Best from comment #29) > REOPEN: the test case > https://jenkins.knut.univention.de:8181/job/UCS-5.0/job/UCS-5.0-0/view/ > Default/job/AutotestJoin/lastCompletedBuild/SambaVersion=no-samba, > Systemrolle=master-part-II/testReport/40_mail/71_spaces_in_mail_address/ > master090/ fails due to the changes. OK: ucs-test (10.0.6-4) 0b84aaedc5ee | Bug #46080: fixed test 71_spaces_in_mail_address > REOPEN: what about documentation? > doc/manual/user-management-en.xml: <entry>Primary > e-mail address</entry> OK: 1e31e23c3102 | Bug #46080: adjust manual > doc/manual/windows-en.xml:synchronized. <emphasis>Primary e-mail > address</emphasis> and <emphasis>Telephone number</emphasis> are → not necessary, imho.
<https://errata.software-univention.de/#/?erratum=5.0x61> <https://errata.software-univention.de/#/?erratum=5.0x65>