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.

@mozilla.org/messenger/server;1?type=imap

This component implements the following interfaces:

Constants

PRInt32 nsIMsgIncomingServer.defaultSocket = 0
PRInt32 nsIMsgIncomingServer.tryTLS = 1
PRInt32 nsIMsgIncomingServer.alwaysUseTLS = 2
PRInt32 nsIMsgIncomingServer.useSSL = 3
PRInt32 nsIMsgIncomingServer.keepDups = 0
PRInt32 nsIMsgIncomingServer.deleteDups = 1
PRInt32 nsIMsgIncomingServer.moveDupsToTrash = 2
PRInt32 nsIMsgIncomingServer.markDupsRead = 3

Properties

readonly AString nsIMsgIncomingServer.accountManagerChrome

ACString nsIImapIncomingServer.adminUrl

PRBool nsIImapIncomingServer.aOLMailboxView

readonly ACString nsIImapServerSink.arbitraryHeaders

PRBool nsIImapIncomingServer.autoSyncOfflineStores

PRInt32 nsIMsgIncomingServer.biffMinutes

PRUint32 nsIMsgIncomingServer.biffState

readonly PRBool nsIMsgIncomingServer.canBeDefaultServer

readonly PRBool nsIMsgIncomingServer.canCompactFoldersOnServer

PRBool nsIMsgIncomingServer.canCreateFoldersOnServer

PRBool nsIMsgIncomingServer.canDelete

Can this server be removed from the account manager? for instance, local mail is not removable, but an imported folder is

readonly PRBool nsIMsgIncomingServer.canEmptyTrashOnExit

PRBool nsIMsgIncomingServer.canFileMessagesOnServer

readonly PRBool nsIMsgIncomingServer.canHaveFilters

readonly PRBool nsIMsgIncomingServer.canSearchMessages

readonly PRBool nsIMsgIncomingServer.canUndoDeleteOnServer

PRInt32 nsIImapIncomingServer.capabilityPref

PRBool nsIImapIncomingServer.cleanupInboxOnExit

readonly AString nsIMsgIncomingServer.constructedPrettyName

Helper function to construct the pretty name in a server type specific way - e.g., mail for foo@test.com, news on news.mozilla.org

PRBool nsIMsgIncomingServer.defaultCopiesAndFoldersPrefsToServer

If the server supports Fcc/Sent/etc, default prefs can point to the server. Otherwise, copies and folders prefs should point to Local Folders.

By default this value is set to true via global pref 'allows_specialfolders_usage' (mailnews.js). For Nntp, the value is overridden to be false. If ISPs want to modify this value, they should do that in their rdf file by using this attribute. Please look at mozilla/mailnews/base/ispdata/aol.rdf for usage example.

nsMsgImapDeleteModel nsIImapIncomingServer.deleteModel

char nsISubscribableServer.delimiter

PRBool nsIMsgIncomingServer.displayStartupPage

PRBool nsIMsgIncomingServer.doBiff

PRBool nsIImapIncomingServer.doingLsub

PRBool nsIImapIncomingServer.downloadBodiesOnGetNewMail

readonly PRBool nsIMsgIncomingServer.downloadMessagesAtStartup

PRBool nsIMsgIncomingServer.downloadOnBiff

nsIMsgDownloadSettings nsIMsgIncomingServer.downloadSettings

PRBool nsIImapIncomingServer.dualUseFolders

PRBool nsIMsgIncomingServer.emptyTrashOnExit

PRInt32 nsIImapIncomingServer.emptyTrashThreshhold

PRBool nsIImapIncomingServer.fetchByChunks

readonly nsMsgSearchScopeValue nsIMsgIncomingServer.filterScope

ACString nsIMsgIncomingServer.hostName

Hostname of the server

PRInt32 nsIMsgIncomingServer.incomingDuplicateAction

PRBool nsIImapIncomingServer.isAOLServer

readonly PRBool nsIMsgIncomingServer.isDeferredTo

PRBool nsIMsgIncomingServer.isSecure

readonly PRBool nsIMsgIncomingServer.isSecureServer

ACString nsIMsgIncomingServer.key

Internal pref key - guaranteed to be unique across all servers

PRBool nsIMsgIncomingServer.limitOfflineMessageSize

nsILocalFile nsIMsgIncomingServer.localPath

readonly ACString nsIMsgIncomingServer.localStoreType

The schema for the local mail store, such as "mailbox", "imap", or "news" used to construct URIs

PRBool nsIMsgIncomingServer.loginAtStartUp

PRBool nsIMsgIncomingServer.logonFallback

ACString nsIImapIncomingServer.manageMailAccountUrl

PRInt32 nsIImapIncomingServer.maximumConnectionsNumber

PRInt32 nsIMsgIncomingServer.maxMessageSize

PRBool nsIImapIncomingServer.mimePartsOnDemand

PRBool nsIImapIncomingServer.offlineDownload

PRInt32 nsIMsgIncomingServer.offlineSupportLevel

ACString nsIImapIncomingServer.otherUsersNamespace

PRBool nsIImapIncomingServer.overrideNamespaces

ACString nsIMsgIncomingServer.password

readonly PRBool nsIMsgIncomingServer.passwordPromptRequired

If the password for the server is available either via authentication in the current session or from password manager stored entries, return false. Otherwise, return true. If password is obtained from password manager, set the password member variable.

PRBool nsIMsgIncomingServer.performingBiff

ACString nsIImapIncomingServer.personalNamespace

PRInt32 nsIMsgIncomingServer.port

AString nsIMsgIncomingServer.prettyName

Pretty name - should be "userid on hostname" if the pref is not set

ACString nsIImapIncomingServer.publicNamespace

ACString nsIMsgIncomingServer.realHostName

Real hostname of the server (if server name is changed it's stored here)

ACString nsIMsgIncomingServer.realUsername

Real username of the server (if username is changed it's stored here)

ACString nsIMsgIncomingServer.redirectorType

PRBool nsIMsgIncomingServer.rememberPassword

nsIMsgRetentionSettings nsIMsgIncomingServer.retentionSettings

nsIMsgFolder nsIMsgIncomingServer.rootFolder

readonly nsIMsgFolder nsIMsgIncomingServer.rootMsgFolder

readonly nsMsgSearchScopeValue nsIMsgIncomingServer.searchScope

PRBool nsIMsgIncomingServer.serverBusy

ACString nsIImapIncomingServer.serverDirectory

readonly PRBool nsIMsgIncomingServer.serverRequiresPasswordForBiff

readonly ACString nsIMsgIncomingServer.serverURI

readonly PRBool nsIImapServerSink.showAttachmentsInline

PRBool nsIImapIncomingServer.shuttingDown

PRInt32 nsIMsgIncomingServer.socketType

readonly nsIMsgFilterPlugin nsIMsgIncomingServer.spamFilterPlugin

readonly nsISpamSettings nsIMsgIncomingServer.spamSettings

Spam settings

PRBool nsIImapIncomingServer.storeReadMailInPFC

PRBool nsIImapIncomingServer.storeSentMailInPFC

nsISubscribeListener nsISubscribableServer.subscribeListener

readonly PRBool nsIMsgIncomingServer.supportsDiskSpace

readonly PRBool nsISubscribableServer.supportsSubscribeSearch

PRInt32 nsIImapIncomingServer.timeOutLimits

AString nsIImapIncomingServer.trashFolderName

ACString nsIMsgIncomingServer.type

Protocol type, i.e. "pop3", "imap", "nntp", "none", etc used to construct URLs

PRBool nsIImapIncomingServer.useIdle

PRBool nsIImapServerSink.userAuthenticated

ACString nsIMsgIncomingServer.username

Userid to log into the server

PRBool nsIMsgIncomingServer.useSecAuth

PRBool nsIImapIncomingServer.usingSubscription

PRBool nsIMsgIncomingServer.valid

Methods

InterfaceMethod
nsIImapServerSink void abortQueuedUrls ( )
nsIImapServerSink void addFolderRights ( ACString folderPath , ACString userName , ACString rights )
nsISubscribableServer void addTo ( AUTF8String name , PRBool addAsSubscribed , PRBool subscribable , PRBool changeIfExists )
nsIImapIncomingServer void allowFolderConversion ( out PRBool allowConversion )
nsIMsgIncomingServer void clearAllValues ( )
nsIMsgIncomingServer void clearTemporaryReturnReceiptsFilter ( )
nsIMsgIncomingServer void closeCachedConnections ( )
nsIImapIncomingServer void CloseConnectionForFolder ( nsIMsgFolder msgFolder )
nsIImapServerSink void commitNamespaces ( )
nsISubscribableServer void commitSubscribeChanges ( )
nsIMsgIncomingServer void configureTemporaryFilters ( nsIMsgFilterList filterList )
nsIImapIncomingServer void convertFolderName ( ACString originalName , out AString convertedName )
nsIImapServerSink char* cramMD5Hash ( char* decodedChallenge , char* key )
nsIImapServerSink void discoveryDone ( )
nsIMsgIncomingServer void displayOfflineMsg ( nsIMsgWindow window )
nsIMsgIncomingServer PRBool equals ( nsIMsgIncomingServer server )
nsIImapServerSink void fEAlert ( AString string , nsIMsgWindow msgWindow )
nsIImapServerSink void fEAlertFromServer ( ACString string , nsIMsgWindow msgWindow )
nsIImapServerSink PRBool folderIsNoSelect ( ACString folderName )
nsIImapServerSink PRBool folderNeedsACLInitialized ( ACString folderPath )
nsIImapServerSink PRBool folderVerifiedOnline ( ACString folderName )
nsIMsgIncomingServer void forgetPassword ( )
nsIMsgIncomingServer void forgetSessionPassword ( )
nsIImapServerSink AString formatStringWithHostNameByID ( PRInt32 msgId )
nsIMsgIncomingServer AString generatePrettyNameForMigration ( )
nsIMsgIncomingServer PRBool getBoolAttribute ( char* name )
nsIMsgIncomingServer PRBool getBoolValue ( char* attr )
nsIMsgIncomingServer ACString getCharAttribute ( char* name )
nsIMsgIncomingServer ACString getCharValue ( char* attr )
nsISubscribableServer nsISimpleEnumerator getChildren ( AUTF8String path )
nsIMsgIncomingServer nsILocalFile getFileValue ( char* relpref , char* abspref )
nsIMsgIncomingServer nsIMsgFilterList getFilterList ( nsIMsgWindow msgWindow )
nsISubscribableServer AUTF8String getFirstChildURI ( AUTF8String path )
nsIImapIncomingServer void GetImapConnectionAndLoadUrl ( nsIEventTarget clientEventTarget , nsIImapUrl imapUrl , nsISupports consumer )
nsIImapServerSink AString getImapStringByID ( PRInt32 msgId )
nsIMsgIncomingServer PRInt32 getIntAttribute ( char* name )
nsIMsgIncomingServer PRInt32 getIntValue ( char* attr )
nsIImapIncomingServer PRBool getIsPFC ( ACString folderName )
nsISubscribableServer AString getLeafName ( AUTF8String path )
nsIMsgIncomingServer nsIMsgFolder getMsgFolderFromURI ( nsIMsgFolder folderResource , ACString URI )
nsIMsgIncomingServer void getNewMessages ( nsIMsgFolder folder , nsIMsgWindow msgWindow , nsIUrlListener urlListener )
nsIImapIncomingServer void GetNewMessagesForNonInboxFolders ( nsIMsgFolder rootFolder , nsIMsgWindow window , PRBool forceAllFolders , PRBool performingBiff )
nsIMsgIncomingServer ACString getPasswordWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow , out PRBool okayValue )
nsIImapIncomingServer nsIMsgFolder getPFC ( PRBool createIfMissing )
nsIImapIncomingServer nsIMsgFolder GetReadMailPFC ( PRBool createIfMissing )
nsIImapIncomingServer nsIMsgFolder GetSentMailPFC ( PRBool createIfMissing )
nsIImapIncomingServer ACString getTrashFolderByRedirectorType ( )
nsIMsgIncomingServer AString getUnicharAttribute ( char* name )
nsIMsgIncomingServer AString getUnicharValue ( char* attr )
nsIImapIncomingServer ACString getUriWithNamespacePrefixIfNecessary ( PRInt32 namespaceType , ACString originalUri )
nsISupportsWeakReference nsIWeakReference GetWeakReference ( )
nsISubscribableServer PRBool hasChildren ( AUTF8String path )
nsIImapIncomingServer void hideFolderName ( ACString originalName , out PRBool hideFolder )
nsIMsgIncomingServer PRBool isNewHdrDuplicate ( nsIMsgDBHdr newHdr )
nsISubscribableServer PRBool isSubscribable ( AUTF8String path )
nsISubscribableServer PRBool isSubscribed ( AUTF8String path )
nsIImapServerSink PRBool loadNextQueuedUrl ( nsIImapProtocol protocol )
nsIImapServerSink void onlineFolderCreateFailed ( ACString folderName )
nsIImapServerSink void onlineFolderDelete ( ACString folderName )
nsIImapServerSink void onlineFolderRename ( nsIMsgWindow msgWindow , ACString oldName , ACString newName )
nsIMsgLogonRedirectionRequester void OnLogonRedirectionError ( PRUnichar* pErrMsg , PRBool badPassword )
nsIMsgLogonRedirectionRequester void OnLogonRedirectionProgress ( nsMsgLogonRedirectionState pState )
nsIMsgLogonRedirectionRequester void OnLogonRedirectionReply ( PRUnichar* pHost , PRUint16 pPort , char* pCookieData , PRUint16 pCookieSize )
nsIUrlListener void OnStartRunningUrl ( nsIURI url )
nsIUrlListener void OnStopRunningUrl ( nsIURI url , nsresult exitCode )
nsIMsgIncomingServer void onUserOrHostNameChanged ( ACString oldName , ACString newName )
nsIMsgIncomingServer void performBiff ( nsIMsgWindow msgWindow )
nsIMsgIncomingServer void performExpand ( nsIMsgWindow msgWindow )
nsIImapServerSink PRBool possibleImapMailbox ( ACString folderPath , PRUnichar hierarchyDelim , PRInt32 boxFlags )
nsIImapServerSink void promptForPassword ( out ACString string , nsIMsgWindow msgWindow )
nsIImapIncomingServer void pseudoInterruptMsgLoad ( nsIMsgFolder imapFolder , nsIMsgWindow msgWindow , out PRBool interrupted )
nsIImapIncomingServer void reDiscoverAllFolders ( )
nsIImapServerSink void refreshFolderRights ( ACString folderPath )
nsIImapIncomingServer void RemoveConnection ( nsIImapProtocol imapConnection )
nsIMsgIncomingServer void removeFiles ( )
nsIImapIncomingServer void ResetConnection ( ACString folderName )
nsIImapIncomingServer void ResetNamespaceReferences ( )
nsIImapServerSink void retryUrl ( nsIImapUrl imapUrl )
nsISubscribableServer void setAsSubscribed ( AUTF8String path )
nsIMsgIncomingServer void setBoolAttribute ( char* name , PRBool value )
nsIMsgIncomingServer void setBoolValue ( char* attr , PRBool value )
nsIImapServerSink void setCapability ( PRUint32 capability )
nsIMsgIncomingServer void setCharAttribute ( char* name , ACString value )
nsIMsgIncomingServer void setCharValue ( char* attr , ACString value )
nsIMsgIncomingServer void setDefaultLocalPath ( nsILocalFile defaultLocalPath )
nsIMsgIncomingServer void setFileValue ( char* relpref , char* abspref , nsILocalFile value )
nsIMsgIncomingServer void setFilterList ( nsIMsgFilterList filterList )
nsIImapServerSink void setFolderAdminURL ( ACString folderName , ACString adminUrl )
nsISubscribableServer void setIncomingServer ( nsIMsgIncomingServer server )
nsIMsgIncomingServer void setIntAttribute ( char* name , PRInt32 value )
nsIMsgIncomingServer void setIntValue ( char* attr , PRInt32 value )
nsIImapServerSink void setMailServerUrls ( ACString manageMailAccount , ACString manageLists , ACString manageFilters )
nsISubscribableServer void setSearchValue ( AString searchValue )
nsISubscribableServer void setShowFullName ( PRBool showFullName )
nsISubscribableServer PRBool setState ( AUTF8String path , PRBool state )
nsIMsgIncomingServer void setUnicharAttribute ( char* name , AString value )
nsIMsgIncomingServer void setUnicharValue ( char* attr , AString value )
nsIMsgIncomingServer void shutdown ( )
nsISubscribableServer void startPopulating ( nsIMsgWindow msgWindow , PRBool forceToServer , PRBool getOnlyNew )
nsISubscribableServer void startPopulatingWithUri ( nsIMsgWindow msgWindow , PRBool forceToServer , char* uri )
nsISubscribableServer void stopPopulating ( nsIMsgWindow msgWindow )
nsIMsgIncomingServer void storePassword ( )
nsISubscribableServer void subscribe ( PRUnichar* name )
nsISubscribableServer void subscribeCleanup ( )
nsIImapIncomingServer nsIURI subscribeToFolder ( AString name , PRBool subscribe )
nsIMsgIncomingServer AString toString ( )
nsISubscribableServer void unsubscribe ( PRUnichar* name )
nsISubscribableServer void updateSubscribed ( )
nsIMsgIncomingServer void writeToFolderCache ( nsIMsgFolderCache folderCache )

Reference documentation is generated from Mozilla's source.