Zimlet JavaScript API Reference - ZmMailApp

Class ZmMailApp


Extends ZmApp.

The mail app manages and displays mail messages. Messages may be grouped into conversations. New messages are created through a composer.

Defined in: ZmMailApp.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmMailApp(container, parentController)
Creates and initializes the mail application.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmMailApp.addForwardMenu(parent)
Adds a "Forward" submenu for forwarding inline or as attachment.
<static>  
ZmMailApp.addReplyMenu(parent)
Adds a "Reply" submenu for replying to sender or all.
 
compose(params)
Begins a compose session by presenting a form to the user.
 
Returns a compose controller.
 
getConvController(sessionId)
Returns a conversation controller.
 
getConvListController(sessionId, searchResultsController)
Returns a conversation list controller.
 
Adds a data source collection.
 
Gets the "group mail by" setting.
 
Gets the identity collection.
 
Gets the current mail list controller, which may be conversation list or msg list (traditional).
 
getMsgController(sessionId)
Gets the message controller.
 
Gets the signature collection.
 
getTradController(sessionId, searchResultsController)
Gets the traditional (msg list) controller.
 
mailSearch(query, callback, response, type)
Performs a mail search.
 
setNewMailNotice(organizer)
Sets the new mail notice.
 
showSearchResults(results, callback, searchResultsController)
Shows the search results.
Methods borrowed from class ZmApp:
activate, addDeferredFolder, createView, deleteSessionController, disposeTreeControllers, getDisplayName, getInitialSearchType, getLimit, getName, getNumSessionControllers, getOverview, getOverviewContainer, getOverviewId, getOverviewPanelContent, getRemoteFolderIds, getSearchParams, getSessionController, getTypeFromController, isActive, launch, popView, pushView, reset, resetOverview, resetWebClientOfflineOperations, setAppView, setOverviewPanelContent, setView, stageView, startAlert, stopAlert, toString
Class Detail
ZmMailApp(container, parentController)
Creates and initializes the mail application.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the container
{ZmController} parentController
the parent window controller (set by the child window)
Method Detail
<static> {ZmActionMenu} ZmMailApp.addForwardMenu(parent)
Adds a "Forward" submenu for forwarding inline or as attachment.
Parameters:
{ZmToolBar|ZmActionMenu} parent
the parent widget (a toolbar or action menu)
Returns:
{ZmActionMenu} the menu

<static> {ZmActionMenu} ZmMailApp.addReplyMenu(parent)
Adds a "Reply" submenu for replying to sender or all.
Parameters:
{ZmToolBar|ZmActionMenu} parent
the parent widget (a toolbar or action menu)
Returns:
{ZmActionMenu} the menu

compose(params)
Begins a compose session by presenting a form to the user.
Parameters:
{Hash} params
a hash of parameters
{constant} params.action
the new message, reply, forward, or an invite action
{Boolean} params.inNewWindow
if true, we are in detached window
{ZmMailMsg} params.msg
the original message (reply/forward), or address (new message)
{String} params.toOverride
the initial value for To: field
{String} params.subjOverride
the initial value for Subject: field
{String} params.extraBodyText
the canned text to prepend to body (invites)
{AjxCallback} params.callback
the callback to run after view has been set
{String} params.accountName
the on-behalf-of From address

{ZmComposeController} getComposeController(sessionId)
Returns a compose controller.
Parameters:
sessionId
Returns:
{ZmComposeController} compose controller

{ZmConvController} getConvController(sessionId)
Returns a conversation controller.
Parameters:
sessionId
Returns:
{ZmConvController} conversation controller

{ZmConvListController} getConvListController(sessionId, searchResultsController)
Returns a conversation list controller.
Parameters:
sessionId
searchResultsController
Returns:
{ZmConvListController} conversation list controller

{ZmDataSourceCollection} getDataSourceCollection(account)
Adds a data source collection.
Parameters:
{ZmAccount} account
the account
Returns:
{ZmDataSourceCollection} the data source collection

{String} getGroupMailBy()
Gets the "group mail by" setting. This is a convenience method to convert "group mail by" between server (string) and client (int constant) versions.
Returns:
{String} the group by mail setting

{ZmIdentityCollection} getIdentityCollection(account)
Gets the identity collection.
Parameters:
{ZmAccount} account
the account
Returns:
{ZmIdentityCollection} the identity collection

{ZmTradController|ZmConvListController} getMailListController()
Gets the current mail list controller, which may be conversation list or msg list (traditional).
Returns:
{ZmTradController|ZmConvListController} mail list controller

{ZmMsgController} getMsgController(sessionId)
Gets the message controller.
Parameters:
sessionId
Returns:
{ZmMsgController} message controller

{ZmSignatureCollection} getSignatureCollection(account)
Gets the signature collection.
Parameters:
{ZmAccount} account
the account
Returns:
{ZmSignatureCollection} the signature collection

{ZmTradController} getTradController(sessionId, searchResultsController)
Gets the traditional (msg list) controller.
Parameters:
sessionId
searchResultsController
Returns:
{ZmTradController} traditional controller

mailSearch(query, callback, response, type)
Performs a mail search.
Parameters:
{String} query
the query
{AjxCallback} callback
the callback
{Object} response
the response
{constant} type
the type

setNewMailNotice(organizer)
Sets the new mail notice.
Parameters:
{ZmOrganizer} organizer
the organizer

showSearchResults(results, callback, searchResultsController)
Shows the search results.
Parameters:
{Object} results
the results
{AjxCallback} callback
the callback
{ZmSearchResultsController} searchResultsController
owning controller

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