Zimlet JavaScript API Reference - ZmImapAccount

Class ZmImapAccount


Extends ZmDataSource.

This class represents an IMAP account.

Defined in: ZmImapAccount.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an IMAP account.
Field Summary
Field Attributes Field Name and Description
<static>  
ZmImapAccount.PORT_CLEAR
Defines the "cleartext" port.
<static>  
ZmImapAccount.PORT_SSL
Defines the "ssl" port.
Method Summary
Method Attributes Method Name and Description
 
Gets the default port.
<static>  
ZmImapAccount.sortCompare(folderA, folderB)
Comparison function for *IMAP* folders.
Methods borrowed from class ZmDataSource:
getPort, setEmail, testConnection
Methods borrowed from class ZmAccount:
getEmail, getIdentity, getName, setName, toString
Class Detail
ZmImapAccount(id)
Creates an IMAP account.
Parameters:
{String} id
the id
Field Detail
<static> {int} ZmImapAccount.PORT_CLEAR
Defines the "cleartext" port.

<static> {int} ZmImapAccount.PORT_SSL
Defines the "ssl" port.
Method Detail
{int} getDefaultPort()
Gets the default port.
Returns:
{int} the port

<static> {int} ZmImapAccount.sortCompare(folderA, folderB)
Comparison function for *IMAP* folders. Since IMAP folderId's are *not* well- known, we have to compare their names instead of their ID's.
Parameters:
{ZmFolder} folderA
{ZmFolder} folderB
Returns:
{int} 0 if the folders are the same; 1 if "a" is before "b"; -1 if "b" is before "a"

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