email.Charset
index
/usr/local/lib/python2.4/email/Charset.py
Module Docs

# Copyright (C) 2001-2004 Python Software Foundation
# Author: Ben Gertzfield, Barry Warsaw
# Contact: email-sig@python.org

 
Modules
       
email

 
Classes
       
Charset

 
class Charset
    Map character sets to their email properties.
 
This class provides information about the requirements imposed on email
for a specific character set.  It also provides convenience routines for
converting between character sets, given the availability of the
applicable codecs.  Given a character set, it will do its best to provide
information on how to use that character set in an email in an
RFC-compliant way.
 
Certain character sets must be encoded with quoted-printable or base64
when used in email headers or bodies.  Certain character sets must be
converted outright, and are not allowed in email.  Instances of this
module expose the following information about a character set:
 
input_charset: The initial character set specified.  Common aliases
               are converted to their `official' email names (e.g. latin_1
               is converted to iso-8859-1).  Defaults to 7-bit us-ascii.
 
header_encoding: If the character set must be encoded before it can be
                 used in an email header, this attribute will be set to
                 Charset.QP (for quoted-printable), Charset.BASE64 (for
                 base64 encoding), or Charset.SHORTEST for the shortest of
                 QP or BASE64 encoding.  Otherwise, it will be None.
 
body_encoding: Same as header_encoding, but describes the encoding for the
               mail message's body, which indeed may be different than the
               header encoding.  Charset.SHORTEST is not allowed for
               body_encoding.
 
output_charset: Some character sets must be converted before the can be
                used in email headers or bodies.  If the input_charset is
                one of them, this attribute will contain the name of the
                charset output will be converted to.  Otherwise, it will
                be None.
 
input_codec: The name of the Python codec used to convert the
             input_charset to Unicode.  If no conversion codec is
             necessary, this attribute will be None.
 
output_codec: The name of the Python codec used to convert Unicode
              to the output_charset.  If no conversion codec is necessary,
              this attribute will have the same value as the input_codec.
 
  Methods defined here:
__eq__(self, other)
__init__(self, input_charset='us-ascii')
__ne__(self, other)
__repr__ = __str__(self)
__str__(self)
body_encode(self, s, convert=True)
Body-encode a string and convert it to output_charset.
 
If convert is True (the default), the string will be converted from
the input charset to output charset automatically.  Unlike
header_encode(), there are no issues with byte boundaries and
multibyte charsets in email bodies, so this is usually pretty safe.
 
The type of encoding (base64 or quoted-printable) will be based on
self.body_encoding.
convert(self, s)
Convert a string from the input_codec to the output_codec.
encoded_header_len(self, s)
Return the length of the encoded header string.
from_splittable(self, ustr, to_output=True)
Convert a splittable string back into an encoded string.
 
Uses the proper codec to try and convert the string from Unicode back
into an encoded format.  Return the string as-is if it is not Unicode,
or if it could not be converted from Unicode.
 
Characters that could not be converted from Unicode will be replaced
with an appropriate character (usually '?').
 
If to_output is True (the default), uses output_codec to convert to an
encoded format.  If to_output is False, uses input_codec.
get_body_encoding(self)
Return the content-transfer-encoding used for body encoding.
 
This is either the string `quoted-printable' or `base64' depending on
the encoding used, or it is a function in which case you should call
the function with a single argument, the Message object being
encoded.  The function should then set the Content-Transfer-Encoding
header itself to whatever is appropriate.
 
Returns "quoted-printable" if self.body_encoding is QP.
Returns "base64" if self.body_encoding is BASE64.
Returns "7bit" otherwise.
get_output_charset(self)
Return the output character set.
 
This is self.output_charset if that is not None, otherwise it is
self.input_charset.
header_encode(self, s, convert=False)
Header-encode a string, optionally converting it to output_charset.
 
If convert is True, the string will be converted from the input
charset to the output charset automatically.  This is not useful for
multibyte character sets, which have line length issues (multibyte
characters must be split on a character, not a byte boundary); use the
high-level Header class to deal with these issues.  convert defaults
to False.
 
The type of encoding (base64 or quoted-printable) will be based on
self.header_encoding.
to_splittable(self, s)
Convert a possibly multibyte string to a safely splittable format.
 
Uses the input_codec to try and convert the string to Unicode, so it
can be safely split on character boundaries (even for multibyte
characters).
 
Returns the string as-is if it isn't known how to convert it to
Unicode with the input_charset.
 
Characters that could not be converted to Unicode will be replaced
with the Unicode replacement character U+FFFD.

 
Functions
       
add_alias(alias, canonical)
Add a character set alias.
 
alias is the alias name, e.g. latin-1
canonical is the character set's canonical name, e.g. iso-8859-1
add_charset(charset, header_enc=None, body_enc=None, output_charset=None)
Add character set properties to the global registry.
 
charset is the input character set, and must be the canonical name of a
character set.
 
Optional header_enc and body_enc is either Charset.QP for
quoted-printable, Charset.BASE64 for base64 encoding, Charset.SHORTEST for
the shortest of qp or base64 encoding, or None for no encoding.  SHORTEST
is only valid for header_enc.  It describes how message headers and
message bodies in the input charset are to be encoded.  Default is no
encoding.
 
Optional output_charset is the character set that the output should be
in.  Conversions will proceed from input charset, to Unicode, to the
output charset when the method Charset.convert() is called.  The default
is to output in the same character set as the input.
 
Both input_charset and output_charset must have Unicode codec entries in
the module's charset-to-codec mapping; use add_codec(charset, codecname)
to add codecs the module does not know about.  See the codecs module's
documentation for more information.
add_codec(charset, codecname)
Add a codec that map characters in the given charset to/from Unicode.
 
charset is the canonical name of a character set.  codecname is the name
of a Python codec, as appropriate for the second argument to the unicode()
built-in, or to the encode() method of a Unicode string.

 
Data
        ALIASES = {'ascii': 'us-ascii', 'cp949': 'ks_c_5601-1987', 'euc_jp': 'euc-jp', 'euc_kr': 'euc-kr', 'latin-1': 'iso-8859-1', 'latin-2': 'iso-8859-2', 'latin-3': 'iso-8859-3', 'latin-4': 'iso-8859-4', 'latin-5': 'iso-8859-9', 'latin-6': 'iso-8859-10', ...}
BASE64 = 2
CHARSETS = {'8bit': (None, 2, 'utf-8'), 'big5': (2, 2, None), 'euc-jp': (2, None, 'iso-2022-jp'), 'gb2312': (2, 2, None), 'iso-2022-jp': (2, None, None), 'iso-8859-1': (1, 1, None), 'iso-8859-10': (1, 1, None), 'iso-8859-13': (1, 1, None), 'iso-8859-14': (1, 1, None), 'iso-8859-15': (1, 1, None), ...}
CODEC_MAP = {'big5': 'big5_tw', 'gb2312': 'eucgb2312_cn', 'us-ascii': None}
DEFAULT_CHARSET = 'us-ascii'
MISC_LEN = 7
QP = 1
SHORTEST = 3