Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Email::MIME::RFC2047::UserdContributed Perl DoEmail::MIME::RFC2047::Encoder(3)

NAME
       Email::MIME::RFC2047::Encoder - Encoding	of non-ASCII MIME headers

VERSION
       version 0.97

SYNOPSIS
	   use Email::MIME::RFC2047::Encoder;

	   my $encoder = Email::MIME::RFC2047::Encoder->new(
	       encoding	=> 'utf-8',
	       method	=> 'Q',
	   );

	   my $encoded_text   =	$encoder->encode_text($string);
	   my $encoded_phrase =	$encoder->encode_phrase($string);

DESCRIPTION
       This module encodes non-ASCII text for MIME email message headers
       according to RFC	2047.

CONSTRUCTOR
   new
	   my $encoder = Email::MIME::RFC2047::Encoder->new(
	       encoding	=> $encoding,
	       method	=> $method,
	   );

       Creates a new encoder object.

       encoding	specifies the encoding ("character set"	in the RFC) to use.
       This is passed to Encode. See Encode::Supported for supported
       encodings.

       method specifies	the encoding method ("encoding"	in the RFC). Must be
       either 'B' or 'Q'.

       If both encoding	and method are omitted,	encoding defaults to 'utf-8'
       and method to 'Q'. If only encoding is omitted, it defaults to 'utf-8'.
       If only method is omitted, it defaults to 'B'.

METHODS
   encode_text
	   my $encoded_text = $encoder->encode_text($string);

       Encodes a string	for use	in any Subject or Comments header field, any
       extension message header	field, or any MIME body	part field for which
       the field body is defined as "unstructured" (RFC	2822) or *text (RFC
       822).  $string is expected to be	an unencoded Perl string.

       This method tries to use	the MIME encoding for as few characters	of the
       input string as possible. So the	result may consist of a	mix of encoded
       and unencoded words.

       The source string is trimmed and	any whitespace is collapsed. The words
       in the result are separated by single space characters without folding
       of long lines.

   encode_phrase
	   my $encoded_phrase =	$encoder->encode_phrase($string);

       Encodes a string	that may replace a "phrase" token (as defined by RFC
       2822), for example, one that precedes an	address	in a From, To, or Cc
       header.

       This method works like encode_text but additionally converts remaining
       text that contains special characters to	"quoted-string"s.

AUTHOR
       Nick Wellnhofer <wellnhofer@aevum.de>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2017 by Nick Wellnhofer.

       This is free software; you can redistribute it and/or modify it under
       the same	terms as the Perl 5 programming	language system	itself.

perl v5.32.0			  2017-07-31  Email::MIME::RFC2047::Encoder(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | CONSTRUCTOR | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Email::MIME::RFC2047::Encoder&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help