Public Member Functions | Public Attributes

nsIImapServerSink Interface Reference

nsIImapServerSink is designed to be used as a proxy to the application's UI thread from the running IMAP threads. More...

import "nsIImapServerSink.idl";

List of all members.

Public Member Functions

boolean possibleImapMailbox (in ACString folderPath, in char hierarchyDelimiter, in long boxFlags)
 Check if the given folder path is a possible IMAP mailbox.
boolean folderNeedsACLInitialized (in ACString folderPath)
void addFolderRights (in ACString folderPath, in ACString userName, in ACString rights)
void refreshFolderRights (in ACString folderPath)
void discoveryDone ()
void onlineFolderDelete (in ACString folderName)
void onlineFolderCreateFailed (in ACString aFolderName)
void onlineFolderRename (in nsIMsgWindow msgWindow, in ACString oldName, in ACString newName)
boolean folderIsNoSelect (in ACString folderName)
void setFolderAdminURL (in ACString folderName, in ACString adminUrl)
boolean folderVerifiedOnline (in ACString folderName)
void setCapability (in unsigned long capability)
boolean loadNextQueuedUrl (in nsIImapProtocol protocol)
nsIImapMockChannel prepareToRetryUrl (in nsIImapUrl imapUrl)
 Prepare to retry the given URL.
void retryUrl (in nsIImapUrl imapUrl, in nsIImapMockChannel channel)
 Retry the given URL.
void abortQueuedUrls ()
 If previous URL failed, this gives server chance to abort URLs with same mock channel.
AString getImapStringByID (in long msgId)
PRInt32 promptLoginFailed (in nsIMsgWindow aMsgWindow)
 Alerts the user that the login to the IMAP server failed.
void fEAlert (in AString aAlertSring, in nsIMsgMailNewsUrl aUrl)
 Alerts the user with the given string (FE = 'Front End').
void fEAlertWithID (in long aMsgId, in nsIMsgMailNewsUrl aUrl)
 Alerts the user with a localized string.
void fEAlertFromServer (in ACString aServerString, in nsIMsgMailNewsUrl aUrl)
 Takes a response from the server and prepends it with IMAP_SERVER_SAID.
void commitNamespaces ()
void promptForPassword (out ACString promptString, in nsIMsgWindow msgWindow)
void setMailServerUrls (in ACString manageMailAccount, in ACString manageLists, in ACString manageFilters)
void forgetPassword ()
string cramMD5Hash (in string decodedChallenge, in string key)

Public Attributes

attribute boolean userAuthenticated
readonly attribute ACString arbitraryHeaders
readonly attribute boolean showAttachmentsInline
readonly attribute ACString loginUsername
 String to send to the imap server as the login user name.

Detailed Description

nsIImapServerSink is designed to be used as a proxy to the application's UI thread from the running IMAP threads.


Member Function Documentation

void nsIImapServerSink::abortQueuedUrls (  ) 

If previous URL failed, this gives server chance to abort URLs with same mock channel.

void nsIImapServerSink::addFolderRights ( in ACString  folderPath,
in ACString  userName,
in ACString  rights 
)
void nsIImapServerSink::commitNamespaces (  ) 
string nsIImapServerSink::cramMD5Hash ( in string  decodedChallenge,
in string  key 
)
void nsIImapServerSink::discoveryDone (  ) 
void nsIImapServerSink::fEAlert ( in AString  aAlertSring,
in nsIMsgMailNewsUrl  aUrl 
)

Alerts the user with the given string (FE = 'Front End').

Parameters:
aAlertSring The string to alert the user with.
aUrl The running url.
void nsIImapServerSink::fEAlertFromServer ( in ACString  aServerString,
in nsIMsgMailNewsUrl  aUrl 
)

Takes a response from the server and prepends it with IMAP_SERVER_SAID.

Parameters:
aServerString The string to alert the user with.
url The running url.
void nsIImapServerSink::fEAlertWithID ( in long  aMsgId,
in nsIMsgMailNewsUrl  aUrl 
)

Alerts the user with a localized string.

It will attempt to fill in the hostname into the string if necessary.

Parameters:
aMsgId The id of the string to present to the user..
aUrl The running url.
boolean nsIImapServerSink::folderIsNoSelect ( in ACString  folderName  ) 
boolean nsIImapServerSink::folderNeedsACLInitialized ( in ACString  folderPath  ) 
boolean nsIImapServerSink::folderVerifiedOnline ( in ACString  folderName  ) 
void nsIImapServerSink::forgetPassword (  ) 
AString nsIImapServerSink::getImapStringByID ( in long  msgId  ) 
boolean nsIImapServerSink::loadNextQueuedUrl ( in nsIImapProtocol  protocol  ) 
void nsIImapServerSink::onlineFolderCreateFailed ( in ACString  aFolderName  ) 
void nsIImapServerSink::onlineFolderDelete ( in ACString  folderName  ) 
void nsIImapServerSink::onlineFolderRename ( in nsIMsgWindow  msgWindow,
in ACString  oldName,
in ACString  newName 
)
boolean nsIImapServerSink::possibleImapMailbox ( in ACString  folderPath,
in char  hierarchyDelimiter,
in long  boxFlags 
)

Check if the given folder path is a possible IMAP mailbox.

Parameters:
folderPath folder path to check
hierarchyDelimiter IMAP hierarchy delimiter in canonical format, i.e., hierarchy delimiter has been replaced with '/'
boxFlags IMAP folder flags (for subscription, namespaces etc.)
Returns:
true if it's a new mailbox
nsIImapMockChannel nsIImapServerSink::prepareToRetryUrl ( in nsIImapUrl  imapUrl  ) 

Prepare to retry the given URL.

Parameters:
imapUrl the url we're going to retry
Returns:
channel to associate with the url. We return this because access to the channel should only happen on the ui thread.
void nsIImapServerSink::promptForPassword ( out ACString  promptString,
in nsIMsgWindow  msgWindow 
)
PRInt32 nsIImapServerSink::promptLoginFailed ( in nsIMsgWindow  aMsgWindow  ) 

Alerts the user that the login to the IMAP server failed.

Asks whether the connection should: retry, cancel, or request a new password.

Parameters:
aMsgWindow The message window associated with this action (cannot be null).
Returns:
The button pressed. 0 for retry, 1 for cancel, 2 for enter a new password.
void nsIImapServerSink::refreshFolderRights ( in ACString  folderPath  ) 
void nsIImapServerSink::retryUrl ( in nsIImapUrl  imapUrl,
in nsIImapMockChannel  channel 
)

Retry the given URL.

Parameters:
imapUrl url to retry
channel the channel to associate with the url
void nsIImapServerSink::setCapability ( in unsigned long  capability  ) 
void nsIImapServerSink::setFolderAdminURL ( in ACString  folderName,
in ACString  adminUrl 
)
void nsIImapServerSink::setMailServerUrls ( in ACString  manageMailAccount,
in ACString  manageLists,
in ACString  manageFilters 
)

Member Data Documentation

readonly attribute ACString nsIImapServerSink::arbitraryHeaders
readonly attribute ACString nsIImapServerSink::loginUsername

String to send to the imap server as the login user name.


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