Zimlet JavaScript API Reference - ZmMailItem

Class ZmMailItem


Extends ZmItem.

This class represents a mail item, which may be a conversation or a mail message.

Defined in: ZmMailItem.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmMailItem(type, id, list, noCache)
Creates a mail item.
Method Summary
Method Attributes Method Name and Description
 
Clears this item.
 
Gets the email addresses of the participants.
 
Gets the mute/unmute icon.
 
Gets the read/unread icon.
 
Checks if this item is in Junk or Trash and the user is not including those in search results.
Methods borrowed from class ZmItem:
cache, canAddTag, create, deleteLocal, flagLocal, getById, getDefaultDndAction, getFolderId, getRestUrl, getTagImageFromIds, getTagImageInfo, hasTag, isReadOnly, isShared, modify, move, moveLocal, removeAllTagsLocal, rename, setFlag, tagLocal
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmMailItem(type, id, list, noCache)
Creates a mail item.
Parameters:
{constant} type
the type of object (conv or msg)
{int} id
the unique ID
{ZmMailList} list
the list that contains this mail item
{Boolean} noCache
if true, do not cache this item
Method Detail
clear()
Clears this item.

{Array} getEmails()
Gets the email addresses of the participants.
Returns:
{Array} an array of email addresses

{String} getMuteIcon()
Gets the mute/unmute icon.
Returns:
{String} the icon

{String} getReadIcon()
Gets the read/unread icon.
Returns:
{String} the icon

{Boolean} ignoreJunkTrash()
Checks if this item is in Junk or Trash and the user is not including those in search results.
Returns:
{Boolean} true if this item is in the Junk or Trash folder

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