Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIMIMEService Interface Reference

The MIME service is responsible for mapping file extensions to MIME-types (see RFC 2045). More...

import "nsIMIMEService.idl";

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

List of all members.

Public Member Functions

nsIMIMEInfo getFromTypeAndExtension (in ACString aMIMEType, in AUTF8String aFileExt)
 Retrieves an nsIMIMEInfo using both the extension and the type of a file.
ACString getTypeFromExtension (in AUTF8String aFileExt)
 Retrieves a ACString representation of the MIME type associated with this file extension.
ACString getTypeFromURI (in nsIURI aURI)
 Retrieves a ACString representation of the MIME type associated with this URI.
ACString getTypeFromFile (in nsIFile aFile)
AUTF8String getPrimaryExtension (in ACString aMIMEType, in AUTF8String aFileExt)
 Given a Type/Extension combination, returns the default extension for this type.

Detailed Description

The MIME service is responsible for mapping file extensions to MIME-types (see RFC 2045).

It also provides access to nsIMIMEInfo interfaces and acts as a general convenience wrapper of nsIMIMEInfo interfaces.

The MIME service maintains a database with a one MIME type to many file extensions rule. Adding the same file extension to multiple MIME types is illegal and behavior is undefined.

See also:
nsIMIMEInfo

Definition at line 65 of file nsIMIMEService.idl.


Member Function Documentation

nsIMIMEInfo nsIMIMEService::getFromTypeAndExtension ( in ACString  aMIMEType,
in AUTF8String  aFileExt 
)

Retrieves an nsIMIMEInfo using both the extension and the type of a file.

The type is given preference during the lookup. One of aMIMEType and aFileExt can be an empty string. At least one of aMIMEType and aFileExt must be nonempty.

AUTF8String nsIMIMEService::getPrimaryExtension ( in ACString  aMIMEType,
in AUTF8String  aFileExt 
)

Given a Type/Extension combination, returns the default extension for this type.

This may be identical to the passed-in extension.

Parameters:
aMIMETypeThe Type to get information on. Must not be empty.
aFileExtFile Extension. Can be empty.
ACString nsIMIMEService::getTypeFromExtension ( in AUTF8String  aFileExt)

Retrieves a ACString representation of the MIME type associated with this file extension.

Parameters:
Afile extension (excluding the dot ('.')).
Returns:
The MIME type, if any.

Retrieves a ACString representation of the MIME type associated with this URI.

The association is purely file extension to MIME type based. No attempt to determine the type via server headers or byte scanning is made.

Parameters:
TheURI the user wants MIME info on.
Returns:
The MIME type, if any.

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