Manages mailboxes on an IMAP server. It implements the complete module interface and uses meta-data
provided by the account modules for its functions.
Location and naming of modules
All LAM modules are placed in lib/modules/ and are named ".inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.
You can avoid to override many functions by using {@link get_metaData()}.
All module classes should extend the baseModule class.
Returns the HTML meta data for the main account page.
Return value
Type
Description
array
HTML meta data
display_html_password(
)
:
array
Description
Returns the HTML meta data for the password page.
Return value
Type
Description
array
HTML meta data
doLogin(
)
:
array
Description
Checks the password given by user and save it as session parameter.
Return value
Type
Description
array
list of error messages
getAdminPassword(
)
:
String
Description
Returns the admin password.
Return value
Type
Description
String
password
getMailboxPrefix(
)
:
String
Description
This function returns the prefix for mailboxes. If no prefix was given during configuration then "user" will be used (default for Cyrus).
Return value
Type
Description
String
prefix
getSep(
)
:
String
Description
Returns the path separator.
Return value
Type
Description
String
separator char
getServerAddress(
)
:
String
Description
This function returns the IMAP server address including encryption options.
Return value
Type
Description
String
server address
get_metaData(
)
:
array
Description
Returns meta data that is interpreted by parent class
Return value
Type
Description
array
array with meta data
Tags
Name
Description
see
isWrongDomain(
String
$email_domain,
)
:
boolean
Description
This function checks if the domain of the mailbox is not in the list of domains listed in the configuration. If it is in the list then it returns false, otherwise returns true. If the list of domains is not set then it returns true.
Arguments
Name
Type
Description
Default
$email_domain
String
email domain
Return value
Type
Description
boolean
true if domains match
load_Messages(
)
:
n/a
Description
This function fills the error message array with messages
Return value
Type
Description
n/a
n/a
load_profile(
array
$profile,
)
:
n/a
Description
Loads the values of an account profile into internal variables.
Arguments
Name
Type
Description
Default
$profile
array
hash array with profile values (identifier => value)
Return value
Type
Description
n/a
n/a
process_attributes(
)
:
array
Description
Processes user input of the primary module page. It checks if all input values are correct and updates the associated LDAP attributes.