nsIMsgIncomingServer

IID:60dcb100-e3f2-11d2-b7fc-00805f05ffa5
Inherits From:nsISupports

This interface is implemented by the following components:


Properties

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 PRUnichar* 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

char* hostName

Hostname of the server

PRBool isSecure

readonly PRBool isSecureServer

char* key

Internal pref key - guaranteed to be unique across all servers

PRBool limitOfflineMessageSize

nsIFileSpec localPath

readonly char* localStoreType

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

PRBool loginAtStartUp

PRInt32 maxMessageSize

PRInt32 offlineSupportLevel

char* 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

PRUnichar* prettyName

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

char* realHostName

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

char* realUsername

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

char* redirectorType

PRBool rememberPassword

nsIMsgRetentionSettings retentionSettings

nsIMsgFolder rootFolder

readonly nsIMsgFolder rootMsgFolder

readonly nsMsgSearchScopeValue searchScope

PRBool serverBusy

readonly PRBool serverRequiresPasswordForBiff

readonly char* serverURI

readonly nsIMsgFilterPlugin spamFilterPlugin

nsISpamSettings spamSettings

Spam settings

readonly PRBool supportsDiskSpace

char* type

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

char* username

Userid to log into the server

PRBool useSecAuth

PRBool valid


Methods

void clearAllValues ( ) void clearTemporaryReturnReceiptsFilter ( ) void CloseCachedConnections ( ) void configureTemporaryReturnReceiptsFilter ( nsIMsgFilterList filterList ) void displayOfflineMsg ( nsIMsgWindow window ) PRBool equals ( nsIMsgIncomingServer server ) void forgetPassword ( ) void forgetSessionPassword ( ) PRUnichar* generatePrettyNameForMigration ( ) PRBool getBoolAttribute ( char* name ) PRBool getBoolValue ( char* attr ) char* getCharAttribute ( char* name ) char* getCharValue ( char* attr ) nsIFileSpec getFileValue ( char* attr ) nsIMsgFilterList getFilterList ( nsIMsgWindow msgWindow ) PRInt32 getIntAttribute ( char* name ) PRInt32 getIntValue ( char* attr ) nsIMsgFolder getMsgFolderFromURI ( nsIMsgFolder folderResource , char* URI ) char* getPasswordWithUI ( PRUnichar* promptString , PRUnichar* promptTitle , nsIMsgWindow msgWindow , out PRBool okayValue ) PRUnichar* getUnicharAttribute ( char* name ) PRUnichar* getUnicharValue ( char* attr ) void OnUserOrHostNameChanged ( char* oldName , char* 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 , char* value ) void setCharValue ( char* attr , char* value ) void SetDefaultLocalPath ( nsIFileSpec defaultLocalPath ) void setFileValue ( char* attr , nsIFileSpec value ) void setFilterList ( nsIMsgFilterList filterList ) void setIntAttribute ( char* name , PRInt32 value ) void setIntValue ( char* attr , PRInt32 value ) void setUnicharAttribute ( char* name , PRUnichar* value ) void setUnicharValue ( char* attr , PRUnichar* value ) void shutdown ( ) void storePassword ( ) PRUnichar* toString ( ) void WriteToFolderCache ( nsIMsgFolderCache folderCache )

void clearAllValues ( )

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 CloseCachedConnections ( )


void configureTemporaryReturnReceiptsFilter ( nsIMsgFilterList filterList )

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.

If the user changes their prefs, to leave the return receipt in the inbox, this will disable the existing return receipts filter, if it exists.

Arguments:
filterList

void displayOfflineMsg ( nsIMsgWindow window )

Arguments:
window

PRBool equals ( nsIMsgIncomingServer server )

Arguments:
server

void forgetPassword ( )


void forgetSessionPassword ( )


PRUnichar* generatePrettyNameForMigration ( )


PRBool getBoolAttribute ( char* name )

Arguments:
name

PRBool getBoolValue ( char* attr )

Arguments:
attr

char* getCharAttribute ( char* name )

Arguments:
name

char* getCharValue ( char* attr )

Arguments:
attr

nsIFileSpec getFileValue ( char* attr )

Arguments:
attr

nsIMsgFilterList getFilterList ( nsIMsgWindow msgWindow )

Arguments:
msgWindow

PRInt32 getIntAttribute ( char* name )

Arguments:
name

PRInt32 getIntValue ( char* attr )

Arguments:
attr

nsIMsgFolder getMsgFolderFromURI ( nsIMsgFolder folderResource , char* URI )

Arguments:
folderResource
URI

char* getPasswordWithUI ( PRUnichar* promptString , PRUnichar* promptTitle , nsIMsgWindow msgWindow , out PRBool okayValue )

Arguments:
promptString
promptTitle
msgWindow
okayValue

PRUnichar* getUnicharAttribute ( char* name )

These generic getter / setters, useful for extending mailnews note, these attributes persist across sessions

Arguments:
name

PRUnichar* getUnicharValue ( char* attr )

Arguments:
attr

void OnUserOrHostNameChanged ( char* oldName , char* newName )

Arguments:
oldName
newName

void PerformBiff ( nsIMsgWindow msgWindow )

Arguments:
msgWindow

void performExpand ( nsIMsgWindow msgWindow )

Arguments:
msgWindow

void removeFiles ( )

This is also very dangerous. this will remove the files associated with this server on disk.


void setBoolAttribute ( char* name , PRBool value )

Arguments:
name
value

void setBoolValue ( char* attr , PRBool value )

Arguments:
attr
value

void setCharAttribute ( char* name , char* value )

Arguments:
name
value

void setCharValue ( char* attr , char* value )

Arguments:
attr
value

void SetDefaultLocalPath ( nsIFileSpec defaultLocalPath )

Arguments:
defaultLocalPath

void setFileValue ( char* attr , nsIFileSpec value )

Arguments:
attr
value

void setFilterList ( nsIMsgFilterList filterList )

Arguments:
filterList

void setIntAttribute ( char* name , PRInt32 value )

Arguments:
name
value

void setIntValue ( char* attr , PRInt32 value )

Arguments:
attr
value

void setUnicharAttribute ( char* name , PRUnichar* value )

Arguments:
name
value

void setUnicharValue ( char* attr , PRUnichar* value )

Arguments:
attr
value

void shutdown ( )


void storePassword ( )

Logon succeeded - persist password, if user chooses.


PRUnichar* toString ( )


void WriteToFolderCache ( nsIMsgFolderCache folderCache )

Arguments:
folderCache

References

This interface is the type of the following properties:

nsIMsgAccount.incomingServer, nsIMsgAccountManager.localFoldersServer, nsIMsgFolder.server, nsIMsgMailNewsUrl.server, nsISpamSettings.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, nsIMsgIncomingServer.equals, nsISubscribableServer.setIncomingServer

This interface is returned from the following methods:

nsIMsgAccountManager.FindServer, nsIMsgAccountManager.createIncomingServer, nsIMsgAccountManager.findRealServer, nsIMsgAccountManager.getIncomingServer

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com