modules
[ class tree: modules ] [ index: modules ] [ all elements ]

Class: imapAccess

Source Location: /lib/modules/imapAccess.inc

Class Overview

baseModule
   |
   --imapAccess

Manages mailboxes on an IMAP server.


Author(s):

  • Pavel Pozdniak
  • Roland Gruber

Methods


Inherited Variables

Inherited Methods

Class: baseModule

baseModule::__construct()
Creates a new base module class
baseModule::build_uploadAccounts()
In this function the LDAP accounts are built.
baseModule::can_manage()
Returns true if this module can manage accounts of the current type, otherwise false.
baseModule::checkSelfServiceOptions()
Checks if all input values are correct and returns the LDAP attributes which should be changed.
baseModule::checkSelfServiceSettings()
Checks if the self service settings are valid.
baseModule::check_configOptions()
Checks input values of module settings.
baseModule::check_profileOptions()
Checks input values of account profiles.
baseModule::delete_attributes()
This function returns an array with the same syntax as save_attributes().
baseModule::displaySpecialSelfServicePage()
This function creates meta HTML code to display the module specific page for the self service.
baseModule::display_html_attributes()
This function creates meta HTML code to display the module page.
baseModule::display_html_delete()
This function creates meta HTML code which will be displayed when an account should be deleted.
baseModule::doUploadPostActions()
This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
baseModule::getAccountContainer()
Returns the accountContainer object.
baseModule::getAttributes()
Returns the LDAP attributes which are managed in this module.
baseModule::getButtonStatus()
Controls if the module button the account page is visible and activated.
baseModule::getIcon()
Returns the path to the module icon.
baseModule::getLDAPAliases()
Returns a list of aliases for LDAP attributes.
baseModule::getLinkToSpecialSelfServicePage()
This allows modules to create a link to a module specific page for the self service.
baseModule::getManagedAttributes()
Returns a list of LDAP attributes which are managed by this module.
baseModule::getManagedObjectClasses()
Returns a list of managed object classes for this module.
baseModule::getOriginalAttributes()
Returns the LDAP attributes which are managed in this module (with unchanged values).
baseModule::getRequiredExtensions()
This function returns a list of PHP extensions (e.g. hash) which are needed by this module.
baseModule::getSelfServiceFields()
Returns a list of possible input fields and their descriptions.
baseModule::getSelfServiceOptions()
Returns the meta HTML code for each input field.
baseModule::getSelfServiceSearchAttributes()
This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
baseModule::getSelfServiceSettings()
Returns a list of self service configuration settings.
baseModule::get_alias()
Returns an alias name for the module.
baseModule::get_configOptions()
Returns a list of configuration options.
baseModule::get_dependencies()
This function returns a list with all depending and conflicting modules.
baseModule::get_help()
This function returns the help entry array for a specific help id.
baseModule::get_ldap_filter()
Returns an LDAP filter for the account lists
baseModule::get_metaData()
This function provides meta data which is interpreted by baseModule.
baseModule::get_pdfEntries()
Returns the PDF entries for this module.
baseModule::get_pdfFields()
Returns a hashtable with all entries that may be printed out in the PDF.
baseModule::get_profileOptions()
This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
baseModule::get_RDNAttributes()
Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
baseModule::get_scope()
Returns the account type of this module (user, group, host)
baseModule::get_uploadColumns()
Returns an array containing all input columns for the file upload.
baseModule::get_uploadPreDepends()
Returns a list of module names which must be processed in building the account befor this module.
baseModule::init()
Initializes the module after it became part of an accountContainer
baseModule::isBooleanConfigOptionSet()
Returns if the given configuration option is set.
baseModule::is_base_module()
Returns true if your module is a base module and otherwise false.
baseModule::load_attributes()
This function loads the LDAP attributes when an account should be loaded.
baseModule::load_Messages()
This function fills the $messages variable with output messages from this module.
baseModule::load_profile()
This function loads the values from an account profile to the module's internal data structures.
baseModule::module_complete()
This function is used to check if all settings for this module have been made.
baseModule::module_ready()
This function is used to check if this module page can be displayed.
baseModule::postDeleteActions()
Allows the module to run commands after the LDAP entry is deleted.
baseModule::postModifyActions()
Allows the module to run commands after the LDAP entry is changed or created.
baseModule::postModifySelfService()
Allows the module to run commands after the LDAP entry is changed or created.
baseModule::preDeleteActions()
Allows the module to run commands before the LDAP entry is deleted.
baseModule::preModifyActions()
Allows the module to run commands before the LDAP entry is changed or created.
baseModule::preModifySelfService()
Allows the module to run commands before the LDAP entry is changed or created.
baseModule::process_attributes()
This function processes user input.
baseModule::save_attributes()
Returns a list of modifications which have to be made to the LDAP account.

Class Details

[line 39]
Manages mailboxes on an IMAP server.



Tags:

author:  Pavel Pozdniak
author:  Roland Gruber


[ Top ]


Class Methods


method display_html_attributes [line 170]

array display_html_attributes( )

Returns the HTML meta data for the main account page.



Tags:

return:  HTML meta data


Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

[ Top ]

method display_html_password [line 255]

array display_html_password( )

Returns the HTML meta data for the password page.



Tags:

return:  HTML meta data


[ Top ]

method doLogin [line 456]

array doLogin( )

Checks the password given by user and save it as session parameter.



Tags:

return:  list of error messages


[ Top ]

method getAdminPassword [line 438]

String getAdminPassword( )

Returns the admin password.



Tags:

return:  password


[ Top ]

method getMailboxPrefix [line 512]

String getMailboxPrefix( )

This function returns the prefix for mailboxes.

If no prefix was given during configuration then "user" will be used (default for Cyrus).




Tags:

return:  prefix


[ Top ]

method getServerAddress [line 481]

String getServerAddress( )

This function returns the IMAP server address including encryption options.



Tags:

return:  server address


[ Top ]

method get_metaData [line 50]

array get_metaData( )

Returns meta data that is interpreted by parent class



Tags:

return:  array with meta data
see:  baseModule::get_metaData()


Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

[ Top ]

method isWrongDomain [line 527]

boolean isWrongDomain( $email_domain)

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.




Tags:

return:  true if domains match


Parameters:

   $email_domain  

[ Top ]

method load_Messages [line 151]

void load_Messages( )

This function fills the error message array with messages



Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

[ Top ]

method load_profile [line 425]

void load_profile( array $profile)

Loads the values of an account profile into internal variables.



Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

Parameters:

array   $profile   hash array with profile values (identifier => value)

[ Top ]

method process_attributes [line 316]

array process_attributes( )

Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




Tags:

return:  list of info/error messages


Overrides baseModule::process_attributes() (This function processes user input.)

[ Top ]

method renderQuotasForMailbox [line 280]

htmlTable renderQuotasForMailbox( htmlTable $htmlTable, stream $mbox, $username)

Display the mailbox quota.



Tags:

return:  table with added information about user quotas or controls to add quota


Parameters:

htmlTable   $htmlTable   structure that contained information to be displayed
stream   $mbox   stream to open IMAP session
   $username  

[ Top ]


Documentation generated on Tue, 22 Nov 2011 16:29:51 +0100 by phpDocumentor 1.4.1