nsIMsgDatabase

IID:1a706802-8121-4f91-a302-6e1f9a13204b
Inherits From:nsIDBChangeAnnouncer

Properties

readonly nsIDBFolderInfo dBFolderInfo

readonly nsMsgViewSortTypeValue defaultSortType

readonly nsMsgViewFlagsTypeValue defaultViewFlags

readonly nsMsgKey FirstNew

readonly nsMsgKey highWaterArticleNum

readonly nsMsgKey lowWaterArticleNum

nsIMsgDownloadSettings msgDownloadSettings

PRUint32 msgHdrCacheSize

nsIMsgRetentionSettings msgRetentionSettings

readonly nsMsgKeyArrayPtr* newList

The list of messages currently in the NEW state.

If there are no such messages, a null pointer may be returned. Note that the since the structure itself is not refcounted, the caller should free when done using NS_DELETEXPCOM().

readonly nsMsgKey nextFakeOfflineMsgKey

nsMsgKey nextPseudoMsgKey

PRBool summaryValid


Methods

void AddNewHdrToDB ( nsIMsgDBHdr newHdr , PRBool notify ) void AddToNewList ( nsMsgKey key ) void applyRetentionSettings ( nsIMsgRetentionSettings msgRetentionSettings , PRBool deleteViaFolder ) void clearCachedHdrs ( ) void ClearNewList ( PRBool notify ) void Close ( PRBool forceCommit ) void Commit ( nsMsgDBCommit commitType ) [noscript] PRInt32 compareCollationKeys ( octetPtr* key1 , PRUint32 len1 , octetPtr* key2 , PRUint32 len2 ) PRBool ContainsKey ( nsMsgKey key ) nsIMsgDBHdr CopyHdrFromExistingHdr ( nsMsgKey key , nsIMsgDBHdr existingHdr , PRBool addHdrToDB ) [noscript] void createCollationKey ( AString sourceString , out octetPtr* key , out PRUint32 len ) nsIMsgDBHdr CreateNewHdr ( nsMsgKey key ) void DeleteHeader ( nsIMsgDBHdr msgHdr , nsIDBChangeListener instigator , PRBool commit , PRBool notify ) void DeleteMessage ( nsMsgKey key , nsIDBChangeListener instigator , PRBool commit ) [noscript] void DeleteMessages ( nsMsgKeyArrayPtr* nsMsgKeys , nsIDBChangeListener instigator ) void EndBatch ( ) nsISimpleEnumerator EnumerateMessages ( ) nsISimpleEnumerator EnumerateOfflineOps ( ) nsISimpleEnumerator EnumerateThreads ( ) void ForceClosed ( ) void forceFolderDBClosed ( nsIMsgFolder folder ) nsIMsgDBHdr GetMsgHdrForKey ( nsMsgKey key ) nsIMsgDBHdr getMsgHdrForMessageID ( char* messageID ) nsIMsgOfflineImapOperation GetOfflineOpForKey ( nsMsgKey messageKey , PRBool create ) nsIMsgThread GetThreadContainingMsgHdr ( nsIMsgDBHdr msgHdr ) PRBool HasAttachments ( nsMsgKey key ) PRBool HasNew ( ) PRBool IsIgnored ( nsMsgKey key ) PRBool IsMarked ( nsMsgKey key ) PRBool IsMDNNeeded ( nsMsgKey key ) PRBool IsMDNSent ( nsMsgKey key ) PRBool IsRead ( nsMsgKey key ) [noscript] void ListAllKeys ( nsMsgKeyArrayRef outputKeys ) [noscript] void ListAllOfflineDeletes ( nsMsgKeyArrayPtr* offlineDeletes ) [noscript] void ListAllOfflineMsgs ( nsMsgKeyArrayPtr* offlineMsgs ) [noscript] void ListAllOfflineOpIds ( nsMsgKeyArrayPtr* offlineOpIds ) [noscript] void MarkAllRead ( nsMsgKeyArrayPtr* thoseMarked ) void MarkForwarded ( nsMsgKey key , PRBool bForwarded , nsIDBChangeListener instigator ) void MarkHasAttachments ( nsMsgKey key , PRBool bHasAttachments , nsIDBChangeListener instigator ) void MarkHdrMarked ( nsIMsgDBHdr msgHdr , PRBool mark , nsIDBChangeListener instigator ) void MarkHdrRead ( nsIMsgDBHdr msgHdr , PRBool bRead , nsIDBChangeListener instigator ) void MarkHdrReplied ( nsIMsgDBHdr msgHdr , PRBool bReplied , nsIDBChangeListener instigator ) void MarkImapDeleted ( nsMsgKey key , PRBool deleted , nsIDBChangeListener instigator ) void MarkMarked ( nsMsgKey key , PRBool mark , nsIDBChangeListener instigator ) void MarkMDNNeeded ( nsMsgKey key , PRBool bNeeded , nsIDBChangeListener instigator ) void MarkMDNSent ( nsMsgKey key , PRBool bNeeded , nsIDBChangeListener instigator ) void MarkOffline ( nsMsgKey key , PRBool offline , nsIDBChangeListener instigator ) void MarkRead ( nsMsgKey key , PRBool bRead , nsIDBChangeListener instigator ) [noscript] void MarkReadByDate ( PRTime startDate , PRTime endDate , nsMsgKeyArrayPtr* markedIds ) void MarkReplied ( nsMsgKey key , PRBool bReplied , nsIDBChangeListener instigator ) void MarkThreadIgnored ( nsIMsgThread thread , nsMsgKey threadKey , PRBool bIgnored , nsIDBChangeListener instigator ) [noscript] void MarkThreadRead ( nsIMsgThread thread , nsIDBChangeListener instigator , nsMsgKeyArrayPtr* thoseMarked ) void MarkThreadWatched ( nsIMsgThread thread , nsMsgKey threadKey , PRBool bWatched , nsIDBChangeListener instigator ) void Open ( nsIFileSpec folderName , PRBool create , PRBool leaveInvalidDB ) void RemoveHeaderMdbRow ( nsIMsgDBHdr msgHdr ) void RemoveOfflineOp ( nsIMsgOfflineImapOperation op ) void resetHdrCacheSize ( PRUint32 size ) void setAttributesOnPendingHdr ( nsIMsgDBHdr pendingHdr , char* property , char* propertyVal , PRInt32 flags ) void setFolderStream ( nsIOFileStream fileStream ) void SetLabel ( nsMsgKey key , nsMsgLabelValue label ) void setStringProperty ( nsMsgKey key , char* property , char* value ) void StartBatch ( ) void syncCounts ( ) void UndoDelete ( nsIMsgDBHdr msgHdr )

void AddNewHdrToDB ( nsIMsgDBHdr newHdr , PRBool notify )

Arguments:
newHdr
notify

void AddToNewList ( nsMsgKey key )

Arguments:
key

void applyRetentionSettings ( nsIMsgRetentionSettings msgRetentionSettings , PRBool deleteViaFolder )

Arguments:
msgRetentionSettings
deleteViaFolder

void clearCachedHdrs ( )


void ClearNewList ( PRBool notify )

Arguments:
notify

void Close ( PRBool forceCommit )

Arguments:
forceCommit

void Commit ( nsMsgDBCommit commitType )

Arguments:
commitType

PRInt32 compareCollationKeys ( octetPtr* key1 , PRUint32 len1 , octetPtr* key2 , PRUint32 len2 )

Arguments:
key1
len1
key2
len2

PRBool ContainsKey ( nsMsgKey key )

Arguments:
key

nsIMsgDBHdr CopyHdrFromExistingHdr ( nsMsgKey key , nsIMsgDBHdr existingHdr , PRBool addHdrToDB )

Arguments:
key
existingHdr
addHdrToDB

void createCollationKey ( AString sourceString , out octetPtr* key , out PRUint32 len )

Arguments:
sourceString
key
len

nsIMsgDBHdr CreateNewHdr ( nsMsgKey key )

Arguments:
key

void DeleteHeader ( nsIMsgDBHdr msgHdr , nsIDBChangeListener instigator , PRBool commit , PRBool notify )

Arguments:
msgHdr
instigator
commit
notify

void DeleteMessage ( nsMsgKey key , nsIDBChangeListener instigator , PRBool commit )

Arguments:
key
instigator
commit

void DeleteMessages ( nsMsgKeyArrayPtr* nsMsgKeys , nsIDBChangeListener instigator )

Arguments:
nsMsgKeys
instigator

void EndBatch ( )


nsISimpleEnumerator EnumerateMessages ( )


nsISimpleEnumerator EnumerateOfflineOps ( )


nsISimpleEnumerator EnumerateThreads ( )


void ForceClosed ( )


void forceFolderDBClosed ( nsIMsgFolder folder )

Arguments:
folder

nsIMsgDBHdr GetMsgHdrForKey ( nsMsgKey key )

Arguments:
key

nsIMsgDBHdr getMsgHdrForMessageID ( char* messageID )

Arguments:
messageID

nsIMsgOfflineImapOperation GetOfflineOpForKey ( nsMsgKey messageKey , PRBool create )

Arguments:
messageKey
create

nsIMsgThread GetThreadContainingMsgHdr ( nsIMsgDBHdr msgHdr )

Arguments:
msgHdr

PRBool HasAttachments ( nsMsgKey key )

Arguments:
key

PRBool HasNew ( )


PRBool IsIgnored ( nsMsgKey key )

Arguments:
key

PRBool IsMarked ( nsMsgKey key )

Arguments:
key

PRBool IsMDNNeeded ( nsMsgKey key )

Arguments:
key

PRBool IsMDNSent ( nsMsgKey key )

Arguments:
key

PRBool IsRead ( nsMsgKey key )

Arguments:
key

void ListAllKeys ( nsMsgKeyArrayRef outputKeys )

Arguments:
outputKeys

void ListAllOfflineDeletes ( nsMsgKeyArrayPtr* offlineDeletes )

Arguments:
offlineDeletes

void ListAllOfflineMsgs ( nsMsgKeyArrayPtr* offlineMsgs )

Arguments:
offlineMsgs

void ListAllOfflineOpIds ( nsMsgKeyArrayPtr* offlineOpIds )

Arguments:
offlineOpIds

void MarkAllRead ( nsMsgKeyArrayPtr* thoseMarked )

Arguments:
thoseMarked

void MarkForwarded ( nsMsgKey key , PRBool bForwarded , nsIDBChangeListener instigator )

Arguments:
key
bForwarded
instigator

void MarkHasAttachments ( nsMsgKey key , PRBool bHasAttachments , nsIDBChangeListener instigator )

Arguments:
key
bHasAttachments
instigator

void MarkHdrMarked ( nsIMsgDBHdr msgHdr , PRBool mark , nsIDBChangeListener instigator )

Arguments:
msgHdr
mark
instigator

void MarkHdrRead ( nsIMsgDBHdr msgHdr , PRBool bRead , nsIDBChangeListener instigator )

Arguments:
msgHdr
bRead
instigator

void MarkHdrReplied ( nsIMsgDBHdr msgHdr , PRBool bReplied , nsIDBChangeListener instigator )

Arguments:
msgHdr
bReplied
instigator

void MarkImapDeleted ( nsMsgKey key , PRBool deleted , nsIDBChangeListener instigator )

Arguments:
key
deleted
instigator

void MarkMarked ( nsMsgKey key , PRBool mark , nsIDBChangeListener instigator )

Arguments:
key
mark
instigator

void MarkMDNNeeded ( nsMsgKey key , PRBool bNeeded , nsIDBChangeListener instigator )

Arguments:
key
bNeeded
instigator

void MarkMDNSent ( nsMsgKey key , PRBool bNeeded , nsIDBChangeListener instigator )

Arguments:
key
bNeeded
instigator

void MarkOffline ( nsMsgKey key , PRBool offline , nsIDBChangeListener instigator )

Arguments:
key
offline
instigator

void MarkRead ( nsMsgKey key , PRBool bRead , nsIDBChangeListener instigator )

Arguments:
key
bRead
instigator

void MarkReadByDate ( PRTime startDate , PRTime endDate , nsMsgKeyArrayPtr* markedIds )

Arguments:
startDate
endDate
markedIds

void MarkReplied ( nsMsgKey key , PRBool bReplied , nsIDBChangeListener instigator )

Arguments:
key
bReplied
instigator

void MarkThreadIgnored ( nsIMsgThread thread , nsMsgKey threadKey , PRBool bIgnored , nsIDBChangeListener instigator )

Arguments:
thread
threadKey
bIgnored
instigator

void MarkThreadRead ( nsIMsgThread thread , nsIDBChangeListener instigator , nsMsgKeyArrayPtr* thoseMarked )

Arguments:
thread
instigator
thoseMarked

void MarkThreadWatched ( nsIMsgThread thread , nsMsgKey threadKey , PRBool bWatched , nsIDBChangeListener instigator )

Arguments:
thread
threadKey
bWatched
instigator

void Open ( nsIFileSpec folderName , PRBool create , PRBool leaveInvalidDB )

Arguments:
folderName
create
leaveInvalidDB

void RemoveHeaderMdbRow ( nsIMsgDBHdr msgHdr )

Arguments:
msgHdr

void RemoveOfflineOp ( nsIMsgOfflineImapOperation op )

Arguments:
op

void resetHdrCacheSize ( PRUint32 size )

Arguments:
size

void setAttributesOnPendingHdr ( nsIMsgDBHdr pendingHdr , char* property , char* propertyVal , PRInt32 flags )

Arguments:
pendingHdr
property
propertyVal
flags

void setFolderStream ( nsIOFileStream fileStream )

Arguments:
fileStream

void SetLabel ( nsMsgKey key , nsMsgLabelValue label )

Arguments:
key
label

void setStringProperty ( nsMsgKey key , char* property , char* value )

Arguments:
key
property
value

void StartBatch ( )


void syncCounts ( )


void UndoDelete ( nsIMsgDBHdr msgHdr )

Arguments:
msgHdr

References

This interface is the type of the following properties:

nsIMsgDBView.db

This interface is passed as an argument to the following methods:

nsIMsgFilter.MatchHdr, nsIMsgFilterList.applyFiltersToHdr, nsIMsgFolder.setMsgDatabase, nsIMsgParseMailMsgState.SetMailDB, nsIMsgSearchSession.MatchHdr, nsIMsgSearchTerm.matchArbitraryHeader, nsIMsgSearchTerm.matchBody

This interface is returned from the following methods:

nsIMsgDBService.openFolderDB, nsIMsgDBService.openMailDBFromFileSpec, nsIMsgFolder.getDBFolderInfoAndDB, nsIMsgFolder.getMsgDatabase, nsIMsgLocalMailFolder.getDatabaseWOReparse, nsIMsgLocalMailFolder.getDatabaseWithReparse

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com