xref: /third_party/python/Lib/email/mime/text.py (revision 7db96d56)
17db96d56Sopenharmony_ci# Copyright (C) 2001-2006 Python Software Foundation
27db96d56Sopenharmony_ci# Author: Barry Warsaw
37db96d56Sopenharmony_ci# Contact: email-sig@python.org
47db96d56Sopenharmony_ci
57db96d56Sopenharmony_ci"""Class representing text/* type MIME documents."""
67db96d56Sopenharmony_ci
77db96d56Sopenharmony_ci__all__ = ['MIMEText']
87db96d56Sopenharmony_ci
97db96d56Sopenharmony_cifrom email.charset import Charset
107db96d56Sopenharmony_cifrom email.mime.nonmultipart import MIMENonMultipart
117db96d56Sopenharmony_ci
127db96d56Sopenharmony_ci
137db96d56Sopenharmony_ci
147db96d56Sopenharmony_ciclass MIMEText(MIMENonMultipart):
157db96d56Sopenharmony_ci    """Class for generating text/* type MIME documents."""
167db96d56Sopenharmony_ci
177db96d56Sopenharmony_ci    def __init__(self, _text, _subtype='plain', _charset=None, *, policy=None):
187db96d56Sopenharmony_ci        """Create a text/* type MIME document.
197db96d56Sopenharmony_ci
207db96d56Sopenharmony_ci        _text is the string for this message object.
217db96d56Sopenharmony_ci
227db96d56Sopenharmony_ci        _subtype is the MIME sub content type, defaulting to "plain".
237db96d56Sopenharmony_ci
247db96d56Sopenharmony_ci        _charset is the character set parameter added to the Content-Type
257db96d56Sopenharmony_ci        header.  This defaults to "us-ascii".  Note that as a side-effect, the
267db96d56Sopenharmony_ci        Content-Transfer-Encoding header will also be set.
277db96d56Sopenharmony_ci        """
287db96d56Sopenharmony_ci
297db96d56Sopenharmony_ci        # If no _charset was specified, check to see if there are non-ascii
307db96d56Sopenharmony_ci        # characters present. If not, use 'us-ascii', otherwise use utf-8.
317db96d56Sopenharmony_ci        # XXX: This can be removed once #7304 is fixed.
327db96d56Sopenharmony_ci        if _charset is None:
337db96d56Sopenharmony_ci            try:
347db96d56Sopenharmony_ci                _text.encode('us-ascii')
357db96d56Sopenharmony_ci                _charset = 'us-ascii'
367db96d56Sopenharmony_ci            except UnicodeEncodeError:
377db96d56Sopenharmony_ci                _charset = 'utf-8'
387db96d56Sopenharmony_ci
397db96d56Sopenharmony_ci        MIMENonMultipart.__init__(self, 'text', _subtype, policy=policy,
407db96d56Sopenharmony_ci                                  **{'charset': str(_charset)})
417db96d56Sopenharmony_ci
427db96d56Sopenharmony_ci        self.set_payload(_text, _charset)
43