Zimlet JavaScript API Reference - ZmAccount

Class ZmAccount


This class represents an account.

Defined in: ZmAccount.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmAccount(type, id, name)
Creates the account.
Field Summary
Field Attributes Field Name and Description
<static>  
ZmAccount.TYPE_AOL
Defines the "AOL" account type.
<static>  
ZmAccount.TYPE_CALDAV
Defines the "Zimbra" account type.
<static>  
ZmAccount.TYPE_EXCHANGE
Defines the "Microsoft Exchange Mobile Sync" account type.
<static>  
ZmAccount.TYPE_GMAIL
Defines the "Gmail" account type.
<static>  
ZmAccount.TYPE_IMAP
Defines the "IMAP" account type.
<static>  
ZmAccount.TYPE_LIVE
Defines the "Microsoft Live" or "Hotmail" account type.
<static>  
ZmAccount.TYPE_MSE
Defines the "Microsoft Exchange IMAP" account type.
<static>  
ZmAccount.TYPE_PERSONA
Defines the "persona" account type.
<static>  
ZmAccount.TYPE_POP
Defines the "POP" account type.
<static>  
ZmAccount.TYPE_YMP
Defines the "Y! Mail" account type.
<static>  
ZmAccount.TYPE_ZIMBRA
Defines the "Zimbra" account type.
Method Summary
Method Attributes Method Name and Description
 
Gets the email address for this account.
 
Gets the identity for this account.
 
Gets the name of the account.
<static>  
ZmAccount.getTypeName(type)
Gets the name of the specified type.
 
setEmail(email)
Sets the email address for this account.
 
setName(name)
Sets the name of the account.
 
Returns a string representation of the object.
Class Detail
ZmAccount(type, id, name)
Creates the account.
Parameters:
{constant} type
the account type (see ZmAccount.TYPE_ constants)
{String} id
the account id
{String} name
the account name
See:
ZmAccount
Field Detail
<static> ZmAccount.TYPE_AOL
Defines the "AOL" account type.

<static> ZmAccount.TYPE_CALDAV
Defines the "Zimbra" account type.

<static> ZmAccount.TYPE_EXCHANGE
Defines the "Microsoft Exchange Mobile Sync" account type.

<static> ZmAccount.TYPE_GMAIL
Defines the "Gmail" account type.

<static> ZmAccount.TYPE_IMAP
Defines the "IMAP" account type.

<static> ZmAccount.TYPE_LIVE
Defines the "Microsoft Live" or "Hotmail" account type.

<static> ZmAccount.TYPE_MSE
Defines the "Microsoft Exchange IMAP" account type.

<static> ZmAccount.TYPE_PERSONA
Defines the "persona" account type.

<static> ZmAccount.TYPE_POP
Defines the "POP" account type.

<static> ZmAccount.TYPE_YMP
Defines the "Y! Mail" account type.

<static> ZmAccount.TYPE_ZIMBRA
Defines the "Zimbra" account type.
Method Detail
{String} getEmail()
Gets the email address for this account. Subclasses should override this method.
Returns:
{String} the email address

{String} getIdentity()
Gets the identity for this account. Subclasses should override this method.
Returns:
{String} the identity

{String} getName()
Gets the name of the account.
Returns:
{String} the account name

<static> {String} ZmAccount.getTypeName(type)
Gets the name of the specified type.
Parameters:
{constant} type
the type (see ZmAccount.TYPE_ constants)
Returns:
{String} the name or unknown
See:
ZmAccount

setEmail(email)
Sets the email address for this account. Subclasses should override this method.
Parameters:
{String} email
the email address

setName(name)
Sets the name of the account.
Parameters:
{String} name
the account name

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

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