MAN page from Other LWP.pm-5.48-2.i386.rpm

lib::LWP::MediaTypes

Section: User Contributed Perl Documentation (3)
Updated: libwww-perl-5.48
Index

NAME

LWP::MediaTypes - guess media type for a file or a URL

SYNOPSIS

 use LWP::MediaTypes qw(guess_media_type); $type = guess_media_type("/tmp/foo.gif");

DESCRIPTION

This module provides functions for handling media (also known asMIME) types and encodings. The mapping from file extentions to mediatypes is defined by the media.types file. If the ~/.media.typesfile exists it is used instead.For backwards compatability we will also look for ~/.mime.types.

The following functions are exported by default:

guess_media_type($filename_or_url, [$header_to_modify])

This function tries to guess media type and encoding for a file or url.It returns the content-type, which is a string like "text/html".In array context it also returns any content-encodings applied (in theorder used to encode the file). You can pass a URI objectreference, instead of the file name.

If the type can not be deduced from looking at the file name,then guess_media_type() will let the -T Perl operator take a look.If this works (and -T returns a TRUE value) then we returntext/plain as the type, otherwise we returnapplication/octet-stream as the type.

The optional second argument should be a reference to a HTTP::Headersobject or any object that implements the $obj->header method in asimilar way. When it is present the values of the'Content-Type' and `Content-Encoding' will be set for this header.

media_suffix($type,...)

This function will return all suffixes that can be used to denote thespecified media type(s). Wildcard types can be used. In a scalarcontext it will return the first suffix found.

Examples:

  @suffixes = media_suffix('image/*', 'audio/basic');  $suffix = media_suffix('text/html');

The following functions are only exported by explict request:

add_type($type, @exts)

Associate a list of file extensions with the given media type.

Example:

    add_type("x-world/x-vrml" => qw(wrl vrml));

add_encoding($type, @ext)

Associate a list of file extensions with an encoding type.

Example:

 add_encoding("x-gzip" => "gz");

read_media_types(@files)

Parse media types files and add the type mappings found there.

Example:

    read_media_types("conf/mime.types");

COPYRIGHT

This library is free software; you can redistribute it and/ormodify it under the same terms as Perl itself.

This document was created byman2html,using the manual pages.