Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIMsgDatabase Interface Reference

import "nsIMsgDatabase.idl";

Inheritance diagram for nsIMsgDatabase:
Inheritance graph
[legend]
Collaboration diagram for nsIMsgDatabase:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void Open (in nsIFileSpec aFolderName, in boolean aCreate, in boolean aLeaveInvalidDB)
void forceFolderDBClosed (in nsIMsgFolder aFolder)
void Close (in boolean aForceCommit)
void Commit (in nsMsgDBCommit commitType)
void ForceClosed ()
void clearCachedHdrs ()
void resetHdrCacheSize (in unsigned long size)
nsIMsgDBHdr GetMsgHdrForKey (in nsMsgKey key)
nsIMsgDBHdr getMsgHdrForMessageID (in string messageID)
boolean ContainsKey (in nsMsgKey key)
nsIMsgDBHdr CreateNewHdr (in nsMsgKey key)
void AddNewHdrToDB (in nsIMsgDBHdr newHdr, in boolean notify)
nsIMsgDBHdr CopyHdrFromExistingHdr (in nsMsgKey key, in nsIMsgDBHdr existingHdr, in boolean addHdrToDB)
void ListAllKeys (in nsMsgKeyArrayRef outputKeys)
nsISimpleEnumerator EnumerateMessages ()
nsISimpleEnumerator EnumerateThreads ()
void syncCounts ()
nsIMsgThread GetThreadContainingMsgHdr (in nsIMsgDBHdr msgHdr)
void MarkHdrRead (in nsIMsgDBHdr msgHdr, in boolean bRead, in nsIDBChangeListener instigator)
void MarkHdrReplied (in nsIMsgDBHdr msgHdr, in boolean bReplied, in nsIDBChangeListener instigator)
void MarkHdrMarked (in nsIMsgDBHdr msgHdr, in boolean mark, in nsIDBChangeListener instigator)
void MarkMDNNeeded (in nsMsgKey key, in boolean bNeeded, in nsIDBChangeListener instigator)
boolean IsMDNNeeded (in nsMsgKey key)
void MarkMDNSent (in nsMsgKey key, in boolean bNeeded, in nsIDBChangeListener instigator)
boolean IsMDNSent (in nsMsgKey key)
void MarkRead (in nsMsgKey key, in boolean bRead, in nsIDBChangeListener instigator)
void MarkReplied (in nsMsgKey key, in boolean bReplied, in nsIDBChangeListener instigator)
void MarkForwarded (in nsMsgKey key, in boolean bForwarded, in nsIDBChangeListener instigator)
void MarkHasAttachments (in nsMsgKey key, in boolean bHasAttachments, in nsIDBChangeListener instigator)
void MarkThreadRead (in nsIMsgThread thread, in nsIDBChangeListener instigator, in nsMsgKeyArrayPtr thoseMarked)
void MarkThreadIgnored (in nsIMsgThread thread, in nsMsgKey threadKey, in boolean bIgnored, in nsIDBChangeListener instigator)
void MarkThreadWatched (in nsIMsgThread thread, in nsMsgKey threadKey, in boolean bWatched, in nsIDBChangeListener instigator)
boolean IsRead (in nsMsgKey key)
boolean IsIgnored (in nsMsgKey key)
boolean IsMarked (in nsMsgKey key)
boolean HasAttachments (in nsMsgKey key)
void MarkAllRead (in nsMsgKeyArrayPtr thoseMarked)
void MarkReadByDate (in PRTime startDate, in PRTime endDate, in nsMsgKeyArrayPtr markedIds)
void DeleteMessages (in nsMsgKeyArrayPtr nsMsgKeys, in nsIDBChangeListener instigator)
void DeleteMessage (in nsMsgKey key, in nsIDBChangeListener instigator, in boolean commit)
void DeleteHeader (in nsIMsgDBHdr msgHdr, in nsIDBChangeListener instigator, in boolean commit, in boolean notify)
void RemoveHeaderMdbRow (in nsIMsgDBHdr msgHdr)
void UndoDelete (in nsIMsgDBHdr msgHdr)
void MarkMarked (in nsMsgKey key, in boolean mark, in nsIDBChangeListener instigator)
void MarkOffline (in nsMsgKey key, in boolean offline, in nsIDBChangeListener instigator)
void SetLabel (in nsMsgKey key, in nsMsgLabelValue label)
void setStringProperty (in nsMsgKey aKey, in string aProperty, in string aValue)
void MarkImapDeleted (in nsMsgKey key, in boolean deleted, in nsIDBChangeListener instigator)
void applyRetentionSettings (in nsIMsgRetentionSettings aMsgRetentionSettings, in boolean aDeleteViaFolder)
boolean HasNew ()
void ClearNewList (in boolean notify)
void AddToNewList (in nsMsgKey key)
void StartBatch ()
void EndBatch ()
nsIMsgOfflineImapOperation GetOfflineOpForKey (in nsMsgKey messageKey, in boolean create)
void RemoveOfflineOp (in nsIMsgOfflineImapOperation op)
nsISimpleEnumerator EnumerateOfflineOps ()
void ListAllOfflineOpIds (in nsMsgKeyArrayPtr offlineOpIds)
void ListAllOfflineDeletes (in nsMsgKeyArrayPtr offlineDeletes)
void ListAllOfflineMsgs (in nsMsgKeyArrayPtr offlineMsgs)
void setAttributesOnPendingHdr (in nsIMsgDBHdr pendingHdr, in string property, in string propertyVal, in long flags)
void createCollationKey (in AString sourceString, out octetPtr key, out unsigned long len)
long compareCollationKeys (in octetPtr key1, in unsigned long len1, in octetPtr key2, in unsigned long len2)
void getNewList (out unsigned long count,[array, size_is(count)] out nsMsgKey newKeys)
 The list of messages currently in the NEW state.
nsISimpleEnumerator getCachedHits (in string aSearchFolderUri)
void refreshCache (in string aSearchFolderUri, in unsigned long aNumKeys,[array, size_is(aNumKeys)] in nsMsgKey aNewHits, out unsigned long aNumBadHits,[array, size_is(aNumBadHits)] out nsMsgKey aStaleHits)
void updateHdrInCache (in string aSearchFolderUri, in nsIMsgDBHdr aHdr, in boolean aAdd)
boolean hdrIsInCache (in string aSearchFolderUri, in nsIMsgDBHdr aHdr)
void AddListener (in nsIDBChangeListener listener)
void RemoveListener (in nsIDBChangeListener listener)
void NotifyHdrChangeAll (in nsIMsgDBHdr aHdrChanged, in unsigned long aOldFlags, in unsigned long aNewFlags, in nsIDBChangeListener instigator)
void NotifyHdrAddedAll (in nsIMsgDBHdr aHdrAdded, in nsMsgKey parentKey, in long flags, in nsIDBChangeListener instigator)
void NotifyHdrDeletedAll (in nsIMsgDBHdr aHdrDeleted, in nsMsgKey parentKey, in long flags, in nsIDBChangeListener instigator)
void NotifyParentChangedAll (in nsMsgKey keyReparented, in nsMsgKey oldParent, in nsMsgKey newParent, in nsIDBChangeListener instigator)
void NotifyReadChanged (in nsIDBChangeListener instigator)
void NotifyJunkScoreChanged (in nsIDBChangeListener aInstigator)
void NotifyAnnouncerGoingAway ()

Public Attributes

readonly attribute nsIDBFolderInfo dBFolderInfo
readonly attribute nsMsgKey FirstNew
attribute nsIMsgRetentionSettings msgRetentionSettings
attribute nsIMsgDownloadSettings msgDownloadSettings
attribute boolean summaryValid
readonly attribute nsMsgKey lowWaterArticleNum
readonly attribute nsMsgKey highWaterArticleNum
attribute nsMsgKey nextPseudoMsgKey
readonly attribute nsMsgKey nextFakeOfflineMsgKey
readonly attribute
nsMsgViewFlagsTypeValue 
defaultViewFlags
readonly attribute
nsMsgViewSortTypeValue 
defaultSortType
readonly attribute
nsMsgViewSortOrderValue 
defaultSortOrder
attribute unsigned long msgHdrCacheSize
attribute nsIOFileStream folderStream

Detailed Description

Definition at line 123 of file nsIMsgDatabase.idl.


Member Function Documentation

Here is the caller graph for this function:

void nsIMsgDatabase::applyRetentionSettings ( in nsIMsgRetentionSettings  aMsgRetentionSettings,
in boolean  aDeleteViaFolder 
)
void nsIMsgDatabase::Close ( in boolean  aForceCommit)

Here is the caller graph for this function:

Here is the caller graph for this function:

long nsIMsgDatabase::compareCollationKeys ( in octetPtr  key1,
in unsigned long  len1,
in octetPtr  key2,
in unsigned long  len2 
)

Here is the caller graph for this function:

void nsIMsgDatabase::createCollationKey ( in AString  sourceString,
out octetPtr  key,
out unsigned long  len 
)
void nsIMsgDatabase::DeleteHeader ( in nsIMsgDBHdr  msgHdr,
in nsIDBChangeListener  instigator,
in boolean  commit,
in boolean  notify 
)

Here is the caller graph for this function:

Implemented in nsMailDatabase, and nsImapMailDatabase.

Here is the caller graph for this function:

Here is the caller graph for this function:

Implemented in nsNewsDatabase, nsImapMailDatabase, and nsMailDatabase.

Here is the caller graph for this function:

Here is the caller graph for this function:

void nsIMsgDatabase::getNewList ( out unsigned long  count,
[array, size_is(count)] out nsMsgKey  newKeys 
)

The list of messages currently in the NEW state.

If there are no such messages, a null pointer may be returned. the caller should free when done using nsMemory::Free.

Here is the caller graph for this function:

boolean nsIMsgDatabase::hdrIsInCache ( in string  aSearchFolderUri,
in nsIMsgDBHdr  aHdr 
)

Here is the caller graph for this function:

Here is the caller graph for this function:

void nsIMsgDatabase::MarkForwarded ( in nsMsgKey  key,
in boolean  bForwarded,
in nsIDBChangeListener  instigator 
)
void nsIMsgDatabase::MarkHasAttachments ( in nsMsgKey  key,
in boolean  bHasAttachments,
in nsIDBChangeListener  instigator 
)

Here is the caller graph for this function:

Here is the caller graph for this function:

void nsIMsgDatabase::MarkReadByDate ( in PRTime  startDate,
in PRTime  endDate,
in nsMsgKeyArrayPtr  markedIds 
)
void nsIMsgDatabase::MarkThreadIgnored ( in nsIMsgThread  thread,
in nsMsgKey  threadKey,
in boolean  bIgnored,
in nsIDBChangeListener  instigator 
)
void nsIMsgDatabase::MarkThreadWatched ( in nsIMsgThread  thread,
in nsMsgKey  threadKey,
in boolean  bWatched,
in nsIDBChangeListener  instigator 
)

Here is the caller graph for this function:

void nsIDBChangeAnnouncer::NotifyHdrAddedAll ( in nsIMsgDBHdr  aHdrAdded,
in nsMsgKey  parentKey,
in long  flags,
in nsIDBChangeListener  instigator 
) [inherited]
void nsIDBChangeAnnouncer::NotifyHdrChangeAll ( in nsIMsgDBHdr  aHdrChanged,
in unsigned long  aOldFlags,
in unsigned long  aNewFlags,
in nsIDBChangeListener  instigator 
) [inherited]

Here is the caller graph for this function:

void nsIDBChangeAnnouncer::NotifyHdrDeletedAll ( in nsIMsgDBHdr  aHdrDeleted,
in nsMsgKey  parentKey,
in long  flags,
in nsIDBChangeListener  instigator 
) [inherited]
void nsIDBChangeAnnouncer::NotifyParentChangedAll ( in nsMsgKey  keyReparented,
in nsMsgKey  oldParent,
in nsMsgKey  newParent,
in nsIDBChangeListener  instigator 
) [inherited]

Here is the caller graph for this function:

Here is the caller graph for this function:

void nsIMsgDatabase::Open ( in nsIFileSpec  aFolderName,
in boolean  aCreate,
in boolean  aLeaveInvalidDB 
)
void nsIMsgDatabase::refreshCache ( in string  aSearchFolderUri,
in unsigned long  aNumKeys,
[array, size_is(aNumKeys)] in nsMsgKey  aNewHits,
out unsigned long  aNumBadHits,
[array, size_is(aNumBadHits)] out nsMsgKey  aStaleHits 
)

Here is the caller graph for this function:

void nsIMsgDatabase::setAttributesOnPendingHdr ( in nsIMsgDBHdr  pendingHdr,
in string  property,
in string  propertyVal,
in long  flags 
)
void nsIMsgDatabase::setStringProperty ( in nsMsgKey  aKey,
in string  aProperty,
in string  aValue 
)

Implemented in nsMailDatabase, and nsImapMailDatabase.

void nsIMsgDatabase::updateHdrInCache ( in string  aSearchFolderUri,
in nsIMsgDBHdr  aHdr,
in boolean  aAdd 
)

Member Data Documentation

Definition at line 135 of file nsIMsgDatabase.idl.

Definition at line 290 of file nsIMsgDatabase.idl.

Definition at line 289 of file nsIMsgDatabase.idl.

Definition at line 288 of file nsIMsgDatabase.idl.

Definition at line 239 of file nsIMsgDatabase.idl.

Definition at line 297 of file nsIMsgDatabase.idl.

Definition at line 278 of file nsIMsgDatabase.idl.

Definition at line 277 of file nsIMsgDatabase.idl.

Definition at line 248 of file nsIMsgDatabase.idl.

Definition at line 293 of file nsIMsgDatabase.idl.

Definition at line 241 of file nsIMsgDatabase.idl.

Definition at line 280 of file nsIMsgDatabase.idl.

Definition at line 279 of file nsIMsgDatabase.idl.

Definition at line 259 of file nsIMsgDatabase.idl.


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