METHODS

Constructors

$class->new( OPTIONS )

Create and initialize a new Mail::Cap object. If you give it an argument it will try to parse the specified file. Without any arguments it will search for the mailcap file using the standard mailcap path, or the MAILCAPS environment variable if it is defined.

Option Default

filename

undef

take

'FIRST'

filename => FILENAME
Add the specified file to the list to standard locations. This file is tried first.
take => 'ALL'|'FIRST'
Include all mailcap files you can find. By default, only the first file is parsed, however the RFC tells us to include ALL. To maintain backwards compatibility, the default only takes the FIRST.
» Example:
  $mcap = new Mail::Cap;
  $mcap = new Mail::Cap "/mydir/mailcap";
  $mcap = new Mail::Cap filename => "/mydir/mailcap";
  $mcap = new Mail::Cap take => 'ALL';
  $mcap = Mail::Cap->new(take => 'ALL');

Run commands

These methods invoke a suitable progam presenting or manipulating the media object in the specified file. They all return 1 if a command was found, and 0 otherwise. You might test $? for the outcome of the command.

$obj->compose( TYPE, FILE )
$obj->edit( TYPE, FILE )
$obj->print( TYPE, FILE )
$obj->view( TYPE, FILE )

Command creator

These methods return a string that is suitable for feeding to system() in order to invoke a suitable progam presenting or manipulating the media object in the specified file. It will return undef if no suitable specification exists.

$obj->composeCmd( TYPE, FILE )
$obj->editCmd( TYPE, FILE )
$obj->printCmd( TYPE, FILE )
$obj->viewCmd( TYPE, FILE )

Look-up definitions

Methods return the corresponding mailcap field for the type.

$obj->description( TYPE )
$obj->field( TYPE, FIELD )

Returns the specified field for the type. Returns undef if no specification exsists.

$obj->nametemplate( TYPE )
$obj->textualnewlines( TYPE )
$obj->x11_bitmap( TYPE )