Zimlet JavaScript API Reference - ZmMailListController

Class ZmMailListController


Extends ZmListController.

This class encapsulates controller behavior that is common to lists of mail items. Operations such as replying and marking read/unread are supported.

Defined in: ZmMailListController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmMailListController(container, mailApp, type, sessionId, searchResultsController)
Creates a new, empty mail list controller.
Method Summary
Method Attributes Method Name and Description
 
getMsg(params)
Gets the selected message.
 
Checks if the reading pane is "on".
 
Checks if the reading pane is "on" right.
 
Sends the read receipt.
 
switchView(view, force)
Handles switching views based on action from view menu.
Methods borrowed from class ZmListController:
getCurrentSearchResults, getItemCount, getItems, getList, getListView, getSearchString, getSearchStringHint, getTabGroup, handleKeyAction, isDraftsFolder, isOutboxFolder, isSyncFailuresFolder, setHasMore, setList, show
Methods borrowed from class ZmBaseController:
getCurrentToolbar, getCurrentView, getItemView, isCurrent, setSessionId
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getViewElements, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType
Class Detail
ZmMailListController(container, mailApp, type, sessionId, searchResultsController)
Creates a new, empty mail list controller.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the containing shell
{ZmApp} mailApp
the containing application
{constant} type
type of controller
{string} sessionId
the session id
{ZmSearchResultsController} searchResultsController
containing controller
Method Detail
{ZmMailMsg|ZmConv} getMsg(params)
Gets the selected message.
Parameters:
{Hash} params
a hash of parameters
Returns:
{ZmMailMsg|ZmConv} the selected message

{Boolean} isReadingPaneOn()
Checks if the reading pane is "on".
Returns:
{Boolean} true if the reading pane is "on"

{Boolean} isReadingPaneOnRight()
Checks if the reading pane is "on" right.
Returns:
{Boolean} true if the reading pane is "on" right.

sendReadReceipt(msg)
Sends the read receipt.
Parameters:
{ZmMailMsg} msg
the message

switchView(view, force)
Handles switching views based on action from view menu.
Parameters:
{constant} view
the id of the new view
{Boolean} force
if true, always redraw view

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:35 GMT-0400 (EDT)