Public Member Functions

nsIImapMessageSink Interface Reference

import "nsIImapMessageSink.idl";

List of all members.

Public Member Functions

void setupMsgWriteStream (in nsIFile aFile, in boolean aAppendDummyEnvelope)
void parseAdoptedMsgLine (in string aAdoptedMsgLine, in nsMsgKey aUidOfMsg, in long aSizeOfMsg, in nsIImapUrl aImapUrl)
 Used by the imap protocol code to notify the core backend code about downloaded imap messages.
void normalEndMsgWriteStream (in nsMsgKey aUidOfMessage, in boolean aMarkMsgRead, in nsIImapUrl aImapUrl)
void abortMsgWriteStream ()
void beginMessageUpload ()
void notifyMessageFlags (in unsigned long aFlags, in nsMsgKey aMessageKey, in unsigned long long aHighestModSeq)
 Notify the message sink that one or more flags have changed For Condstore servers, also update the highestMod Sequence.
void notifyMessageDeleted (in string aOnlineFolderName, in boolean aDeleteAllMsgs, in string aMsgIdString)
void getMessageSizeFromDB (in string aId, out unsigned long aSize)
void setContentModified (in nsIImapUrl aImapUrl, in nsImapContentModifiedType aModified)
void setImageCacheSessionForUrl (in nsIMsgMailNewsUrl aMailUrl)
unsigned long getCurMoveCopyMessageInfo (in nsIImapUrl aRunningUrl, out PRTime aDate, out ACString aKeywords)
 For a message stored in a file, get the message metadata needed to copy that message to an imap folder.

Member Function Documentation

void nsIImapMessageSink::abortMsgWriteStream (  ) 
void nsIImapMessageSink::beginMessageUpload (  ) 
unsigned long nsIImapMessageSink::getCurMoveCopyMessageInfo ( in nsIImapUrl  aRunningUrl,
out PRTime  aDate,
out ACString  aKeywords 
)

For a message stored in a file, get the message metadata needed to copy that message to an imap folder.

Parameters:
aRunningUrl message URL
aDate message date
aKeywords message custom keywords (if supported by the server), including messages tags and junk status
Returns:
message flags
void nsIImapMessageSink::getMessageSizeFromDB ( in string  aId,
out unsigned long  aSize 
)
void nsIImapMessageSink::normalEndMsgWriteStream ( in nsMsgKey  aUidOfMessage,
in boolean  aMarkMsgRead,
in nsIImapUrl  aImapUrl 
)
void nsIImapMessageSink::notifyMessageDeleted ( in string  aOnlineFolderName,
in boolean  aDeleteAllMsgs,
in string  aMsgIdString 
)
void nsIImapMessageSink::notifyMessageFlags ( in unsigned long  aFlags,
in nsMsgKey  aMessageKey,
in unsigned long long  aHighestModSeq 
)

Notify the message sink that one or more flags have changed For Condstore servers, also update the highestMod Sequence.

Parameters:
aFlags - The new flags for the message
aMessageKey - The UID of the message that changed
aHighestModSeq - The highest mod seq the parser has seen for this folder
void nsIImapMessageSink::parseAdoptedMsgLine ( in string  aAdoptedMsgLine,
in nsMsgKey  aUidOfMsg,
in long  aSizeOfMsg,
in nsIImapUrl  aImapUrl 
)

Used by the imap protocol code to notify the core backend code about downloaded imap messages.

Parameters:
aAdoptedMsgLine a string with a lot of message lines, separated by native line terminators.
aUidOfMsg IMAP UID of the fetched message.
aSizeOfMsg RFC822.Size of the fetched message
aImapUrl IMAP Url used to fetch the message.
void nsIImapMessageSink::setContentModified ( in nsIImapUrl  aImapUrl,
in nsImapContentModifiedType  aModified 
)
void nsIImapMessageSink::setImageCacheSessionForUrl ( in nsIMsgMailNewsUrl  aMailUrl  ) 
void nsIImapMessageSink::setupMsgWriteStream ( in nsIFile  aFile,
in boolean  aAppendDummyEnvelope 
)

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