nsIMsgIncomingServer
| IID: | 5A1D6341-E808-4e1c-A587-D65C5898B532 |
| Inherits From: | nsISupports |
This interface is implemented by the following components:
Constants
| PRInt32 | defaultSocket | = 0 |
| PRInt32 | tryTLS | = 1 |
| PRInt32 | alwaysUseTLS | = 2 |
| PRInt32 | useSSL | = 3 |
| PRInt32 | keepDups | = 0 |
| PRInt32 | deleteDups | = 1 |
| PRInt32 | moveDupsToTrash | = 2 |
| PRInt32 | markDupsRead | = 3 |
Properties
readonly AString accountManagerChrome
PRInt32 biffMinutes
PRUint32 biffState
readonly PRBool canBeDefaultServer
readonly PRBool canCompactFoldersOnServer
PRBool canCreateFoldersOnServer
PRBool canDelete
Can this server be removed from the account manager? for instance, local mail is not removable, but an imported folder is
readonly PRBool canEmptyTrashOnExit
PRBool canFileMessagesOnServer
readonly PRBool canHaveFilters
readonly PRBool canSearchMessages
readonly PRBool canUndoDeleteOnServer
readonly AString 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 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.
PRBool displayStartupPage
PRBool doBiff
readonly PRBool downloadMessagesAtStartup
PRBool downloadOnBiff
nsIMsgDownloadSettings downloadSettings
PRBool emptyTrashOnExit
readonly nsMsgSearchScopeValue filterScope
ACString hostName
Hostname of the server
PRInt32 incomingDuplicateAction
readonly PRBool isDeferredTo
PRBool isSecure
readonly PRBool isSecureServer
ACString key
Internal pref key - guaranteed to be unique across all servers
PRBool limitOfflineMessageSize
nsILocalFile localPath
readonly ACString localStoreType
The schema for the local mail store, such as "mailbox", "imap", or "news" used to construct URIs
PRBool loginAtStartUp
PRBool logonFallback
PRInt32 maxMessageSize
PRInt32 offlineSupportLevel
ACString password
readonly PRBool 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 performingBiff
PRInt32 port
AString prettyName
Pretty name - should be "userid on hostname" if the pref is not set
ACString realHostName
Real hostname of the server (if server name is changed it's stored here)
ACString realUsername
Real username of the server (if username is changed it's stored here)
ACString redirectorType
PRBool rememberPassword
nsIMsgRetentionSettings retentionSettings
nsIMsgFolder rootFolder
readonly nsIMsgFolder rootMsgFolder
readonly nsMsgSearchScopeValue searchScope
PRBool serverBusy
readonly PRBool serverRequiresPasswordForBiff
readonly ACString serverURI
PRInt32 socketType
readonly nsIMsgFilterPlugin spamFilterPlugin
readonly nsISpamSettings spamSettings
Spam settings
readonly PRBool supportsDiskSpace
ACString type
Protocol type, i.e. "pop3", "imap", "nntp", "none", etc used to construct URLs
ACString username
Userid to log into the server
PRBool useSecAuth
PRBool valid
Methods
void clearAllValues ( )
void clearTemporaryReturnReceiptsFilter ( )
void closeCachedConnections ( )
void configureTemporaryFilters ( nsIMsgFilterList filterList )
void displayOfflineMsg ( nsIMsgWindow window )
PRBool equals ( nsIMsgIncomingServer server )
void forgetPassword ( )
void forgetSessionPassword ( )
AString generatePrettyNameForMigration ( )
PRBool getBoolAttribute ( char* name )
PRBool getBoolValue ( char* attr )
ACString getCharAttribute ( char* name )
ACString getCharValue ( char* attr )
nsILocalFile getFileValue ( char* relpref , char* abspref )
nsIMsgFilterList getFilterList ( nsIMsgWindow msgWindow )
PRInt32 getIntAttribute ( char* name )
PRInt32 getIntValue ( char* attr )
nsIMsgFolder getMsgFolderFromURI ( nsIMsgFolder folderResource , ACString URI )
void getNewMessages ( nsIMsgFolder folder , nsIMsgWindow msgWindow , nsIUrlListener urlListener )
ACString getPasswordWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow , out PRBool okayValue )
AString getUnicharAttribute ( char* name )
AString getUnicharValue ( char* attr )
PRBool isNewHdrDuplicate ( nsIMsgDBHdr newHdr )
void onUserOrHostNameChanged ( ACString oldName , ACString newName )
void performBiff ( nsIMsgWindow msgWindow )
void performExpand ( nsIMsgWindow msgWindow )
void removeFiles ( )
void setBoolAttribute ( char* name , PRBool value )
void setBoolValue ( char* attr , PRBool value )
void setCharAttribute ( char* name , ACString value )
void setCharValue ( char* attr , ACString value )
void setDefaultLocalPath ( nsILocalFile defaultLocalPath )
void setFileValue ( char* relpref , char* abspref , nsILocalFile value )
void setFilterList ( nsIMsgFilterList filterList )
void setIntAttribute ( char* name , PRInt32 value )
void setIntValue ( char* attr , PRInt32 value )
void setUnicharAttribute ( char* name , AString value )
void setUnicharValue ( char* attr , AString value )
void shutdown ( )
void storePassword ( )
AString toString ( )
void writeToFolderCache ( nsIMsgFolderCache folderCache )
This is really dangerous. this destroys all pref values do not call this unless you know what you're doing!
void clearTemporaryReturnReceiptsFilter ( )
If Sent folder pref is changed we need to clear the temporary return receipt filter so that the new return receipt filter can be recreated (by ConfigureTemporaryReturnReceiptsFilter()).
void configureTemporaryFilters ( nsIMsgFilterList filterList )
For mail, this configures both the MDN filter, and the server-side spam filter filters, if needed.
If we have set up to filter return receipts into our Sent folder, this utility method creates a filter to do that, and adds it to our filterList if it doesn't exist. If it does, it will enable it.
This is not used by news filters (yet).
- Arguments:
- filterList
void displayOfflineMsg ( nsIMsgWindow window )
- Arguments:
- window
nsILocalFile getFileValue ( char* relpref , char* abspref )
- Arguments:
- relpref
- abspref
nsIMsgFilterList getFilterList ( nsIMsgWindow msgWindow )
- Arguments:
- msgWindow
nsIMsgFolder getMsgFolderFromURI ( nsIMsgFolder folderResource , ACString URI )
- Arguments:
- folderResource
- URI
void getNewMessages ( nsIMsgFolder folder , nsIMsgWindow msgWindow , nsIUrlListener urlListener )
- Arguments:
- folder
- msgWindow
- urlListener
ACString getPasswordWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow , out PRBool okayValue )
- Arguments:
- promptString
- promptTitle
- msgWindow
- okayValue
AString getUnicharAttribute ( char* name )
These generic getter / setters, useful for extending mailnews note, these attributes persist across sessions
- Arguments:
- name
PRBool isNewHdrDuplicate ( nsIMsgDBHdr newHdr )
- Arguments:
- newHdr
void performBiff ( nsIMsgWindow msgWindow )
- Arguments:
- msgWindow
void performExpand ( nsIMsgWindow msgWindow )
- Arguments:
- msgWindow
This is also very dangerous. this will remove the files associated with this server on disk.
void setDefaultLocalPath ( nsILocalFile defaultLocalPath )
- Arguments:
- defaultLocalPath
void setFileValue ( char* relpref , char* abspref , nsILocalFile value )
- Arguments:
- relpref
- abspref
- value
void setFilterList ( nsIMsgFilterList filterList )
- Arguments:
- filterList
void writeToFolderCache ( nsIMsgFolderCache folderCache )
- Arguments:
- folderCache
References
This interface is the type of the following properties:
nsIMsgAccount.incomingServer, nsIMsgAccountManager.localFoldersServer, nsIMsgFolder.server, nsIMsgMailNewsUrl.server
This interface is passed as an argument to the following methods:
nsIIncomingServerListener.onServerChanged, nsIIncomingServerListener.onServerLoaded, nsIIncomingServerListener.onServerUnloaded, nsIMsgAccountManager.FindAccountForServer, nsIMsgAccountManager.FindServerIndex, nsIMsgAccountManager.GetIdentitiesForServer, nsIMsgAccountManager.getFirstIdentityForServer, nsIMsgAccountManager.notifyServerChanged, nsIMsgAccountManager.notifyServerLoaded, nsIMsgAccountManager.notifyServerUnloaded, nsIMsgAccountManagerExtension.showPanel, nsIMsgBiffManager.addServerBiff, nsIMsgBiffManager.forceBiff, nsIMsgBiffManager.removeServerBiff, nsIMsgComposeService.forwardMessage, nsIMsgComposeService.replyWithTemplate, nsIMsgIncomingServer.equals, nsISpamSettings.initialize, nsISubscribableServer.setIncomingServer
This interface is returned from the following methods:
nsIMsgAccountManager.FindServer, nsIMsgAccountManager.createIncomingServer, nsIMsgAccountManager.findRealServer, nsIMsgAccountManager.findServerByURI, nsIMsgAccountManager.getIncomingServer
Reference documentation is generated from Mozilla's source.
