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=nntp

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
PRInt16 nsITreeView.DROP_BEFORE = -1
PRInt16 nsITreeView.DROP_ON = 0
PRInt16 nsITreeView.DROP_AFTER = 1
The progress mode for a given cell. This method is only called for columns of type progressmeter.
PRInt16 nsITreeView.PROGRESS_NORMAL = 1
PRInt16 nsITreeView.PROGRESS_UNDETERMINED = 2
PRInt16 nsITreeView.PROGRESS_NONE = 3

Properties

PRBool nsINntpIncomingServer.abbreviate

readonly AString nsIMsgIncomingServer.accountManagerChrome

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

ACString nsINntpIncomingServer.charset

The server charset and it may be needed to display newsgroup folder names correctly

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.

char nsISubscribableServer.delimiter

PRBool nsIMsgIncomingServer.displayStartupPage

PRBool nsIMsgIncomingServer.doBiff

readonly PRBool nsIMsgIncomingServer.downloadMessagesAtStartup

PRBool nsIMsgIncomingServer.downloadOnBiff

nsIMsgDownloadSettings nsIMsgIncomingServer.downloadSettings

PRBool nsIMsgIncomingServer.emptyTrashOnExit

readonly nsMsgSearchScopeValue nsIMsgIncomingServer.filterScope

readonly nsISupports nsINntpIncomingServer.firstGroupNeedingCounts

readonly AUTF8String nsINntpIncomingServer.firstGroupNeedingExtraInfo

ACString nsIMsgIncomingServer.hostName

Hostname of the server

PRInt32 nsIMsgIncomingServer.incomingDuplicateAction

readonly PRBool nsIMsgIncomingServer.isDeferredTo

PRBool nsIMsgIncomingServer.isSecure

readonly PRBool nsIMsgIncomingServer.isSecureServer

ACString nsIMsgIncomingServer.key

Internal pref key - guaranteed to be unique across all servers

PRUint32 nsINntpIncomingServer.lastUpdatedTime

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

PRBool nsINntpIncomingServer.markOldRead

PRInt32 nsINntpIncomingServer.maxArticles

PRInt32 nsINntpIncomingServer.maximumConnectionsNumber

PRInt32 nsIMsgIncomingServer.maxMessageSize

nsILocalFile nsINntpIncomingServer.newsrcFilePath

PRBool nsINntpIncomingServer.newsrcHasChanged

nsILocalFile nsINntpIncomingServer.newsrcRootPath

PRBool nsINntpIncomingServer.notifyOn

readonly PRInt32 nsINntpIncomingServer.numGroupsNeedingCounts

PRInt32 nsIMsgIncomingServer.offlineSupportLevel

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

PRInt32 nsIMsgIncomingServer.port

PRBool nsINntpIncomingServer.postingAllowed

AString nsIMsgIncomingServer.prettyName

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

PRBool nsINntpIncomingServer.pushAuth

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 PRInt32 nsITreeView.rowCount

The total number of rows in the tree (including the offscreen rows).

readonly nsMsgSearchScopeValue nsIMsgIncomingServer.searchScope

nsITreeSelection nsITreeView.selection

The selection for this view.

PRBool nsIMsgIncomingServer.serverBusy

readonly PRBool nsIMsgIncomingServer.serverRequiresPasswordForBiff

readonly ACString nsIMsgIncomingServer.serverURI

PRBool nsINntpIncomingServer.singleSignon

PRInt32 nsIMsgIncomingServer.socketType

readonly nsIMsgFilterPlugin nsIMsgIncomingServer.spamFilterPlugin

readonly nsISpamSettings nsIMsgIncomingServer.spamSettings

Spam settings

nsISubscribeListener nsISubscribableServer.subscribeListener

readonly PRBool nsIMsgIncomingServer.supportsDiskSpace

PRBool nsINntpIncomingServer.supportsExtensions

readonly PRBool nsISubscribableServer.supportsSubscribeSearch

ACString nsIMsgIncomingServer.type

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

PRBool nsINntpIncomingServer.userAuthenticated

ACString nsIMsgIncomingServer.username

Userid to log into the server

PRBool nsIMsgIncomingServer.useSecAuth

PRBool nsIMsgIncomingServer.valid

Methods

InterfaceMethod
nsINntpIncomingServer void addExtension ( char* extension )
nsINntpIncomingServer void addNewsgroup ( AString name )
nsINntpIncomingServer [noscript] void addNewsgroupToList ( char* name )
nsINntpIncomingServer void addPropertyForGet ( char* name , char* value )
nsINntpIncomingServer void addSearchableGroup ( AString name )
nsINntpIncomingServer void addSearchableHeader ( char* headerName )
nsISubscribableServer void addTo ( AUTF8String name , PRBool addAsSubscribed , PRBool subscribable , PRBool changeIfExists )
nsITreeView PRBool canDrop ( PRInt32 index , PRInt32 orientation )
nsIMsgIncomingServer void clearAllValues ( )
nsIMsgIncomingServer void clearTemporaryReturnReceiptsFilter ( )
nsIMsgIncomingServer void closeCachedConnections ( )
nsISubscribableServer void commitSubscribeChanges ( )
nsIMsgIncomingServer void configureTemporaryFilters ( nsIMsgFilterList filterList )
nsINntpIncomingServer PRBool containsNewsgroup ( AUTF8String name )
nsITreeView void cycleCell ( PRInt32 row , nsITreeColumn col )
nsITreeView void cycleHeader ( nsITreeColumn col )
nsIMsgIncomingServer void displayOfflineMsg ( nsIMsgWindow window )
nsINntpIncomingServer void displaySubscribedGroup ( nsIMsgNewsFolder msgFolder , PRInt32 firstMessage , PRInt32 lastMessage , PRInt32 totalMessages )
nsITreeView void drop ( PRInt32 row , PRInt32 orientation )
nsIMsgIncomingServer PRBool equals ( nsIMsgIncomingServer server )
nsINntpIncomingServer nsIMsgNewsFolder findGroup ( AUTF8String name )
nsIMsgIncomingServer void forgetPassword ( )
nsIMsgIncomingServer void forgetSessionPassword ( )
nsIMsgIncomingServer AString generatePrettyNameForMigration ( )
nsIMsgIncomingServer PRBool getBoolAttribute ( char* name )
nsIMsgIncomingServer PRBool getBoolValue ( char* attr )
nsITreeView void getCellProperties ( PRInt32 row , nsITreeColumn col , nsISupportsArray properties )
nsITreeView AString getCellText ( PRInt32 row , nsITreeColumn col )
nsITreeView AString getCellValue ( PRInt32 row , nsITreeColumn col )
nsIMsgIncomingServer ACString getCharAttribute ( char* name )
nsIMsgIncomingServer ACString getCharValue ( char* attr )
nsISubscribableServer nsISimpleEnumerator getChildren ( AUTF8String path )
nsITreeView void getColumnProperties ( nsITreeColumn col , nsISupportsArray properties )
nsIMsgIncomingServer nsILocalFile getFileValue ( char* relpref , char* abspref )
nsIMsgIncomingServer nsIMsgFilterList getFilterList ( nsIMsgWindow msgWindow )
nsISubscribableServer AUTF8String getFirstChildURI ( AUTF8String path )
nsITreeView AString getImageSrc ( PRInt32 row , nsITreeColumn col )
nsIMsgIncomingServer PRInt32 getIntAttribute ( char* name )
nsIMsgIncomingServer PRInt32 getIntValue ( char* attr )
nsISubscribableServer AString getLeafName ( AUTF8String path )
nsITreeView PRInt32 getLevel ( PRInt32 index )
nsIMsgIncomingServer nsIMsgFolder getMsgFolderFromURI ( nsIMsgFolder folderResource , ACString URI )
nsIMsgIncomingServer void getNewMessages ( nsIMsgFolder folder , nsIMsgWindow msgWindow , nsIUrlListener urlListener )
nsINntpIncomingServer void getNntpConnection ( nsIURI url , nsIMsgWindow window , out nsINNTPProtocol nntpConnection )
nsITreeView PRInt32 getParentIndex ( PRInt32 rowIndex )
nsIMsgIncomingServer ACString getPasswordWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow , out PRBool okayValue )
nsITreeView PRInt32 getProgressMode ( PRInt32 row , nsITreeColumn col )
nsITreeView void getRowProperties ( PRInt32 index , nsISupportsArray properties )
nsIMsgIncomingServer AString getUnicharAttribute ( char* name )
nsIMsgIncomingServer AString getUnicharValue ( char* attr )
nsISupportsWeakReference nsIWeakReference GetWeakReference ( )
nsINntpIncomingServer void groupNotFound ( nsIMsgWindow window , AString group , PRBool opening )
nsISubscribableServer PRBool hasChildren ( AUTF8String path )
nsITreeView PRBool hasNextSibling ( PRInt32 rowIndex , PRInt32 afterIndex )
nsITreeView PRBool isContainer ( PRInt32 index )
nsITreeView PRBool isContainerEmpty ( PRInt32 index )
nsITreeView PRBool isContainerOpen ( PRInt32 index )
nsITreeView PRBool isEditable ( PRInt32 row , nsITreeColumn col )
nsIMsgIncomingServer PRBool isNewHdrDuplicate ( nsIMsgDBHdr newHdr )
nsITreeView PRBool isSelectable ( PRInt32 row , nsITreeColumn col )
nsITreeView PRBool isSeparator ( PRInt32 index )
nsITreeView PRBool isSorted ( )
nsISubscribableServer PRBool isSubscribable ( AUTF8String path )
nsISubscribableServer PRBool isSubscribed ( AUTF8String path )
nsIUrlListener void OnStartRunningUrl ( nsIURI url )
nsIUrlListener void OnStopRunningUrl ( nsIURI url , nsresult exitCode )
nsIMsgIncomingServer void onUserOrHostNameChanged ( ACString oldName , ACString newName )
nsITreeView void performAction ( PRUnichar* action )
nsITreeView void performActionOnCell ( PRUnichar* action , PRInt32 row , nsITreeColumn col )
nsITreeView void performActionOnRow ( PRUnichar* action , PRInt32 row )
nsIMsgIncomingServer void performBiff ( nsIMsgWindow msgWindow )
nsIMsgIncomingServer void performExpand ( nsIMsgWindow msgWindow )
nsINntpIncomingServer PRBool queryExtension ( char* extension )
nsINntpIncomingServer char* queryPropertyForGet ( char* name )
nsINntpIncomingServer PRBool querySearchableGroup ( AString name )
nsINntpIncomingServer PRBool querySearchableHeader ( char* headerName )
nsINntpIncomingServer void removeConnection ( nsINNTPProtocol nntpConnection )
nsIMsgIncomingServer void removeFiles ( )
nsINntpIncomingServer void removeNewsgroup ( AString name )
nsITreeView void selectionChanged ( )
nsISubscribableServer void setAsSubscribed ( AUTF8String path )
nsIMsgIncomingServer void setBoolAttribute ( char* name , PRBool value )
nsIMsgIncomingServer void setBoolValue ( char* attr , PRBool value )
nsITreeView void setCellText ( PRInt32 row , nsITreeColumn col , AString value )
nsITreeView void setCellValue ( PRInt32 row , nsITreeColumn col , AString value )
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 )
nsINntpIncomingServer void setGroupNeedsExtraInfo ( AUTF8String name , PRBool needsExtrinfo )
nsISubscribableServer void setIncomingServer ( nsIMsgIncomingServer server )
nsIMsgIncomingServer void setIntAttribute ( char* name , PRInt32 value )
nsIMsgIncomingServer void setIntValue ( char* attr , PRInt32 value )
nsINntpIncomingServer void setPrettyNameForGroup ( AString name , AString prettyName )
nsISubscribableServer void setSearchValue ( AString searchValue )
nsISubscribableServer void setShowFullName ( PRBool showFullName )
nsISubscribableServer PRBool setState ( AUTF8String path , PRBool state )
nsITreeView void setTree ( nsITreeBoxObject tree )
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 ( )
nsINntpIncomingServer void subscribeToNewsgroup ( AUTF8String name )
nsITreeView void toggleOpenState ( PRInt32 index )
nsIMsgIncomingServer AString toString ( )
nsISubscribableServer void unsubscribe ( PRUnichar* name )
nsISubscribableServer void updateSubscribed ( )
nsINntpIncomingServer void writeNewsrcFile ( )
nsIMsgIncomingServer void writeToFolderCache ( nsIMsgFolderCache folderCache )

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com