nsIMsgCopyServiceListener

IID:1caa10b6-29a6-11d3-afb2-001083002da8
Inherits From:nsISupports

This interface is implemented by the following components:


Methods

[noscript] void GetMessageId ( nsCString* messageId ) void OnProgress ( PRUint32 progress , PRUint32 progressMax ) void OnStartCopy ( ) void OnStopCopy ( nsresult status ) void SetMessageKey ( PRUint32 key )

void GetMessageId ( nsCString* messageId )

Getting the file message message ID. This method is taylored specifically for nsIMsgCopyService::CopyFileMessage() when saving Drafts/Templates. In order to work with imap server which doesn't support uidplus we have to use search comman to retrieve the key of newly created message. Message ID generated by the compose gurantee its uniqueness. messageId -

Arguments:
messageId

void OnProgress ( PRUint32 progress , PRUint32 progressMax )

Notify the observer that progress as occurred for the message copy progress - progressMax -

Arguments:
progress
progressMax

void OnStartCopy ( )

Notify the observer that the message has started to be copied. This method is called only once, at the beginning of a message copyoperation.


void OnStopCopy ( nsresult status )

Notify the observer that the message copied operation has completed. This method is called regardless of whether the the operation was successful. status - indicate whether the operation was succeeded

Arguments:
status

void SetMessageKey ( PRUint32 key )

Setting newly created message key. This method is taylored specifically for nsIMsgCopyService::CopyFileMessage() when saveing Drafts/Templates. We need to have a way to inform the client what's the key of the newly created message. key -

Arguments:
key

References

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

nsIMsgCopyService.CopyFileMessage, nsIMsgCopyService.CopyFolders, nsIMsgCopyService.CopyMessages, nsIMsgFolder.copyFileMessage, nsIMsgFolder.copyFolder, nsIMsgFolder.copyMessages, nsIMsgFolder.deleteMessages, nsIMsgLocalMailFolder.copyAllSubFolders, nsIMsgLocalMailFolder.copyFolderLocal

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com