PHP Class MailboxController

Inheritance: extends AppController
ファイルを表示 Open project: opensolutions/vimbadmin

Public Methods

Method Description
addAction ( ) Add a mailbox.
ajaxToggleActiveAction ( ) Toggles the active property of the current mailbox. Prints 'ok' on success or 'ko' otherwise to stdout.
aliasesAction ( ) Lists the aliases of a mailbox, except the default alias (where address == goto).
cliDeletePendingAction ( )
cliGetSizesAction ( )
deleteAliasAction ( ) Deletes a mailbox alias. Prints 'ok' on success or 'ko' otherwise to stdout.
editAction ( ) Edit a mailbox.
emailSettingsAction ( )
getMailboxForm ( ) : ViMbAdmin_Form_Mailbox_AddEdit Instantiate / get the mailbox add-edit form
indexAction ( ) Jumps to list action.
listAction ( ) Lists all mailboxes available to the admin (superadmin sees all) or to the specified domain.
listSearchAction ( )
passwordAction ( ) Action FOR ADMINS AND SUPERADMINS to change the password of a mailbox.
preDispatch ( ) Most actions in this object will require a domain object to edit / act on.
purgeAction ( ) Purges a mailbox from the system, with all the related entries in other tables.

Private Methods

Method Description
_sendSettingsEmail ( boolean $cc = false, string $password = '', boolean $isWelcome = false, $email = false ) : boolean Sends email with settings

Method Details

addAction() public method

Add a mailbox.
public addAction ( )

ajaxToggleActiveAction() public method

Toggles the active property of the current mailbox. Prints 'ok' on success or 'ko' otherwise to stdout.

aliasesAction() public method

Lists the aliases of a mailbox, except the default alias (where address == goto).
public aliasesAction ( )

cliDeletePendingAction() public method

cliGetSizesAction() public method

public cliGetSizesAction ( )

deleteAliasAction() public method

Deletes a mailbox alias. Prints 'ok' on success or 'ko' otherwise to stdout.
public deleteAliasAction ( )

editAction() public method

Edit a mailbox.
public editAction ( )

emailSettingsAction() public method

public emailSettingsAction ( )

getMailboxForm() public method

Instantiate / get the mailbox add-edit form
public getMailboxForm ( ) : ViMbAdmin_Form_Mailbox_AddEdit
return ViMbAdmin_Form_Mailbox_AddEdit

indexAction() public method

Jumps to list action.
public indexAction ( )

listAction() public method

$this->view->mailbox_actions allow to append mailbox list action buttons. %id% will be replaced by mailbox id form the list. below is example array which creates edit mailbox button, and another button with drop down options for purge or edit mailbox. Only one drop down button can be defined per button group, and it always be appended at the end. $actions = [ [ //Simple link button 'tagName' => 'a', //Mandatory parameter for element type. 'href' => OSS_Utils::genUrl( "mailbox", "edit" ) . "/mid/%id%", //Url for action 'title' => "Edit", 'class' => "btn btn-mini have-tooltip", //Class for css options. 'id' => "test-%id%", //If setting id id must have %id% which will be replaced by original mailbox id to avoid same ids. 'child' => [ //Mandatory element if is not array it will be shown as text. 'tagName' => "i", //Mandatory option if child is array to define element type 'class' => "icon-pencil" //Icon class ], ], [ //Drop down button 'tagName' => 'span', //Mandatory parameter for element type 'title' => "Settings", 'class' => "btn btn-mini have-tooltip dropdown-toggle", //Class dropdown-toggle is mandatory for drop down button 'data-toggle' => "dropdown", //data-toggle attribute is mandatory for drop down button 'id' => "cog-%id%", 'style' => "max-height: 15px;", 'child' => [ 'tagName' => "i", 'class' => "icon-cog" ], 'menu' => [ //menu array is mandatory then defining drop down button [ 'id' => "menu-edit-%id%", //Not mandatory attribute but if is set %id% should be use to avoid same ids. 'text' => " Edit", //Mandatory for display action text 'url' => OSS_Utils::genUrl( "mailbox", "edit" ) . "/mid/%id%" //Mandatory to redirect the action. ], [ 'text' => " Purge", 'url' => OSS_Utils::genUrl( "mailbox", "purge" ) . "/mid/%id%" ], ] ] ];
public listAction ( )

listSearchAction() public method

public listSearchAction ( )

passwordAction() public method

Action FOR ADMINS AND SUPERADMINS to change the password of a mailbox.
public passwordAction ( )

preDispatch() public method

This method will look for an 'id' parameter and, if set, will try to load the domain model and authorise the user to edit / act on it.
See also: Zend_Controller_Action::preDispatch()
public preDispatch ( )

purgeAction() public method

Purges a mailbox from the system, with all the related entries in other tables.
public purgeAction ( )