#
# Copyright (c) 2008-2015 Thierry Florac <tflorac AT ulthar.net>
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
"""PyAMS_mail.message module
This module provides classes which can automatically generate text part of an HTML message.
"""
import codecs
from html import entities
from pyramid_mailer.message import Message
from pyams_utils.html import html_to_text
__docformat__ = 'restructuredtext'
[docs]def html_replace(exc):
"""Handle HTML conversion exceptions"""
if isinstance(exc, (UnicodeEncodeError, UnicodeTranslateError)):
# pylint: disable=invalid-name
s = ['&%s;' % entities.codepoint2name[ord(c)] for c in exc.object[exc.start:exc.end]]
return ''.join(s), exc.end
raise TypeError("Can't handle exception %s" % exc.__name__)
codecs.register_error('html_replace', html_replace)
[docs]def html_encode(unicode_data, encoding='utf-8'):
"""Encode HTML"""
return unicode_data.encode(encoding, 'html_replace')
[docs]def HTMLMessage(subject, fromaddr, toaddr, html, text=None, encoding='utf-8'):
# pylint: disable=invalid-name,too-many-arguments
"""Create a MIME message that will render as HTML or text"""
html = html_encode(html, encoding).decode(encoding)
if text is None:
# produce textual rendering of the HTML string when None is provided
text = html_to_text(html)
if isinstance(toaddr, str):
toaddr = (toaddr,)
return Message(subject=subject,
sender=fromaddr,
recipients=toaddr,
html=html,
body=text)
[docs]def TextMessage(subject, fromaddr, toaddr, text):
# pylint: disable=invalid-name
"""Create a text message"""
if isinstance(toaddr, str):
toaddr = (toaddr,)
return Message(subject=subject,
sender=fromaddr,
recipients=toaddr,
body=text)