@mozilla.org/uriloader/content-handler;1?type=x-application-newsgroup-listids

This component implements the following interfaces:

Constants

Standard full URI with authority component and concept of relative URIs (http, ftp, ...)
PRUint32 nsIProtocolHandler.URI_STD = 0
No concept of relative URIs (about, javascript, finger, ...)
PRUint32 nsIProtocolHandler.URI_NORELATIVE = 1
No authority component (file, ...)
PRUint32 nsIProtocolHandler.URI_NOAUTH = 2
This protocol handler can be proxied via a proxy (socks or http) (e.g., irc, smtp, http, etc.). If the protocol supports transparent proxying, the handler should implement nsIProxiedProtocolHandler.

If it supports only HTTP proxying, then it need not support nsIProxiedProtocolHandler, but should instead set the ALLOWS_PROXY_HTTP flag (see below).

PRUint32 nsIProtocolHandler.ALLOWS_PROXY = 4
This protocol handler can be proxied using a http proxy (e.g., http, ftp, etc.). nsIIOService::newChannelFromURI will feed URIs from this protocol handler to the HTTP protocol handler instead. This flag is ignored if ALLOWS_PROXY is not set.
PRUint32 nsIProtocolHandler.ALLOWS_PROXY_HTTP = 8

Properties

readonly nsICacheSession nsINntpService.cacheSession

readonly PRBool nsIMsgProtocolInfo.canDelete

Can this type of server be removed from the account manager? for instance, local mail is not removable

readonly PRBool nsIMsgProtocolInfo.canDuplicate

Can you duplicate this server? for instance, local mail is unique and should not be duplicated.

readonly PRBool nsIMsgProtocolInfo.canGetIncomingMessages

Do messages arrive for this server if they do, we can use our junk controls on it.

readonly PRBool nsIMsgProtocolInfo.canGetMessages

An attribute that tell us whether on not we can get messages for the given server type this is poorly named right now. it's really is there an inbox for this type? XXX todo, rename this.

readonly PRBool nsIMsgProtocolInfo.canLoginAtStartUp

Can this type of server log in at startup?

readonly char* nsICmdLineHandler.chromeUrlForTask

readonly char* nsICmdLineHandler.commandLineArgument

readonly PRUnichar* nsICmdLineHandler.defaultArgs

readonly PRBool nsIMsgProtocolInfo.defaultDoBiff

Do biff by default?

nsIFileSpec nsIMsgProtocolInfo.defaultLocalPath

The default path to store local data for this type of server. Each server is usually in a subdirectory below this

readonly PRInt32 nsIProtocolHandler.defaultPort

The default port is the port that this protocol normally uses. If a port does not make sense for the protocol (e.g., "about:") then -1 will be returned.

readonly PRBool nsICmdLineHandler.handlesArgs

readonly char* nsICmdLineHandler.helpText

readonly PRBool nsIMsgProtocolInfo.needToBuildSpecialFolderURIs

Do we need to build special folder URIs ? In case of IMAP, special folders like 'Sent', 'Drafts' and 'Templates' are not created unless needed. But, we do need to create folder URIs to reflect the choices in the UI in copies and folders settings panel.

readonly PRBool nsICmdLineHandler.openWindowWithArgs

readonly PRBool nsIMsgProtocolInfo.preflightPrettyNameWithEmailAddress

If the pretty name of the server should just be the e-mail address. Otherwise it usually ends up being something like "news on hostname"

readonly char* nsICmdLineHandler.prefNameForStartup

readonly PRUint32 nsIProtocolHandler.protocolFlags

Returns the protocol specific flags (see flag definitions below).

readonly PRBool nsIMsgProtocolInfo.requiresUsername

Does this server type require a username? for instance, news does not but IMAP/POP do

readonly ACString nsIProtocolHandler.scheme

The scheme of this protocol (e.g., "file").

readonly nsIIDPtr nsIMsgProtocolInfo.serverIID

The IID of the protocol-specific interface for this server usually used from JS to dynamically get server-specific attributes

readonly PRBool nsIMsgProtocolInfo.showComposeMsgLink

Do we need to show compose message link in the AccountCentral page ?

readonly PRBool nsIMsgProtocolInfo.specialFoldersDeletionAllowed

Do we allow special folder deletion ?

Methods

InterfaceMethod
nsIProtocolHandler PRBool allowPort ( PRInt32 port , char* scheme )
nsINntpService nsIURI cancelMessage ( char* cancelURL , char* messageURI , nsISupports consumer , nsIUrlListener urlListener , nsIMsgWindow msgWindow )
nsIMsgMessageService void CopyMessage ( char* srcURI , nsIStreamListener copyListener , PRBool moveMessage , nsIUrlListener urlListener , nsIMsgWindow msgWindow , out nsIURI URL )
nsIMsgMessageService [noscript] void CopyMessages ( nsMsgKeyArrayPtr* keys , nsIMsgFolder srcFolder , nsIStreamListener copyListener , PRBool moveMessage , nsIUrlListener urlListener , nsIMsgWindow msgWindow , out nsIURI URL )
nsINntpService void decomposeNewsURI ( char* uri , out nsIMsgFolder folder , out nsMsgKey key )
nsIMsgMessageService void DisplayMessage ( char* messageURI , nsISupports displayConsumer , nsIMsgWindow msgWindow , nsIUrlListener urlListener , char* charsetOverride , out nsIURI URL )
nsIMsgMessageService void DisplayMessageForPrinting ( char* messageURI , nsISupports displayConsumer , nsIMsgWindow msgWindow , nsIUrlListener urlListener , out nsIURI URL )
nsINntpService void downloadNewsgroupsForOffline ( nsIMsgWindow msgWindow , nsIUrlListener listener )
nsINntpService nsIURI fetchMessage ( nsIMsgFolder newsFolder , nsMsgKey key , nsIMsgWindow msgWindow , nsISupports consumer , nsIUrlListener urlListener )
nsIMsgMessageFetchPartService nsIURI fetchMimePart ( nsIURI URI , char* messageUri , nsISupports displayConsumer , nsIMsgWindow msgWindow , nsIUrlListener urlListener )
nsINntpService void generateNewsHeaderValsForPosting ( char* newsgroupsList , out char* newsgroupsHeaderVal , out char* newshostHeaderVal )
nsIMsgProtocolInfo PRInt32 getDefaultServerPort ( PRBool isSecure )
nsINntpService void getListOfGroupsOnServer ( nsINntpIncomingServer nntpServer , nsIMsgWindow msgWindow )
nsINntpService nsIURI getNewNews ( nsINntpIncomingServer nntpServer , char* uri , PRBool getOld , nsIUrlListener urlListener , nsIMsgWindow msgWindow )
nsIMsgMessageService void GetUrlForUri ( char* messageURI , out nsIURI URL , nsIMsgWindow msgWindow )
nsIContentHandler void handleContent ( char* contentType , nsIInterfaceRequestor windowContext , nsIRequest request )
nsIMsgMessageService nsIMsgDBHdr messageURIToMsgHdr ( char* uri )
nsIProtocolHandler nsIChannel newChannel ( nsIURI URI )
nsIProtocolHandler nsIURI newURI ( AUTF8String spec , char* originCharset , nsIURI baseURI )
nsIMsgMessageService void openAttachment ( char* contentType , char* fileName , char* url , char* messageUri , nsISupports displayConsumer , nsIMsgWindow msgWindow , nsIUrlListener urlListener )
nsINntpService nsIURI postMessage ( nsIFileSpec fileToPost , char* newsgroupNames , char* accountKey , nsIUrlListener urlListener , nsIMsgWindow msgWindow )
nsIMsgMessageService void SaveMessageToDisk ( char* messageURI , nsIFileSpec file , PRBool generateDummyEnvelope , nsIUrlListener urlListener , out nsIURI URL , PRBool canonicalLineEnding , nsIMsgWindow msgWindow )
nsIMsgMessageService void Search ( nsIMsgSearchSession searchSession , nsIMsgWindow msgWindow , nsIMsgFolder msgFolder , char* searchUri )
nsIMsgMessageService nsIURI streamMessage ( char* messageURI , nsISupports consumer , nsIMsgWindow msgWindow , nsIUrlListener urlListener , PRBool convertData , char* additionalHeader )
nsINntpService void updateCounts ( nsINntpIncomingServer nntpServer , nsIMsgWindow msgWindow )

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com