Public Member Functions | Public Attributes

nsIImapFlagAndUidState Interface Reference

import "nsIImapFlagAndUidState.idl";

List of all members.

Public Member Functions

void orSupportedUserFlags (in unsigned short aFlags)
 OR's the passed in flags with the previous flags because we want to accumulate the FLAGS and PERMANENTFLAGS response.
void getUidOfMessage (in long zeroBasedIndex, out unsigned long result)
void getMessageFlags (in long zeroBasedIndex, out unsigned short result)
void setMessageFlags (in long zeroBasedIndex, in unsigned short flags)
void expungeByIndex (in unsigned long zeroBasedIndex)
void addUidFlagPair (in unsigned long uid, in unsigned short flags, in unsigned long zeroBasedIndex)
void addUidCustomFlagPair (in unsigned long uid, in string customFlag)
string getCustomFlags (in unsigned long uid)
void reset ()
void clearCustomFlags (in unsigned long uid)

Public Attributes

readonly attribute long numberOfMessages
readonly attribute long numberOfRecentMessages
readonly attribute long numberOfDeletedMessages
 If a full update, the total number of deleted messages in the folder; if a partial update, the number of deleted messages in the partial update.
readonly attribute boolean partialUIDFetch
 If this is true, instead of fetching 1:* (FLAGS), and putting all UIDs and flags in the array, we only fetched the uids and flags that changed since the last time we were selected on this folder.
readonly attribute unsigned short supportedUserFlags
 Set of flags the server supports storing per message.

Member Function Documentation

void nsIImapFlagAndUidState::addUidCustomFlagPair ( in unsigned long  uid,
in string  customFlag 
)
void nsIImapFlagAndUidState::addUidFlagPair ( in unsigned long  uid,
in unsigned short  flags,
in unsigned long  zeroBasedIndex 
)
void nsIImapFlagAndUidState::clearCustomFlags ( in unsigned long  uid  ) 
void nsIImapFlagAndUidState::expungeByIndex ( in unsigned long  zeroBasedIndex  ) 
string nsIImapFlagAndUidState::getCustomFlags ( in unsigned long  uid  ) 
void nsIImapFlagAndUidState::getMessageFlags ( in long  zeroBasedIndex,
out unsigned short  result 
)
void nsIImapFlagAndUidState::getUidOfMessage ( in long  zeroBasedIndex,
out unsigned long  result 
)
void nsIImapFlagAndUidState::orSupportedUserFlags ( in unsigned short  aFlags  ) 

OR's the passed in flags with the previous flags because we want to accumulate the FLAGS and PERMANENTFLAGS response.

Parameters:
aFlags - flags to OR with current flags.
void nsIImapFlagAndUidState::reset (  ) 
void nsIImapFlagAndUidState::setMessageFlags ( in long  zeroBasedIndex,
in unsigned short  flags 
)

Member Data Documentation

If a full update, the total number of deleted messages in the folder; if a partial update, the number of deleted messages in the partial update.

If this is true, instead of fetching 1:* (FLAGS), and putting all UIDs and flags in the array, we only fetched the uids and flags that changed since the last time we were selected on this folder.

This means we have a sparse array, and should not assume missing UIDs have been deleted.

readonly attribute unsigned short nsIImapFlagAndUidState::supportedUserFlags

Set of flags the server supports storing per message.

See nsImapCore.h for the set of flags.


The documentation for this interface was generated from the following file: