Zimlet JavaScript API Reference - ZmMailList

Class ZmMailList


This class represents a list of mail items (conversations, messages, or attachments). We retain a handle to the search that generated the list for two reasons: so that we can redo the search if necessary, and so that we can get the folder ID if this list represents folder contents.

Defined in: ZmMailList.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmMailList(type, search)
Creates an empty list of mail items.
Method Summary
Method Attributes Method Name and Description
 
addMsgs(msgs)
Convenience method for adding messages to a conv on the fly.
 
getFirstHit(offset, limit, A)
Gets the first msg in the list that's not in one of the given folders (if any).
Class Detail
ZmMailList(type, search)
Creates an empty list of mail items.
Author: Conrad Damon.
Parameters:
type
type of mail item (see ZmItem for constants)
search
the search that generated this list
Method Detail
addMsgs(msgs)
Convenience method for adding messages to a conv on the fly. The specific use case for this is when a virtual conv becomes real. We basically add the new message(s) to the old (virtual) conv's message list.
Parameters:
msgs
hash of messages to add

{ZmMailMsg} getFirstHit(offset, limit, A)
Gets the first msg in the list that's not in one of the given folders (if any).
Parameters:
{int} offset
the starting point within list
{int} limit
the ending point within list
{foldersToOmit} A
hash of folders to omit
Returns:
{ZmMailMsg} the message

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