Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIMsgIncomingServer Interface Reference

import "nsIMsgIncomingServer.idl";

Inheritance diagram for nsIMsgIncomingServer:
Inheritance graph
[legend]
Collaboration diagram for nsIMsgIncomingServer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void OnUserOrHostNameChanged (in string oldName, in string newName)
string getPasswordWithUI (in wstring aPromptString, in wstring aPromptTitle, in nsIMsgWindow aMsgWindow, out boolean okayValue)
void forgetPassword ()
void storePassword ()
 logon succeeded - persist password, if user chooses.
void forgetSessionPassword ()
nsIMsgFilterList getFilterList (in nsIMsgWindow aMsgWindow)
void setFilterList (in nsIMsgFilterList aFilterList)
void SetDefaultLocalPath (in nsIFileSpec aDefaultLocalPath)
void PerformBiff (in nsIMsgWindow aMsgWindow)
void getNewMessages (in nsIMsgFolder aFolder, in nsIMsgWindow aMsgWindow, in nsIUrlListener aUrlListener)
void performExpand (in nsIMsgWindow aMsgWindow)
void WriteToFolderCache (in nsIMsgFolderCache folderCache)
void CloseCachedConnections ()
void shutdown ()
boolean getBoolValue (in string attr)
void setBoolValue (in string attr, in boolean value)
string getCharValue (in string attr)
void setCharValue (in string attr, in string value)
wstring getUnicharValue (in string attr)
void setUnicharValue (in string attr, in wstring value)
long getIntValue (in string attr)
void setIntValue (in string attr, in long value)
nsIFileSpec getFileValue (in string attr)
void setFileValue (in string attr, in nsIFileSpec value)
void clearAllValues ()
 this is really dangerous.
void removeFiles ()
 this is also very dangerous.
wstring toString ()
void displayOfflineMsg (in nsIMsgWindow aWindow)
boolean equals (in nsIMsgIncomingServer server)
wstring generatePrettyNameForMigration ()
wstring getUnicharAttribute (in string name)
 these generic getter / setters, useful for extending mailnews note, these attributes persist across sessions
void setUnicharAttribute (in string name, in wstring value)
string getCharAttribute (in string name)
void setCharAttribute (in string name, in string value)
boolean getBoolAttribute (in string name)
void setBoolAttribute (in string name, in boolean value)
long getIntAttribute (in string name)
void setIntAttribute (in string name, in long value)
void configureTemporaryFilters (in nsIMsgFilterList filterList)
 for mail, this configures both the MDN filter, and the server-side spam filter filters, if needed.
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()).
nsIMsgFolder getMsgFolderFromURI (in nsIMsgFolder aFolderResource, in string aURI)
boolean isNewHdrDuplicate (in nsIMsgDBHdr aNewHdr)

Public Attributes

attribute string key
 internal pref key - guaranteed to be unique across all servers
attribute wstring prettyName
 pretty name - should be "userid on hostname" if the pref is not set
readonly attribute wstring constructedPrettyName
 helper function to construct the pretty name in a server type specific way - e.g., mail for foo@t.nosp@m.est..nosp@m.com, news on news.mozilla.org
attribute string hostName
 hostname of the server
attribute string realHostName
 real hostname of the server (if server name is changed it's stored here)
attribute long port
attribute string username
 userid to log into the server
attribute string realUsername
 real username of the server (if username is changed it's stored here)
attribute string type
 protocol type, i.e.
readonly attribute AString accountManagerChrome
readonly attribute string localStoreType
 the schema for the local mail store, such as "mailbox", "imap", or "news" used to construct URIs
attribute boolean rememberPassword
attribute string password
attribute boolean downloadOnBiff
attribute boolean doBiff
attribute long biffMinutes
attribute unsigned long biffState
attribute boolean performingBiff
attribute nsIFileSpec localPath
readonly attribute string serverURI
attribute nsIMsgFolder rootFolder
readonly attribute nsIMsgFolder rootMsgFolder
attribute boolean serverBusy
attribute boolean isSecure
attribute boolean useSecAuth
const long defaultSocket = 0
const long tryTLS = 1
const long alwaysUseTLS = 2
const long useSSL = 3
attribute long socketType
attribute boolean logonFallback
readonly attribute boolean isSecureServer
attribute string redirectorType
attribute boolean emptyTrashOnExit
readonly attribute boolean serverRequiresPasswordForBiff
attribute boolean valid
readonly attribute boolean downloadMessagesAtStartup
readonly attribute boolean canHaveFilters
attribute boolean canDelete
 can this server be removed from the account manager? for instance, local mail is not removable, but an imported folder is
attribute boolean loginAtStartUp
attribute boolean limitOfflineMessageSize
attribute long maxMessageSize
attribute nsIMsgRetentionSettings retentionSettings
readonly attribute boolean canBeDefaultServer
readonly attribute boolean canSearchMessages
readonly attribute boolean canEmptyTrashOnExit
attribute boolean displayStartupPage
attribute nsIMsgDownloadSettings downloadSettings
attribute long offlineSupportLevel
readonly attribute boolean supportsDiskSpace
attribute boolean defaultCopiesAndFoldersPrefsToServer
 If the server supports Fcc/Sent/etc, default prefs can point to the server.
attribute boolean canCreateFoldersOnServer
attribute boolean canFileMessagesOnServer
readonly attribute boolean canCompactFoldersOnServer
readonly attribute boolean canUndoDeleteOnServer
readonly attribute
nsMsgSearchScopeValue 
filterScope
readonly attribute
nsMsgSearchScopeValue 
searchScope
readonly attribute boolean passwordPromptRequired
 If the password for the server is available either via authentication in the current session or from password manager stored entries, return false.
readonly attribute nsISpamSettings spamSettings
 spam settings
readonly attribute
nsIMsgFilterPlugin 
spamFilterPlugin
readonly attribute boolean isDeferredTo
const long keepDups = 0
const long deleteDups = 1
const long moveDupsToTrash = 2
const long markDupsRead = 3
attribute long incomingDuplicateAction

Detailed Description

Definition at line 60 of file nsIMsgIncomingServer.idl.


Member Function Documentation

this is really dangerous.

this destroys all pref values do not call this unless you know what you're doing!

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

Here is the caller graph for this function:

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).

string nsIMsgIncomingServer::getPasswordWithUI ( in wstring  aPromptString,
in wstring  aPromptTitle,
in nsIMsgWindow  aMsgWindow,
out boolean  okayValue 
)

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

this is also very dangerous.

this will remove the files associated with this server on disk.

void nsIMsgIncomingServer::setUnicharValue ( in string  attr,
in wstring  value 
)

logon succeeded - persist password, if user chooses.

Here is the caller graph for this function:


Member Data Documentation

Definition at line 108 of file nsIMsgIncomingServer.idl.

Definition at line 183 of file nsIMsgIncomingServer.idl.

Definition at line 149 of file nsIMsgIncomingServer.idl.

Definition at line 152 of file nsIMsgIncomingServer.idl.

Definition at line 290 of file nsIMsgIncomingServer.idl.

Definition at line 346 of file nsIMsgIncomingServer.idl.

Definition at line 340 of file nsIMsgIncomingServer.idl.

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

Definition at line 280 of file nsIMsgIncomingServer.idl.

Definition at line 296 of file nsIMsgIncomingServer.idl.

Definition at line 343 of file nsIMsgIncomingServer.idl.

Definition at line 274 of file nsIMsgIncomingServer.idl.

Definition at line 293 of file nsIMsgIncomingServer.idl.

Definition at line 349 of file nsIMsgIncomingServer.idl.

helper function to construct the pretty name in a server type specific way - e.g., mail for foo@t.nosp@m.est..nosp@m.com, news on news.mozilla.org

Definition at line 77 of file nsIMsgIncomingServer.idl.

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.

Definition at line 337 of file nsIMsgIncomingServer.idl.

Definition at line 181 of file nsIMsgIncomingServer.idl.

Definition at line 412 of file nsIMsgIncomingServer.idl.

Definition at line 299 of file nsIMsgIncomingServer.idl.

Definition at line 146 of file nsIMsgIncomingServer.idl.

Definition at line 271 of file nsIMsgIncomingServer.idl.

Definition at line 143 of file nsIMsgIncomingServer.idl.

Definition at line 300 of file nsIMsgIncomingServer.idl.

Definition at line 201 of file nsIMsgIncomingServer.idl.

Definition at line 352 of file nsIMsgIncomingServer.idl.

hostname of the server

Definition at line 82 of file nsIMsgIncomingServer.idl.

Definition at line 416 of file nsIMsgIncomingServer.idl.

Definition at line 409 of file nsIMsgIncomingServer.idl.

Definition at line 176 of file nsIMsgIncomingServer.idl.

Definition at line 195 of file nsIMsgIncomingServer.idl.

Definition at line 411 of file nsIMsgIncomingServer.idl.

internal pref key - guaranteed to be unique across all servers

Definition at line 65 of file nsIMsgIncomingServer.idl.

Definition at line 284 of file nsIMsgIncomingServer.idl.

Definition at line 158 of file nsIMsgIncomingServer.idl.

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

Definition at line 115 of file nsIMsgIncomingServer.idl.

Definition at line 282 of file nsIMsgIncomingServer.idl.

Definition at line 192 of file nsIMsgIncomingServer.idl.

Definition at line 414 of file nsIMsgIncomingServer.idl.

Definition at line 285 of file nsIMsgIncomingServer.idl.

Definition at line 413 of file nsIMsgIncomingServer.idl.

Definition at line 318 of file nsIMsgIncomingServer.idl.

Definition at line 124 of file nsIMsgIncomingServer.idl.

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.

Definition at line 379 of file nsIMsgIncomingServer.idl.

Definition at line 155 of file nsIMsgIncomingServer.idl.

Definition at line 90 of file nsIMsgIncomingServer.idl.

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

Definition at line 71 of file nsIMsgIncomingServer.idl.

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

Definition at line 87 of file nsIMsgIncomingServer.idl.

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

Definition at line 100 of file nsIMsgIncomingServer.idl.

Definition at line 198 of file nsIMsgIncomingServer.idl.

Definition at line 121 of file nsIMsgIncomingServer.idl.

Definition at line 287 of file nsIMsgIncomingServer.idl.

Definition at line 164 of file nsIMsgIncomingServer.idl.

Definition at line 168 of file nsIMsgIncomingServer.idl.

Definition at line 355 of file nsIMsgIncomingServer.idl.

Definition at line 173 of file nsIMsgIncomingServer.idl.

Definition at line 219 of file nsIMsgIncomingServer.idl.

Definition at line 161 of file nsIMsgIncomingServer.idl.

Definition at line 187 of file nsIMsgIncomingServer.idl.

Definition at line 405 of file nsIMsgIncomingServer.idl.

spam settings

Definition at line 404 of file nsIMsgIncomingServer.idl.

Definition at line 324 of file nsIMsgIncomingServer.idl.

Definition at line 182 of file nsIMsgIncomingServer.idl.

protocol type, i.e.

"pop3", "imap", "nntp", "none", etc used to construct URLs

Definition at line 106 of file nsIMsgIncomingServer.idl.

userid to log into the server

Definition at line 95 of file nsIMsgIncomingServer.idl.

Definition at line 179 of file nsIMsgIncomingServer.idl.

Definition at line 184 of file nsIMsgIncomingServer.idl.

Definition at line 261 of file nsIMsgIncomingServer.idl.


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