Interface Reference - nsIImapService

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.

nsIImapService

IID:	cb905844-b1e1-4850-96c7-407c166319f2
Inherits From:	nsISupports

This interface is intended to be used as a service.

This interface is implemented by the following components:

Properties

readonly nsICacheSession cacheSession

Methods

void addMessageFlags ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , imapMessageFlagsType flags , PRBool messageIdsAreUID ) void appendMessageFromFile ( nsIEventTarget clientEventTarget , nsIFile file , nsIMsgFolder dstFolder , ACString messageId , PRBool idsAreUids , PRBool inSelectedState , nsIUrlListener urlListener , out nsIURI URL , nsISupports copyState , nsIMsgWindow msgWindow ) void biff ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , PRUint32 uidHighWater ) nsIURI createFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder parentFolder , AString leafName , nsIUrlListener urlListener ) void deleteAllMessages ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL ) nsIURI deleteFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder folder , nsIUrlListener urlListener , nsIMsgWindow msgWindow ) void deleteMessages ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , PRBool messageIdsAreUID ) void discoverAllAndSubscribedFolders ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL ) void discoverAllFolders ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , nsIMsgWindow msgWindow , out nsIURI URL ) void discoverChildren ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , ACString folderPath , out nsIURI URL ) void downloadAllOffineImapFolders ( nsIMsgWindow msgWindow , nsIUrlListener listener ) void downloadMessagesForOffline ( ACString messageIds , nsIMsgFolder srcFolder , nsIUrlListener listener , nsIMsgWindow msgWindow ) nsIURI ensureFolderExists ( nsIEventTarget clientEventTarget , nsIMsgFolder parentFolder , AString leafName , nsIUrlListener urlListener ) void expunge ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL ) nsIURI fetchCustomMsgAttribute ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , ACString attribute , ACString messageIdentifierList ) void fetchMessage ( nsIImapUrl url , nsImapState imapAction , nsIMsgFolder imapMailFolder , nsIImapMessageSink imapMessageSink , nsIMsgWindow msgWindow , nsISupports consumer , ACString messageIdentifierList , PRBool convertDattoText , ACString additionalHeader , out nsIURI outURL ) nsIURI getBodyStart ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , ACString messageIdentifierList , PRInt32 numBytes ) nsIURI getFolderAdminUrl ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , nsIUrlListener urlListener ) void getHeaders ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , PRBool messageIdsAreUID ) void getListOfFoldersOnServer ( nsIImapIncomingServer server , nsIMsgWindow msgWindow ) void getListOfFoldersWithPath ( nsIImapIncomingServer server , nsIMsgWindow msgWindow , ACString folderPath ) nsIURI issueCommandOnMsgs ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , ACString command , ACString messageIdentifierList ) nsIURI listFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIUrlListener urlListener ) void liteSelectFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL ) nsIURI moveFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder srcFolder , nsIMsgFolder dstFolder , nsIUrlListener urlListener , nsIMsgWindow msgWindow ) void noop ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL ) void onlineMessageCopy ( nsIEventTarget clientEventTarget , nsIMsgFolder srcFolder , ACString messageIds , nsIMsgFolder dstFolder , PRBool idsAreUids , PRBool isMove , nsIUrlListener urlListener , out nsIURI URL , nsISupports copyState , nsIMsgWindow window ) nsISupports playbackAllOfflineOperations ( nsIMsgWindow msgWindow , nsIUrlListener listener ) nsIURI renameLeaf ( nsIEventTarget clientEventTarget , nsIMsgFolder srcFolder , AString leafName , nsIUrlListener urlListener , nsIMsgWindow msgWindow ) void selectFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , nsIMsgWindow msgWindow , out nsIURI URL ) void setMessageFlags ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , imapMessageFlagsType flags , PRBool messageIdsAreUID ) nsIURI storeCustomKeywords ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , ACString flagsToAdd , ACString flagsToSubtract , ACString messageIdentifierList ) nsIURI subscribeFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , AString mailboxName , nsIUrlListener urlListener ) void subtractMessageFlags ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , imapMessageFlagsType flags , PRBool messageIdsAreUID ) nsIURI unsubscribeFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , AString mailboxName , nsIUrlListener urlListener ) nsIURI updateFolderStatus ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener )

void addMessageFlags ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , imapMessageFlagsType flags , PRBool messageIdsAreUID )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL; messageIdentifierList; flags; messageIdsAreUID

void appendMessageFromFile ( nsIEventTarget clientEventTarget , nsIFile file , nsIMsgFolder dstFolder , ACString messageId , PRBool idsAreUids , PRBool inSelectedState , nsIUrlListener urlListener , out nsIURI URL , nsISupports copyState , nsIMsgWindow msgWindow )

Arguments:: clientEventTarget; file; dstFolder; messageId; idsAreUids; inSelectedState; urlListener; URL; copyState; msgWindow

void biff ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , PRUint32 uidHighWater )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL; uidHighWater

nsIURI createFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder parentFolder , AString leafName , nsIUrlListener urlListener )

Arguments:: clientEventTarget; parentFolder; leafName; urlListener

void deleteAllMessages ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL

nsIURI deleteFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder folder , nsIUrlListener urlListener , nsIMsgWindow msgWindow )

Arguments:: clientEventTarget; folder; urlListener; msgWindow

void deleteMessages ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , PRBool messageIdsAreUID )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL; messageIdentifierList; messageIdsAreUID

void discoverAllAndSubscribedFolders ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL

void discoverAllFolders ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , nsIMsgWindow msgWindow , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; msgWindow; URL

void discoverChildren ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , ACString folderPath , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; folderPath; URL

void downloadAllOffineImapFolders ( nsIMsgWindow msgWindow , nsIUrlListener listener )

Arguments:: msgWindow; listener

void downloadMessagesForOffline ( ACString messageIds , nsIMsgFolder srcFolder , nsIUrlListener listener , nsIMsgWindow msgWindow )

Arguments:: messageIds; srcFolder; listener; msgWindow

nsIURI ensureFolderExists ( nsIEventTarget clientEventTarget , nsIMsgFolder parentFolder , AString leafName , nsIUrlListener urlListener )

Arguments:: clientEventTarget; parentFolder; leafName; urlListener

void expunge ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL

nsIURI fetchCustomMsgAttribute ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , ACString attribute , ACString messageIdentifierList )

Arguments:: clientEventTarget; mailFolder; msgWindow; attribute; messageIdentifierList

void fetchMessage ( nsIImapUrl url , nsImapState imapAction , nsIMsgFolder imapMailFolder , nsIImapMessageSink imapMessageSink , nsIMsgWindow msgWindow , nsISupports consumer , ACString messageIdentifierList , PRBool convertDattoText , ACString additionalHeader , out nsIURI outURL )

Arguments:: url; imapAction; imapMailFolder; imapMessageSink; msgWindow; consumer; messageIdentifierList; convertDattoText; additionalHeader; outURL

nsIURI getBodyStart ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , ACString messageIdentifierList , PRInt32 numBytes )

Arguments:: clientEventTarget; imapMailFolder; urlListener; messageIdentifierList; numBytes

nsIURI getFolderAdminUrl ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , nsIUrlListener urlListener )

Arguments:: clientEventTarget; mailFolder; msgWindow; urlListener

void getHeaders ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , PRBool messageIdsAreUID )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL; messageIdentifierList; messageIdsAreUID

void getListOfFoldersOnServer ( nsIImapIncomingServer server , nsIMsgWindow msgWindow )

Arguments:: server; msgWindow

void getListOfFoldersWithPath ( nsIImapIncomingServer server , nsIMsgWindow msgWindow , ACString folderPath )

Arguments:: server; msgWindow; folderPath

nsIURI issueCommandOnMsgs ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , ACString command , ACString messageIdentifierList )

Arguments:: clientEventTarget; mailFolder; msgWindow; command; messageIdentifierList

nsIURI listFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIUrlListener urlListener )

Arguments:: clientEventTarget; mailFolder; urlListener

void liteSelectFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL

nsIURI moveFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder srcFolder , nsIMsgFolder dstFolder , nsIUrlListener urlListener , nsIMsgWindow msgWindow )

Arguments:: clientEventTarget; srcFolder; dstFolder; urlListener; msgWindow

void noop ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL

void onlineMessageCopy ( nsIEventTarget clientEventTarget , nsIMsgFolder srcFolder , ACString messageIds , nsIMsgFolder dstFolder , PRBool idsAreUids , PRBool isMove , nsIUrlListener urlListener , out nsIURI URL , nsISupports copyState , nsIMsgWindow window )

Arguments:: clientEventTarget; srcFolder; messageIds; dstFolder; idsAreUids; isMove; urlListener; URL; copyState; window

nsISupports playbackAllOfflineOperations ( nsIMsgWindow msgWindow , nsIUrlListener listener )

Arguments:: msgWindow; listener

nsIURI renameLeaf ( nsIEventTarget clientEventTarget , nsIMsgFolder srcFolder , AString leafName , nsIUrlListener urlListener , nsIMsgWindow msgWindow )

Arguments:: clientEventTarget; srcFolder; leafName; urlListener; msgWindow

void selectFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , nsIMsgWindow msgWindow , out nsIURI URL )

Arguments:: clientEventTarget; imapMailFolder; urlListener; msgWindow; URL

void setMessageFlags ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , imapMessageFlagsType flags , PRBool messageIdsAreUID )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL; messageIdentifierList; flags; messageIdsAreUID

nsIURI storeCustomKeywords ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , nsIMsgWindow msgWindow , ACString flagsToAdd , ACString flagsToSubtract , ACString messageIdentifierList )

Arguments:: clientEventTarget; mailFolder; msgWindow; flagsToAdd; flagsToSubtract; messageIdentifierList

nsIURI subscribeFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , AString mailboxName , nsIUrlListener urlListener )

Arguments:: clientEventTarget; mailFolder; mailboxName; urlListener

void subtractMessageFlags ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener , out nsIURI URL , ACString messageIdentifierList , imapMessageFlagsType flags , PRBool messageIdsAreUID )

Arguments:: clientEventTarget; imapMailFolder; urlListener; URL; messageIdentifierList; flags; messageIdsAreUID

nsIURI unsubscribeFolder ( nsIEventTarget clientEventTarget , nsIMsgFolder mailFolder , AString mailboxName , nsIUrlListener urlListener )

Arguments:: clientEventTarget; mailFolder; mailboxName; urlListener

nsIURI updateFolderStatus ( nsIEventTarget clientEventTarget , nsIMsgFolder imapMailFolder , nsIUrlListener urlListener )

Arguments:: clientEventTarget; imapMailFolder; urlListener

Reference documentation is generated from Mozilla's source.

Contents

Tutorials

References

XUL Forum

Downloads

About XULPlanet

nsIImapService

Properties

Methods