Public Member Functions | Public Attributes

nsIImapService Interface Reference

import "nsIImapService.idl";

Collaboration diagram for nsIImapService:

List of all members.

Public Member Functions

void selectFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow, out nsIURI aURL)
nsIURI liteSelectFolder (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow)
 Select the folder on the imap server without doing a sync of flags or headers.
void addImapFetchToUrl (in nsIURI aURL, in nsIMsgFolder aImapMailFolder, in ACString aMessageIdentifierList, in ACString aAdditionalHeader)
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, in nsIMsgWindow aMsgWindow, out nsIURI aURL)
 Issue an EXPUNGE on the target folder.
nsIURI updateFolderStatus (in nsIEventTarget aClientEventTarget, in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener)
 Issue a STATUS on the target folder.
nsIURI verifyLogon (in nsIMsgFolder aImapMailFolder, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow)
 Verify that we can login.
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::addImapFetchToUrl ( in nsIURI  aURL,
in nsIMsgFolder  aImapMailFolder,
in ACString  aMessageIdentifierList,
in ACString  aAdditionalHeader 
)
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::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::biff ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL,
in unsigned long  aUidHighWater 
)
nsIURI nsIImapService::createFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aParentFolder,
in AString  aLeafName,
in nsIUrlListener  aUrlListener 
)
void nsIImapService::deleteAllMessages ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL 
)
nsIURI nsIImapService::deleteFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  aMsgWindow 
)
void nsIImapService::deleteMessages ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL,
in ACString  aMessageIdentifierList,
in boolean  aMessageIdsAreUID 
)
void nsIImapService::discoverAllAndSubscribedFolders ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL 
)
void nsIImapService::discoverAllFolders ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  aMsgWindow,
out nsIURI  aURL 
)
void nsIImapService::discoverChildren ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in ACString  folderPath,
out nsIURI  aURL 
)
void nsIImapService::downloadAllOffineImapFolders ( in nsIMsgWindow  aMsgWindow,
in nsIUrlListener  aListener 
)
void nsIImapService::downloadMessagesForOffline ( in ACString  aMessageIds,
in nsIMsgFolder  aSrcFolder,
in nsIUrlListener  aListener,
in nsIMsgWindow  aMsgWindow 
)
nsIURI nsIImapService::ensureFolderExists ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aParentFolder,
in AString  aLeafName,
in nsIUrlListener  aUrlListener 
)
void nsIImapService::expunge ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  aMsgWindow,
out nsIURI  aURL 
)

Issue an EXPUNGE on the target folder.

Parameters:
aClientEventTarget the event target of the ui thread
aImapMailFolder the folder to expunge
aUrlListener url listener, can be null
aMsgWindow msg window url is running in, can be null
Returns:
the url created to run the expunge.
nsIURI nsIImapService::fetchCustomMsgAttribute ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in nsIMsgWindow  aMsgWindow,
in ACString  aAttribute,
in ACString  aMessageIdentifierList 
)
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 
)
nsIURI nsIImapService::getBodyStart ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in ACString  aMessageIdentifierList,
in long  numBytes 
)
nsIURI nsIImapService::getFolderAdminUrl ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in nsIMsgWindow  aMsgWindow,
in nsIUrlListener  aUrlListener 
)
void nsIImapService::getHeaders ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL,
in ACString  aMessageIdentifierList,
in boolean  aMessageIdsAreUID 
)
void nsIImapService::getListOfFoldersOnServer ( in nsIImapIncomingServer  aServer,
in nsIMsgWindow  aMsgWindow 
)
void nsIImapService::getListOfFoldersWithPath ( in nsIImapIncomingServer  aServer,
in nsIMsgWindow  aMsgWindow,
in ACString  folderPath 
)
nsIURI nsIImapService::issueCommandOnMsgs ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in nsIMsgWindow  aMsgWindow,
in ACString  aCommand,
in ACString  aMessageIdentifierList 
)
nsIURI nsIImapService::listFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in nsIUrlListener  aUrlListener 
)
nsIURI nsIImapService::liteSelectFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  aMsgWindow 
)

Select the folder on the imap server without doing a sync of flags or headers.

This is used for offline playback, where we don't want to download hdrs we don't have, because they may have been offline deleted.

Parameters:
aClientEventTarget the event target of the ui thread
aImapMailFolder the folder to select
aUrlListener url listener, can be null
aMsgWindow msg window url is running in, can be null
Returns:
the url created to run the lite select in.
nsIURI nsIImapService::moveFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aSrcFolder,
in nsIMsgFolder  aDstFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  msgWindow 
)
void nsIImapService::noop ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
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 
)
nsISupports nsIImapService::playbackAllOfflineOperations ( in nsIMsgWindow  aMsgWindow,
in nsIUrlListener  aListener 
)
nsIURI nsIImapService::renameLeaf ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aSrcFolder,
in AString  aLeafName,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  msgWindow 
)
void nsIImapService::selectFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  aMsgWindow,
out nsIURI  aURL 
)
void nsIImapService::setMessageFlags ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL,
in ACString  aMessageIdentifierList,
in imapMessageFlagsType  aFlags,
in boolean  aMessageIdsAreUID 
)
nsIURI nsIImapService::storeCustomKeywords ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in nsIMsgWindow  aMsgWindow,
in ACString  flagsToAdd,
in ACString  flagsToSubtract,
in ACString  aMessageIdentifierList 
)
nsIURI nsIImapService::subscribeFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in AString  mailboxName,
in nsIUrlListener  aUrlListener 
)
void nsIImapService::subtractMessageFlags ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
out nsIURI  aURL,
in ACString  aMessageIdentifierList,
in imapMessageFlagsType  aFlags,
in boolean  aMessageIdsAreUID 
)
nsIURI nsIImapService::unsubscribeFolder ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aMailFolder,
in AString  mailboxName,
in nsIUrlListener  aUrlListener 
)
nsIURI nsIImapService::updateFolderStatus ( in nsIEventTarget  aClientEventTarget,
in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener 
)

Issue a STATUS on the target folder.

Parameters:
aClientEventTarget the event target of the ui thread
aImapMailFolder the folder to expunge
aUrlListener url listener, can be null
Returns:
the url created to run the status.
nsIURI nsIImapService::verifyLogon ( in nsIMsgFolder  aImapMailFolder,
in nsIUrlListener  aUrlListener,
in nsIMsgWindow  aMsgWindow 
)

Verify that we can login.

Parameters:
aImapMailFolder - any old imap folder - we just need it to set url sinks.
aMsgWindow - nsIMsgWindow to use for notification callbacks.
Returns:
- the url that we run.

Member Data Documentation


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