WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIImapMailFolderSink

IID:3b2dd7e0-e72c-11d2-ab7b-00805f8ac968
Inherits From:nsISupports

Properties

PRUint32 aclFlags

PRBool folderNeedsACLListed

PRBool folderNeedsAdded

PRBool folderNeedsSubscribing

PRBool folderQuotaCommandIssued

Whether we have asked the server for this folder's quota information. If the server supports quotas, this occurs when the folder is opened.

readonly PRBool shouldDownloadAllHeaders

PRInt32 uidValidity

Methods

void AbortHeaderParseStream ( nsIImapProtocol protocol ) void clearFolderRights ( ) void closeMockChannel ( nsIImapMockChannel channel ) void copyNextStreamMessage ( PRBool copySucceeded , nsISupports copyState ) void EndMessage ( nsIMsgMailNewsUrl url , nsMsgKey uidOfMessage ) ACString getMessageId ( nsIImapUrl url ) char* GetOnlineDelimiter ( ) void headerFetchCompleted ( nsIImapProtocol protocol ) void NotifySearchHit ( nsIMsgMailNewsUrl url , char* hitLine ) void OnlineCopyCompleted ( nsIImapProtocol protocol , ImapOnlineCopyState copyState ) void OnNewIdleMessages ( ) void parseMsgHdrs ( nsIImapProtocol protocol , nsIImapHeaderXferInfo hdrXferInfo ) void percentProgress ( nsIImapProtocol protocol , PRUnichar* message , PRInt32 currentProgress , PRInt32 maxProgressProgressInfo ) void progressStatus ( nsIImapProtocol protocol , PRUint32 msgId , PRUnichar* extrinfo ) void releaseUrlCacheEntry ( nsIMsgMailNewsUrl url ) void setAppendMsgUid ( nsMsgKey newKey , nsIImapUrl url ) void setBiffStateAndUpdate ( PRInt32 biffState ) void setCopyResponseUid ( char* msgIdString , nsIImapUrl url ) void setFolderQuotaData ( ACString folderQuotaRoot , PRUint32 folderQuotaUsedKB , PRUint32 folderQuotaMaxKB ) void setUrlState ( nsIImapProtocol protocol , nsIMsgMailNewsUrl url , PRBool isRunning , nsresult status ) void StartMessage ( nsIMsgMailNewsUrl url ) void UpdateImapMailboxInfo ( nsIImapProtocol protocol , nsIMailboxSpec spec ) void UpdateImapMailboxStatus ( nsIImapProtocol protocol , nsIMailboxSpec spec )

void AbortHeaderParseStream ( nsIImapProtocol protocol )

Arguments:
protocol

void clearFolderRights ( )

void closeMockChannel ( nsIImapMockChannel channel )

Arguments:
channel

void copyNextStreamMessage ( PRBool copySucceeded , nsISupports copyState )

Arguments:
copySucceeded
copyState

void EndMessage ( nsIMsgMailNewsUrl url , nsMsgKey uidOfMessage )

Arguments:
url
uidOfMessage

ACString getMessageId ( nsIImapUrl url )

Arguments:
url

char* GetOnlineDelimiter ( )

void headerFetchCompleted ( nsIImapProtocol protocol )

Arguments:
protocol

void NotifySearchHit ( nsIMsgMailNewsUrl url , char* hitLine )

Arguments:
url
hitLine

void OnlineCopyCompleted ( nsIImapProtocol protocol , ImapOnlineCopyState copyState )

Arguments:
protocol
copyState

void OnNewIdleMessages ( )

void parseMsgHdrs ( nsIImapProtocol protocol , nsIImapHeaderXferInfo hdrXferInfo )

Arguments:
protocol
hdrXferInfo

void percentProgress ( nsIImapProtocol protocol , PRUnichar* message , PRInt32 currentProgress , PRInt32 maxProgressProgressInfo )

Arguments:
protocol
message
currentProgress
maxProgressProgressInfo

void progressStatus ( nsIImapProtocol protocol , PRUint32 msgId , PRUnichar* extrinfo )

Arguments:
protocol
msgId
extrinfo

void releaseUrlCacheEntry ( nsIMsgMailNewsUrl url )

Arguments:
url

void setAppendMsgUid ( nsMsgKey newKey , nsIImapUrl url )

Arguments:
newKey
url

void setBiffStateAndUpdate ( PRInt32 biffState )

Arguments:
biffState

void setCopyResponseUid ( char* msgIdString , nsIImapUrl url )

Arguments:
msgIdString
url

void setFolderQuotaData ( ACString folderQuotaRoot , PRUint32 folderQuotaUsedKB , PRUint32 folderQuotaMaxKB )

Set FolderQuotaData information

Arguments:
folderQuotaRoot: The IMAP quota root for this folder, as returned by the GETQUOTAROOT IMAP command.
folderQuotaUsedKB: Used space, in KB, on this folder's quota root.
folderQuotaMaxKB: Size, in KB, of this folder's quota root.

void setUrlState ( nsIImapProtocol protocol , nsIMsgMailNewsUrl url , PRBool isRunning , nsresult status )

Arguments:
protocol
url
isRunning
status

void StartMessage ( nsIMsgMailNewsUrl url )

Arguments:
url

void UpdateImapMailboxInfo ( nsIImapProtocol protocol , nsIMailboxSpec spec )

Arguments:
protocol
spec

void UpdateImapMailboxStatus ( nsIImapProtocol protocol , nsIMailboxSpec spec )

Arguments:
protocol
spec

References

This interface is the type of the following properties:

nsIImapUrl.imapMailFolderSink

Reference documentation is generated from Mozilla's source.