nsIImapService Interface Reference

import "nsIImapService.idl";

Inheritance diagram for nsIImapService:

[legend]

Collaboration diagram for nsIImapService:

[legend]

List of all members.

Public Member Functions
void	selectFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow, out nsIURI aURL)
void	liteSelectFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL)
void	fetchMessage (in nsIImapUrl aUrl, in nsImapState aImapAction, in nsIMsgFolder aImapMailFolder, in nsIImapMessageSink aImapMessageSink, in nsIMsgWindow aMsgWindow, in nsISupports aConsumer, in ACString aMessageIdentifierList, in boolean convertDataToText, in ACString additionalHeader, out nsIURI aOutURL)
void	noop (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL)
void	getHeaders (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL, in ACString aMessageIdentifierList, in boolean aMessageIdsAreUID)
nsIURI	getBodyStart (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in ACString aMessageIdentifierList, in long numBytes)
void	expunge (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL)
nsIURI	updateFolderStatus (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener)
void	biff (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL, in unsigned long aUidHighWater)
void	deleteMessages (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL, in ACString aMessageIdentifierList, in boolean aMessageIdsAreUID)
void	deleteAllMessages (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL)
void	addMessageFlags (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL, in ACString aMessageIdentifierList, in imapMessageFlagsType aFlags, in boolean aMessageIdsAreUID)
void	subtractMessageFlags (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL, in ACString aMessageIdentifierList, in imapMessageFlagsType aFlags, in boolean aMessageIdsAreUID)
void	setMessageFlags (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL, in ACString aMessageIdentifierList, in imapMessageFlagsType aFlags, in boolean aMessageIdsAreUID)
void	discoverAllFolders (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow, out nsIURI aURL)
void	discoverAllAndSubscribedFolders (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, out nsIURI aURL)
void	discoverChildren (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in ACString folderPath, out nsIURI aURL)
void	onlineMessageCopy (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aSrcFolder, in ACString aMessageIds, in nsIMsgFolder aDstFolder, in boolean aIdsAreUids, in boolean aIsMove, in nsIUrlListener aUrlListener, out nsIURI aURL, in nsISupports aCopyState, in nsIMsgWindow aWindow)
void	appendMessageFromFile (in nsIEventTarget aClientEventTarget, in nsIFile aFile, in nsIMsgFolder aDstFolder, in ACString aMessageId, in boolean idsAreUids, in boolean aInSelectedState, in nsIUrlListener aUrlListener, out nsIURI aURL, in nsISupports aCopyState, in nsIMsgWindow aMsgWindow)
void	downloadMessagesForOffline (in ACString aMessageIds, in nsIMsgFolder aSrcFolder, in nsIUrlListener aListener, in nsIMsgWindow aMsgWindow)
nsIURI	moveFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aSrcFolder, in nsIMsgFolder aDstFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow msgWindow)
nsIURI	renameLeaf (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aSrcFolder, in AString aLeafName, in nsIUrlListener aUrlListener, in nsIMsgWindow msgWindow)
nsIURI	deleteFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow)
nsIURI	createFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aParentFolder, in AString aLeafName, in nsIUrlListener aUrlListener)
nsIURI	listFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in nsIUrlListener aUrlListener)
nsIURI	subscribeFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in AString mailboxName, in nsIUrlListener aUrlListener)
nsIURI	unsubscribeFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in AString mailboxName, in nsIUrlListener aUrlListener)
nsIURI	ensureFolderExists (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aParentFolder, in AString aLeafName, in nsIUrlListener aUrlListener)
nsIURI	getFolderAdminUrl (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in nsIMsgWindow aMsgWindow, in nsIUrlListener aUrlListener)
nsIURI	issueCommandOnMsgs (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in nsIMsgWindow aMsgWindow, in ACString aCommand, in ACString aMessageIdentifierList)
nsIURI	fetchCustomMsgAttribute (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in nsIMsgWindow aMsgWindow, in ACString aAttribute, in ACString aMessageIdentifierList)
nsIURI	storeCustomKeywords (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aMailFolder, in nsIMsgWindow aMsgWindow, in ACString flagsToAdd, in ACString flagsToSubtract, in ACString aMessageIdentifierList)
void	getListOfFoldersOnServer (in nsIImapIncomingServer aServer, in nsIMsgWindow aMsgWindow)
void	getListOfFoldersWithPath (in nsIImapIncomingServer aServer, in nsIMsgWindow aMsgWindow, in ACString folderPath)
nsISupports	playbackAllOfflineOperations (in nsIMsgWindow aMsgWindow, in nsIUrlListener aListener)
void	downloadAllOffineImapFolders (in nsIMsgWindow aMsgWindow, in nsIUrlListener aListener)
Public Attributes
readonly attribute nsICacheSession	cacheSession

---

Member Function Documentation

void nsIImapService::selectFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		in nsIMsgWindow	aMsgWindow,
		out nsIURI	aURL
	)

void nsIImapService::liteSelectFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL
	)

void nsIImapService::fetchMessage	(	in nsIImapUrl	aUrl,
		in nsImapState	aImapAction,
		in nsIMsgFolder	aImapMailFolder,
		in nsIImapMessageSink	aImapMessageSink,
		in nsIMsgWindow	aMsgWindow,
		in nsISupports	aConsumer,
		in ACString	aMessageIdentifierList,
		in boolean	convertDataToText,
		in ACString	additionalHeader,
		out nsIURI	aOutURL
	)

void nsIImapService::noop	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL
	)

void nsIImapService::getHeaders	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in ACString	aMessageIdentifierList,
		in boolean	aMessageIdsAreUID
	)

nsIURI nsIImapService::getBodyStart	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		in ACString	aMessageIdentifierList,
		in long	numBytes
	)

void nsIImapService::expunge	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL
	)

nsIURI nsIImapService::updateFolderStatus	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener
	)

void nsIImapService::biff	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in unsigned long	aUidHighWater
	)

void nsIImapService::deleteMessages	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in ACString	aMessageIdentifierList,
		in boolean	aMessageIdsAreUID
	)

void nsIImapService::deleteAllMessages	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL
	)

void nsIImapService::addMessageFlags	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in ACString	aMessageIdentifierList,
		in imapMessageFlagsType	aFlags,
		in boolean	aMessageIdsAreUID
	)

void nsIImapService::subtractMessageFlags	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in ACString	aMessageIdentifierList,
		in imapMessageFlagsType	aFlags,
		in boolean	aMessageIdsAreUID
	)

void nsIImapService::setMessageFlags	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in ACString	aMessageIdentifierList,
		in imapMessageFlagsType	aFlags,
		in boolean	aMessageIdsAreUID
	)

void nsIImapService::discoverAllFolders	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		in nsIMsgWindow	aMsgWindow,
		out nsIURI	aURL
	)

void nsIImapService::discoverAllAndSubscribedFolders	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL
	)

void nsIImapService::discoverChildren	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aImapMailFolder,
		in nsIUrlListener	aUrlListener,
		in ACString	folderPath,
		out nsIURI	aURL
	)

void nsIImapService::onlineMessageCopy	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aSrcFolder,
		in ACString	aMessageIds,
		in nsIMsgFolder	aDstFolder,
		in boolean	aIdsAreUids,
		in boolean	aIsMove,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in nsISupports	aCopyState,
		in nsIMsgWindow	aWindow
	)

void nsIImapService::appendMessageFromFile	(	in nsIEventTarget	aClientEventTarget,
		in nsIFile	aFile,
		in nsIMsgFolder	aDstFolder,
		in ACString	aMessageId,
		in boolean	idsAreUids,
		in boolean	aInSelectedState,
		in nsIUrlListener	aUrlListener,
		out nsIURI	aURL,
		in nsISupports	aCopyState,
		in nsIMsgWindow	aMsgWindow
	)

void nsIImapService::downloadMessagesForOffline	(	in ACString	aMessageIds,
		in nsIMsgFolder	aSrcFolder,
		in nsIUrlListener	aListener,
		in nsIMsgWindow	aMsgWindow
	)

nsIURI nsIImapService::moveFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aSrcFolder,
		in nsIMsgFolder	aDstFolder,
		in nsIUrlListener	aUrlListener,
		in nsIMsgWindow	msgWindow
	)

nsIURI nsIImapService::renameLeaf	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aSrcFolder,
		in AString	aLeafName,
		in nsIUrlListener	aUrlListener,
		in nsIMsgWindow	msgWindow
	)

nsIURI nsIImapService::deleteFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aFolder,
		in nsIUrlListener	aUrlListener,
		in nsIMsgWindow	aMsgWindow
	)

nsIURI nsIImapService::createFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aParentFolder,
		in AString	aLeafName,
		in nsIUrlListener	aUrlListener
	)

nsIURI nsIImapService::listFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in nsIUrlListener	aUrlListener
	)

nsIURI nsIImapService::subscribeFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in AString	mailboxName,
		in nsIUrlListener	aUrlListener
	)

nsIURI nsIImapService::unsubscribeFolder	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in AString	mailboxName,
		in nsIUrlListener	aUrlListener
	)

nsIURI nsIImapService::ensureFolderExists	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aParentFolder,
		in AString	aLeafName,
		in nsIUrlListener	aUrlListener
	)

nsIURI nsIImapService::getFolderAdminUrl	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in nsIMsgWindow	aMsgWindow,
		in nsIUrlListener	aUrlListener
	)

nsIURI nsIImapService::issueCommandOnMsgs	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in nsIMsgWindow	aMsgWindow,
		in ACString	aCommand,
		in ACString	aMessageIdentifierList
	)

nsIURI nsIImapService::fetchCustomMsgAttribute	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in nsIMsgWindow	aMsgWindow,
		in ACString	aAttribute,
		in ACString	aMessageIdentifierList
	)

nsIURI nsIImapService::storeCustomKeywords	(	in nsIEventTarget	aClientEventTarget,
		in nsIMsgFolder	aMailFolder,
		in nsIMsgWindow	aMsgWindow,
		in ACString	flagsToAdd,
		in ACString	flagsToSubtract,
		in ACString	aMessageIdentifierList
	)

void nsIImapService::getListOfFoldersOnServer	(	in nsIImapIncomingServer	aServer,
		in nsIMsgWindow	aMsgWindow
	)

void nsIImapService::getListOfFoldersWithPath	(	in nsIImapIncomingServer	aServer,
		in nsIMsgWindow	aMsgWindow,
		in ACString	folderPath
	)

nsISupports nsIImapService::playbackAllOfflineOperations	(	in nsIMsgWindow	aMsgWindow,
		in nsIUrlListener	aListener
	)

void nsIImapService::downloadAllOffineImapFolders	(	in nsIMsgWindow	aMsgWindow,
		in nsIUrlListener	aListener
	)

---

Member Data Documentation

readonly attribute nsICacheSession nsIImapService::cacheSession

---

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

• mailnews/imap/public/nsIImapService.idl