the-djmaze/snappymail
1
1
Fork 0
mirror of https://github.com/the-djmaze/snappymail.git synced 2025-01-31 19:19:00 +08:00
Code Issues Projects Releases Packages Wiki Activity

better description of config parameters

Browse source
This commit is contained in:
cm-schl 2022-11-25 11:41:31 +01:00
parent fa4bb8ae18
commit 73faa02795
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
plugins/ldap-mail-accounts/index.php
View file

@ -15,10 +15,10 @@ class LdapMailAccountsPlugin extends AbstractPlugin
VERSION = '1.0', VERSION = '1.0',
AUTHOR = 'cm-schl', AUTHOR = 'cm-schl',
URL = 'https://github.com/cm-sch', URL = 'https://github.com/cm-sch',
RELEASE = '2022-11-11', RELEASE = '2022-11-25',
REQUIRED = '2.20.0', REQUIRED = '2.20.0',
CATEGORY = 'Accounts', CATEGORY = 'Accounts',
DESCRIPTION = 'Adds functionality to import mail accounts from LDAP. Basing on the work of FWest98 (https://github.com/FWest98).'; DESCRIPTION = 'Add additional mail accounts the SnappyMail user has access to by a LDAP query. Basing on the work of FWest98 (https://github.com/FWest98).';
public function __construct() public function __construct()
{ {
@ -59,29 +59,30 @@ class LdapMailAccountsPlugin extends AbstractPlugin
->SetDefaultValue([2, 3]), ->SetDefaultValue([2, 3]),
Property::NewInstance(LdapConfig::CONFIG_BIND_USER) Property::NewInstance(LdapConfig::CONFIG_BIND_USER)
->SetLabel("Bind User DN") ->SetLabel("LDAP Username")
->SetDescription("The user to use for binding to the LDAP server. Should be a DN or RDN. Leave empty for anonymous bind.") ->SetDescription("The user to use for binding to the LDAP server. Should be a DN or RDN. Leave empty for anonymous bind.")
->SetType(PluginPropertyType::STRING), ->SetType(PluginPropertyType::STRING),
Property::NewInstance(LdapConfig::CONFIG_BIND_PASSWORD) Property::NewInstance(LdapConfig::CONFIG_BIND_PASSWORD)
->SetLabel("Bind User Password") ->SetLabel("LDAP Password")
->SetDescription("Leave empty for anonymous bind.") ->SetDescription("Leave empty for anonymous bind.")
->SetType(PluginPropertyType::PASSWORD), ->SetType(PluginPropertyType::PASSWORD),
Property::NewInstance(LdapConfig::CONFIG_OBJECTCLASS) Property::NewInstance(LdapConfig::CONFIG_OBJECTCLASS)
->SetLabel("Object class") ->SetLabel("Object class")
->SetType(PluginPropertyType::STRING) ->SetType(PluginPropertyType::STRING)
->SetDescription("The object class to use when searching for additional mail accounts of the logged in SnappyMail user")
->SetDefaultValue("user"), ->SetDefaultValue("user"),
Property::NewInstance(LdapConfig::CONFIG_BASE) Property::NewInstance(LdapConfig::CONFIG_BASE)
->SetLabel("User base DN") ->SetLabel("Base DN")
->SetType(PluginPropertyType::STRING) ->SetType(PluginPropertyType::STRING)
->SetDescription("The base DN to search in for users."), ->SetDescription("The base DN to search in for additional mail accounts of the logged in SnappyMail user"),
Property::NewInstance(LdapConfig::CONFIG_FIELD_SEARCH) Property::NewInstance(LdapConfig::CONFIG_FIELD_SEARCH)
->SetLabel("Search field") ->SetLabel("Search field")
->SetType(PluginPropertyType::STRING) ->SetType(PluginPropertyType::STRING)
->SetDescription("The name of the ldap attribute that has to contain the set 'LDAP search string'.") ->SetDescription("The name of the ldap attribute that has to contain the here defined 'LDAP search string'.")
->SetDefaultValue("member"), ->SetDefaultValue("member"),
Property::NewInstance(LdapConfig::CONFIG_SEARCH_STRING) Property::NewInstance(LdapConfig::CONFIG_SEARCH_STRING)
@ -89,20 +90,23 @@ class LdapMailAccountsPlugin extends AbstractPlugin
->SetType(PluginPropertyType::STRING) ->SetType(PluginPropertyType::STRING)
->SetDescription("The search string used to find ldap objects of mail accounts the user has access to. ->SetDescription("The search string used to find ldap objects of mail accounts the user has access to.
\nPossible placeholers:\n#USERNAME# - replaced with the username of the actual SnappyMail user \nPossible placeholers:\n#USERNAME# - replaced with the username of the actual SnappyMail user
\n#BASE_DN# - replaced with the value inside the field 'User base DN'."), \n#BASE_DN# - replaced with the value inside the field 'User base DN'.")
->SetDefaultValue("uid=#USERNAME#"),
Property::NewInstance(LdapConfig::CONFIG_FIELD_USERNAME) Property::NewInstance(LdapConfig::CONFIG_FIELD_USERNAME)
->SetLabel("Username field of additional account") ->SetLabel("Username field of additional account")
->SetType(PluginPropertyType::STRING) ->SetType(PluginPropertyType::STRING)
->SetDescription("The field containing the username of the found additional mail account. ->SetDescription("The field containing the username of the found additional mail account.
\nThis username gets used by SnappyMail to login to the additional mail account.") \nThis username gets used by SnappyMail to login to the additional mail account.
\nIf this field contains an email address, only the local-part before the @ is used.")
->SetDefaultValue("uid"), ->SetDefaultValue("uid"),
Property::NewInstance(LdapConfig::CONFIG_FIELD_MAIL_DOMAIN) Property::NewInstance(LdapConfig::CONFIG_FIELD_MAIL_DOMAIN)
->SetLabel("Domain name field of additional account") ->SetLabel("Domain name field of additional account")
->SetType(PluginPropertyType::STRING) ->SetType(PluginPropertyType::STRING)
->SetDescription("The field containing the domain name of the found additional mail account. ->SetDescription("The field containing the domain name of the found additional mail account.
\nThis domain gets looked up by SnappyMail to choose the right connection parameters at logging in to the additional mail account.") \nThis domain gets looked up by SnappyMail to choose the right connection parameters at logging in to the additional mail account.
\nIf this field contains an email address, only the domain-part after the @ is used.")
->SetDefaultValue("mail"), ->SetDefaultValue("mail"),
Property::NewInstance(LdapConfig::CONFIG_FIELD_NAME) Property::NewInstance(LdapConfig::CONFIG_FIELD_NAME)