nsIMsgIncomingServer Interface Reference

import "nsIMsgIncomingServer.idl";

Inheritance diagram for nsIMsgIncomingServer:

[legend]

Collaboration diagram for nsIMsgIncomingServer:

[legend]

List of all members.

Public Member Functions
void	onUserOrHostNameChanged (in ACString oldName, in ACString newName)
ACString	getPasswordWithUI (in AString aPromptString, in AString 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 nsILocalFile 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)
ACString	getCharValue (in string attr)
void	setCharValue (in string attr, in ACString value)
AString	getUnicharValue (in string attr)
void	setUnicharValue (in string attr, in AString value)
long	getIntValue (in string attr)
void	setIntValue (in string attr, in long value)
nsILocalFile	getFileValue (in string relpref, in string abspref)
void	setFileValue (in string relpref, in string abspref, in nsILocalFile aValue)
void	clearAllValues ()
	this is really dangerous.
void	removeFiles ()
	this is also very dangerous.
AString	toString ()
void	displayOfflineMsg (in nsIMsgWindow aWindow)
boolean	equals (in nsIMsgIncomingServer server)
AString	generatePrettyNameForMigration ()
AString	getUnicharAttribute (in string name)
	these generic getter / setters, useful for extending mailnews note, these attributes persist across sessions
void	setUnicharAttribute (in string name, in AString value)
ACString	getCharAttribute (in string name)
void	setCharAttribute (in string name, in ACString 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 ACString aURI)
boolean	isNewHdrDuplicate (in nsIMsgDBHdr aNewHdr)
Public Attributes
attribute ACString	key
	internal pref key - guaranteed to be unique across all servers
attribute AString	prettyName
	pretty name - should be "userid on hostname" if the pref is not set
readonly attribute 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
attribute ACString	hostName
	hostname of the server
attribute ACString	realHostName
	real hostname of the server (if server name is changed it's stored here)
attribute long	port
attribute ACString	username
	userid to log into the server
attribute ACString	realUsername
	real username of the server (if username is changed it's stored here)
attribute ACString	type
	protocol type, i.e.
readonly attribute AString	accountManagerChrome
readonly attribute ACString	localStoreType
	the schema for the local mail store, such as "mailbox", "imap", or "news" used to construct URIs
attribute boolean	rememberPassword
attribute ACString	password
attribute boolean	downloadOnBiff
attribute boolean	doBiff
attribute long	biffMinutes
attribute unsigned long	biffState
attribute boolean	performingBiff
attribute nsILocalFile	localPath
readonly attribute ACString	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 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

---

Member Function Documentation

void nsIMsgIncomingServer::onUserOrHostNameChanged	(	in ACString	oldName,
		in ACString	newName
	)

ACString nsIMsgIncomingServer::getPasswordWithUI	(	in AString	aPromptString,
		in AString	aPromptTitle,
		in nsIMsgWindow	aMsgWindow,
		out boolean	okayValue
	)

void nsIMsgIncomingServer::forgetPassword

(

)

void nsIMsgIncomingServer::storePassword

(

)

logon succeeded - persist password, if user chooses.

void nsIMsgIncomingServer::forgetSessionPassword

(

)

nsIMsgFilterList nsIMsgIncomingServer::getFilterList

(

in nsIMsgWindow

aMsgWindow

)

void nsIMsgIncomingServer::setFilterList

(

in nsIMsgFilterList

aFilterList

)

void nsIMsgIncomingServer::setDefaultLocalPath

(

in nsILocalFile

aDefaultLocalPath

)

void nsIMsgIncomingServer::performBiff

(

in nsIMsgWindow

aMsgWindow

)

void nsIMsgIncomingServer::getNewMessages	(	in nsIMsgFolder	aFolder,
		in nsIMsgWindow	aMsgWindow,
		in nsIUrlListener	aUrlListener
	)

void nsIMsgIncomingServer::performExpand

(

in nsIMsgWindow

aMsgWindow

)

void nsIMsgIncomingServer::writeToFolderCache

(

in nsIMsgFolderCache

folderCache

)

void nsIMsgIncomingServer::closeCachedConnections

(

)

void nsIMsgIncomingServer::shutdown

(

)

boolean nsIMsgIncomingServer::getBoolValue

(

in string

attr

)

void nsIMsgIncomingServer::setBoolValue	(	in string	attr,
		in boolean	value
	)

ACString nsIMsgIncomingServer::getCharValue

(

in string

attr

)

void nsIMsgIncomingServer::setCharValue	(	in string	attr,
		in ACString	value
	)

AString nsIMsgIncomingServer::getUnicharValue

(

in string

attr

)

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

long nsIMsgIncomingServer::getIntValue

(

in string

attr

)

void nsIMsgIncomingServer::setIntValue	(	in string	attr,
		in long	value
	)

nsILocalFile nsIMsgIncomingServer::getFileValue	(	in string	relpref,
		in string	abspref
	)

void nsIMsgIncomingServer::setFileValue	(	in string	relpref,
		in string	abspref,
		in nsILocalFile	aValue
	)

void nsIMsgIncomingServer::clearAllValues

(

)

this is really dangerous.

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

void nsIMsgIncomingServer::removeFiles

(

)

this is also very dangerous.

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

AString nsIMsgIncomingServer::toString

(

)

void nsIMsgIncomingServer::displayOfflineMsg

(

in nsIMsgWindow

aWindow

)

boolean nsIMsgIncomingServer::equals

(

in nsIMsgIncomingServer

server

)

AString nsIMsgIncomingServer::generatePrettyNameForMigration

(

)

AString nsIMsgIncomingServer::getUnicharAttribute

(

in string

name

)

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

void nsIMsgIncomingServer::setUnicharAttribute	(	in string	name,
		in AString	value
	)

ACString nsIMsgIncomingServer::getCharAttribute

(

in string

name

)

void nsIMsgIncomingServer::setCharAttribute	(	in string	name,
		in ACString	value
	)

boolean nsIMsgIncomingServer::getBoolAttribute

(

in string

name

)

void nsIMsgIncomingServer::setBoolAttribute	(	in string	name,
		in boolean	value
	)

long nsIMsgIncomingServer::getIntAttribute

(

in string

name

)

void nsIMsgIncomingServer::setIntAttribute	(	in string	name,
		in long	value
	)

void nsIMsgIncomingServer::configureTemporaryFilters

(

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

void nsIMsgIncomingServer::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 nsIMsgIncomingServer::getMsgFolderFromURI	(	in nsIMsgFolder	aFolderResource,
		in ACString	aURI
	)

boolean nsIMsgIncomingServer::isNewHdrDuplicate

(

in nsIMsgDBHdr

aNewHdr

)

---

Member Data Documentation

attribute ACString nsIMsgIncomingServer::key

internal pref key - guaranteed to be unique across all servers

attribute AString nsIMsgIncomingServer::prettyName

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

readonly attribute 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

attribute ACString nsIMsgIncomingServer::hostName

hostname of the server

attribute ACString nsIMsgIncomingServer::realHostName

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

attribute long nsIMsgIncomingServer::port

attribute ACString nsIMsgIncomingServer::username

userid to log into the server

attribute ACString nsIMsgIncomingServer::realUsername

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

attribute ACString nsIMsgIncomingServer::type

protocol type, i.e.

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

readonly attribute AString nsIMsgIncomingServer::accountManagerChrome

readonly attribute ACString nsIMsgIncomingServer::localStoreType

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

attribute boolean nsIMsgIncomingServer::rememberPassword

attribute ACString nsIMsgIncomingServer::password

attribute boolean nsIMsgIncomingServer::downloadOnBiff

attribute boolean nsIMsgIncomingServer::doBiff

attribute long nsIMsgIncomingServer::biffMinutes

attribute unsigned long nsIMsgIncomingServer::biffState

attribute boolean nsIMsgIncomingServer::performingBiff

attribute nsILocalFile nsIMsgIncomingServer::localPath

readonly attribute ACString nsIMsgIncomingServer::serverURI

attribute nsIMsgFolder nsIMsgIncomingServer::rootFolder

readonly attribute nsIMsgFolder nsIMsgIncomingServer::rootMsgFolder

attribute boolean nsIMsgIncomingServer::serverBusy

attribute boolean nsIMsgIncomingServer::isSecure

attribute boolean nsIMsgIncomingServer::useSecAuth

const long nsIMsgIncomingServer::defaultSocket = 0

const long nsIMsgIncomingServer::tryTLS = 1

const long nsIMsgIncomingServer::alwaysUseTLS = 2

const long nsIMsgIncomingServer::useSSL = 3

attribute long nsIMsgIncomingServer::socketType

attribute boolean nsIMsgIncomingServer::logonFallback

readonly attribute boolean nsIMsgIncomingServer::isSecureServer

attribute boolean nsIMsgIncomingServer::emptyTrashOnExit

readonly attribute boolean nsIMsgIncomingServer::serverRequiresPasswordForBiff

attribute boolean nsIMsgIncomingServer::valid

readonly attribute boolean nsIMsgIncomingServer::downloadMessagesAtStartup

readonly attribute boolean nsIMsgIncomingServer::canHaveFilters

attribute boolean nsIMsgIncomingServer::canDelete

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

attribute boolean nsIMsgIncomingServer::loginAtStartUp

attribute boolean nsIMsgIncomingServer::limitOfflineMessageSize

attribute long nsIMsgIncomingServer::maxMessageSize

attribute nsIMsgRetentionSettings nsIMsgIncomingServer::retentionSettings

readonly attribute boolean nsIMsgIncomingServer::canBeDefaultServer

readonly attribute boolean nsIMsgIncomingServer::canSearchMessages

readonly attribute boolean nsIMsgIncomingServer::canEmptyTrashOnExit

attribute boolean nsIMsgIncomingServer::displayStartupPage

attribute nsIMsgDownloadSettings nsIMsgIncomingServer::downloadSettings

attribute long nsIMsgIncomingServer::offlineSupportLevel

readonly attribute boolean nsIMsgIncomingServer::supportsDiskSpace

attribute boolean 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.

attribute boolean nsIMsgIncomingServer::canCreateFoldersOnServer

attribute boolean nsIMsgIncomingServer::canFileMessagesOnServer

readonly attribute boolean nsIMsgIncomingServer::canCompactFoldersOnServer

readonly attribute boolean nsIMsgIncomingServer::canUndoDeleteOnServer

readonly attribute nsMsgSearchScopeValue nsIMsgIncomingServer::filterScope

readonly attribute nsMsgSearchScopeValue nsIMsgIncomingServer::searchScope

readonly attribute boolean 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.

readonly attribute nsISpamSettings nsIMsgIncomingServer::spamSettings

spam settings

readonly attribute nsIMsgFilterPlugin nsIMsgIncomingServer::spamFilterPlugin

readonly attribute boolean nsIMsgIncomingServer::isDeferredTo

const long nsIMsgIncomingServer::keepDups = 0

const long nsIMsgIncomingServer::deleteDups = 1

const long nsIMsgIncomingServer::moveDupsToTrash = 2

const long nsIMsgIncomingServer::markDupsRead = 3

attribute long nsIMsgIncomingServer::incomingDuplicateAction

---

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

• nsIMsgIncomingServer.idl