Mail::Message::Body::Encode

Attributes

$obj->charsetDetectAlgorithm( [CODE|undef|METHOD] )

[3.013] When a body object does not specify its character-set, but that detail is required, then it gets autodetected. The default algorithm is implemented in charsetDetect(). You may change this default algorithm, or pass option "charset_detect" for each call to encode().

When you call this method with an explicit "undef", you reset the default. (Without parameter) the current algorithm ("CODE" or method name) is returned.

Constructing a body

$obj->charsetDetect(%options)

[3.013] This is tricky. It is hard to detect whether the body originates from the program, or from an external source. And what about a database database? are those octets or strings? Please read "Autodetection of character-set" in Mail::Message::Body.

 -Option  --Default
  external  <C<false>>
    

$obj->check()

Check the content of the body not to include illegal characters. Which characters are considered illegal depends on the encoding of this body.

A body is returned which is checked. This may be the body where this method is called upon, but also a new object, when serious changes had to be made. If the check could not be made, because the decoder is not defined, then "undef" is returned.

$obj->encode(%options)

Encode (translate) a Mail::Message::Body into a different format. See the DESCRIPTION above. Options which are not specified will not trigger conversions.

 -Option           --Default
  charset            PERL
  charset_detect     <built-in>
  mime_type          undef
  result_type        <same as source>
  transfer_encoding  undef
    

$obj->encoded(%options)

Encode the body to a format what is acceptable to transmit or write to a folder file. This returns the body where this method was called upon when everything was already prepared, or a new encoded body otherwise. In either case, the body is checked.

 -Option        --Default
  charset_detect  <the default>
    

$obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )

Returns the character (or characters) which are used to separate lines within this body. When a kind of separator is specified, the body is translated to contain the specified line endings.

» example:

  my $body = $msg->decoded->eol('NATIVE');
  my $char = $msg->decoded->eol;
    

$obj->unify($body)

Unify the type of the given $body objects with the type of the called body. "undef" is returned when unification is impossible. If the bodies have the same settings, the $body object is returned unchanged.

Examples:

  my $bodytype = Mail::Message::Body::Lines;
  my $html  = $bodytype->new(mime_type=>'text/html', data => []);
  my $plain = $bodytype->new(mime_type=>'text/plain', ...);
  my $unified = $html->unify($plain);
  # $unified is the data of plain translated to html (if possible).
    

About the payload

$obj->dispositionFilename( [$directory] )

Various fields are searched for "filename" and "name" attributes. Without $directory, the name found will be returned unmodified.

When a $directory is given, a filename is composed. For security reasons, only the basename of the found name gets used and many potentially dangerous characters removed. If no name was found, or when the found name is already in use, then an unique name is generated.

Don't forget to read RFC6266 section 4.3 for the security aspects in your email application.

$obj->isBinary()

Returns "true" when the un-encoded message is binary data. This information is retrieved from knowledge provided by MIME::Types.

$obj->isText()

Returns "true" when the un-encoded message contains printable text.

Internals

$any->addTransferEncHandler( $name, <$class|$object> )

Relate the NAMEd transfer encoding to an OBJECTs or object of the specified $class. In the latter case, an object of that $class will be created on the moment that one is needed to do encoding or decoding.

The $class or $object must extend Mail::Message::TransferEnc. It will replace existing class and object for this $name.

Why aren't you contributing this class to MailBox?

$obj->getTransferEncHandler($type)

Get the transfer encoder/decoder which is able to handle $type, or return "undef" if there is no such handler.