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/commandlinehandler/general-startup;1?type=news

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
The URIs for this protocol have no inherent security context, so documents loaded via this protocol should inherit the security context from the document that loads them.
PRUint32 nsIProtocolHandler.URI_INHERITS_SECURITY_CONTEXT = 16
"Automatic" loads that would replace the document (e.g. refresh, certain types of XLinks, possibly other loads that the application decides are not user triggered) are not allowed if the originating (NOT the target) URI has this protocol flag. Note that the decision as to what constitutes an "automatic" load is made externally, by the caller of nsIScriptSecurityManager::CheckLoadURI. See documentation for that method for more information.

A typical protocol that might want to set this flag is a protocol that shows highly untrusted content in a viewing area that the user expects to have a lot of control over, such as an e-mail reader.

PRUint32 nsIProtocolHandler.URI_FORBIDS_AUTOMATIC_DOCUMENT_REPLACEMENT = 32
The URIs for this protocol can be loaded by anyone. For example, any website should be allowed to trigger a load of a URI for this protocol. Web-safe protocols like "http" should set this flag.
PRUint32 nsIProtocolHandler.URI_LOADABLE_BY_ANYONE = 64
The URIs for this protocol are UNSAFE if loaded by untrusted (web) content and may only be loaded by privileged code (for example, code which has the system principal). Various internal protocols should set this flag.
PRUint32 nsIProtocolHandler.URI_DANGEROUS_TO_LOAD = 128
The URIs for this protocol point to resources that are part of the application's user interface. There are cases when such resources may be made accessible to untrusted content such as web pages, so this is less restrictive than URI_DANGEROUS_TO_LOAD but more restrictive than URI_LOADABLE_BY_ANYONE. See the documentation for nsIScriptSecurityManager::CheckLoadURI.
PRUint32 nsIProtocolHandler.URI_IS_UI_RESOURCE = 256
Loading of URIs for this protocol from other origins should only be allowed if those origins should have access to the local filesystem. It's up to the application to decide what origins should have such access. Protocols like "file" that point to local data should set this flag.
PRUint32 nsIProtocolHandler.URI_IS_LOCAL_FILE = 512
Loading channels from this protocol has side-effects that make it unsuitable for saving to a local file.
PRUint32 nsIProtocolHandler.URI_NON_PERSISTABLE = 1024
Channels using this protocol never call OnDataAvailable on the listener passed to AsyncOpen and they therefore do not return any data that we can use.
PRUint32 nsIProtocolHandler.URI_DOES_NOT_RETURN_DATA = 2048
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 PRBool nsIMsgProtocolInfo.defaultDoBiff

Do biff by default?

nsILocalFile 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 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 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 , PRBool getOnlyNew )
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 ( nsIFile fileToPost , char* newsgroupNames , char* accountKey , nsIUrlListener urlListener , nsIMsgWindow msgWindow )
nsIMsgMessageService void SaveMessageToDisk ( char* messageURI , nsIFile 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.