Class ZmFolder
Class Detail
ZmFolder(params)
Creates a folder.
Author: Conrad Damon.
Method Detail
<static>
{String}
ZmFolder.checkName(name, parent)
Checks a folder name for validity. Note: that a name, rather than a path, is checked.
{String}
createQuery(pathOnly)
Creates a query.
{String}
getIcon()
Gets the icon.
<static>
{String}
ZmFolder.getIdForName(folderName)
Gets the "well-known" ID for a given folder name.
{String}
getName(showUnread, maxLength, noMarkup, useSystemName)
Gets the name.
{Boolean}
hasFeeds()
Checks folders recursively for feeds.
{Boolean}
hasSearch(id)
Checks if the folder has search.
{Boolean}
isHardDelete()
Checks if this folder required hard delete.
{Boolean}
isInSpam()
Checks if this folder is in spam folder.
isOutbound()
Returns true if this folder is for outbound mail.
mayContain(what, folderType, ignoreExisting)
Returns true if the given object(s) may be placed in this folder.
If the object is a folder, check that:
move(newParent, noUndo, actionText, batchCmd)
Moves a folder. A user can move a folder to "Trash" even if there is already a folder in "Trash" with the
same name. A new name will be generated for this folder and a rename is performed before the move.
notifyCreate(obj, elementType, skipNotify)
Handles the creation of a folder or search folder. This folder is the parent
of the newly created folder. A folder may hold a folder or search folder,
and a search folder may hold another search folder.
notifyModify(obj)
Provide some extra info in the change event about the former state
of the folder. Note that we null out the field after setting up the
change event, so the notification isn't also sent when the parent
class's method is called.
<static>
{int}
ZmFolder.sortCompare(folderA, folderB, nonMail)
Comparison function for folders. Intended for use on a list of user folders
through a call to
Array.sort() .
<static>
{int}
ZmFolder.sortComparePath(folderA, folderB)
Compares the folders by path.
{Boolean}
supportsPublicAccess()
Checks if the folder supports public access. Override this method if you dont want a folder to be accessed publicly
toggleSyncOffline(syncIt, callback, errorCallback)
Sends
<FolderActionRequest> to turn sync'ing on/off for IMAP folders. Currently,
this is only used by Offline/ZDesktop client
|
||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:38 GMT-0400 (EDT)
|