2025-01-06 10:57:38 +07:00
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
from markupsafe import Markup
import re
from odoo . addons . base . models . ir_mail_server import extract_rfc2822_addresses
from odoo . addons . base . models . ir_qweb_fields import nl2br_enclose
from odoo . tests import tagged
from odoo . tests . common import BaseCase
from odoo . tools import misc
from odoo . tools . mail import (
is_html_empty , html2plaintext , html_to_inner_content , html_sanitize , append_content_to_html , plaintext2html ,
email_domain_normalize , email_normalize , email_re ,
email_split , email_split_and_format , email_split_tuples ,
single_email_re ,
formataddr ,
2025-03-04 11:07:12 +07:00
email_anonymize ,
2025-01-06 10:57:38 +07:00
prepend_html_content ,
)
from . import test_mail_examples
@tagged ( ' mail_sanitize ' )
class TestSanitizer ( BaseCase ) :
""" Test the html sanitizer that filters html to remove unwanted attributes """
def test_abrupt_close ( self ) :
payload = """ <!--> <script> alert(1) </script> --> """
html_result = html_sanitize ( payload )
self . assertNotIn ( ' alert(1) ' , html_result )
payload = """ <!---> <script> alert(1) </script> --> """
html_result = html_sanitize ( payload )
self . assertNotIn ( ' alert(1) ' , html_result )
def test_abrut_malformed ( self ) :
payload = """ <!--!> <script> alert(1) </script> --> """
html_result = html_sanitize ( payload )
self . assertNotIn ( ' alert(1) ' , html_result )
payload = """ <!---!> <script> alert(1) </script> --> """
html_result = html_sanitize ( payload )
self . assertNotIn ( ' alert(1) ' , html_result )
def test_basic_sanitizer ( self ) :
cases = [
( " yop " , " <p>yop</p> " ) , # simple
( " lala<p>yop</p>xxx " , " <p>lala</p><p>yop</p>xxx " ) , # trailing text
( " Merci à l ' intérêt pour notre produit.nous vous contacterons bientôt. Merci " ,
u " <p>Merci à l ' intérêt pour notre produit.nous vous contacterons bientôt. Merci</p> " ) , # unicode
]
for content , expected in cases :
html = html_sanitize ( content )
self . assertEqual ( html , expected , ' html_sanitize is broken ' )
def test_comment_malformed ( self ) :
html = ''' <!-- malformed-close --!> <img src= ' x ' onerror= ' alert(1) ' ></img> --> comment <!-- normal comment --> --> out of context balise --!> '''
html_result = html_sanitize ( html )
self . assertNotIn ( ' alert(1) ' , html_result )
def test_comment_multiline ( self ) :
payload = """
< div > < ! - -
multi line comment
- - ! > < / div > < script > alert ( 1 ) < / script > - - >
"""
html_result = html_sanitize ( payload )
self . assertNotIn ( ' alert(1) ' , html_result )
def test_evil_malicious_code ( self ) :
# taken from https://www.owasp.org/index.php/XSS_Filter_Evasion_Cheat_Sheet#Tests
cases = [
( " <IMG SRC=javascript:alert( ' XSS ' )> " ) , # no quotes and semicolons
( " <IMG SRC=javascript:alert('XSS')> " ) , # UTF-8 Unicode encoding
( " <IMG SRC=javascript:alert('XSS')> " ) , # hex encoding
( " <IMG SRC= \" jav
ascript:alert( ' XSS ' ); \" > " ) , # embedded carriage return
( " <IMG SRC= \" jav
ascript:alert( ' XSS ' ); \" > " ) , # embedded newline
( " <IMG SRC= \" jav ascript:alert( ' XSS ' ); \" > " ) , # embedded tab
( " <IMG SRC= \" jav	ascript:alert( ' XSS ' ); \" > " ) , # embedded encoded tab
( " <IMG SRC= \"  javascript:alert( ' XSS ' ); \" > " ) , # spaces and meta-characters
( " <IMG SRC= \" javascript:alert( ' XSS ' ) \" " ) , # half-open html
( " <IMG \" \" \" ><SCRIPT>alert( \" XSS \" )</SCRIPT> \" > " ) , # malformed tag
( " <SCRIPT/XSS SRC= \" http://ha.ckers.org/xss.js \" ></SCRIPT> " ) , # non-alpha-non-digits
( " <SCRIPT/SRC= \" http://ha.ckers.org/xss.js \" ></SCRIPT> " ) , # non-alpha-non-digits
( " <<SCRIPT>alert( \" XSS \" );//<</SCRIPT> " ) , # extraneous open brackets
( " <SCRIPT SRC=http://ha.ckers.org/xss.js?< B > " ) , # non-closing script tags
( " <INPUT TYPE= \" IMAGE \" SRC= \" javascript:alert( ' XSS ' ); \" > " ) , # input image
( " <BODY BACKGROUND= \" javascript:alert( ' XSS ' ) \" > " ) , # body image
( " <IMG DYNSRC= \" javascript:alert( ' XSS ' ) \" > " ) , # img dynsrc
( " <IMG LOWSRC= \" javascript:alert( ' XSS ' ) \" > " ) , # img lowsrc
( " <TABLE BACKGROUND= \" javascript:alert( ' XSS ' ) \" > " ) , # table
( " <TABLE><TD BACKGROUND= \" javascript:alert( ' XSS ' ) \" > " ) , # td
( " <DIV STYLE= \" background-image: url(javascript:alert( ' XSS ' )) \" > " ) , # div background
( " <DIV STYLE= \" background-image: \007 5 \007 2 \006 C \002 8 ' \006 a \006 1 \007 6 \006 1 \007 3 \006 3 \007 2 \006 9 \007 0 \007 4 \003 a \006 1 \006 c \006 5 \007 2 \007 4 \002 8.1027 \005 8.1053 \005 3 \002 7 \002 9 ' \002 9 \" > " ) , # div background with unicoded exploit
( " <DIV STYLE= \" background-image: url(javascript:alert( ' XSS ' )) \" > " ) , # div background + extra characters
( " <IMG SRC= ' vbscript:msgbox( \" XSS \" ) ' > " ) , # VBscrip in an image
( " <BODY ONLOAD=alert( ' XSS ' )> " ) , # event handler
( " <BR SIZE= \" & { alert( ' XSS ' )} \\ > " ) , # & javascript includes
( " <LINK REL= \" stylesheet \" HREF= \" javascript:alert( ' XSS ' ); \" > " ) , # style sheet
( " <LINK REL= \" stylesheet \" HREF= \" http://ha.ckers.org/xss.css \" > " ) , # remote style sheet
( " <STYLE>@import ' http://ha.ckers.org/xss.css ' ;</STYLE> " ) , # remote style sheet 2
( " <META HTTP-EQUIV= \" Link \" Content= \" <http://ha.ckers.org/xss.css>; REL=stylesheet \" > " ) , # remote style sheet 3
( " <STYLE>BODY { -moz-binding:url( \" http://ha.ckers.org/xssmoz.xml#xss \" )}</STYLE> " ) , # remote style sheet 4
( " <IMG STYLE= \" xss:expr/*XSS*/ession(alert( ' XSS ' )) \" > " ) , # style attribute using a comment to break up expression
]
for content in cases :
html = html_sanitize ( content )
self . assertNotIn ( ' javascript ' , html , ' html_sanitize did not remove a malicious javascript ' )
self . assertTrue ( ' ha.ckers.org ' not in html or ' http://ha.ckers.org/xss.css ' in html , ' html_sanitize did not remove a malicious code in %s ( %s ) ' % ( content , html ) )
content = " <!--[if gte IE 4]><SCRIPT>alert( ' XSS ' );</SCRIPT><![endif]--> " # down-level hidden block
self . assertEqual ( html_sanitize ( content , silent = False ) , ' ' )
def test_html ( self ) :
sanitized_html = html_sanitize ( test_mail_examples . MISC_HTML_SOURCE )
for tag in [ ' <div ' , ' <b ' , ' <i ' , ' <u ' , ' <strike ' , ' <li ' , ' <blockquote ' , ' <a href ' ] :
self . assertIn ( tag , sanitized_html , ' html_sanitize stripped too much of original html ' )
for attr in [ ' javascript ' ] :
self . assertNotIn ( attr , sanitized_html , ' html_sanitize did not remove enough unwanted attributes ' )
def test_outlook_mail_sanitize ( self ) :
case = """ <div class= " WordSection1 " >
< p class = " MsoNormal " > Here is a test mail < o : p > < / o : p > < / p >
< p class = " MsoNormal " > < o : p > & nbsp ; < / o : p > < / p >
< p class = " MsoNormal " > With a break line < o : p > < / o : p > < / p >
< p class = " MsoNormal " > < o : p > & nbsp ; < / o : p > < / p >
< p class = " MsoNormal " > < o : p > & nbsp ; < / o : p > < / p >
< p class = " MsoNormal " > Then two < o : p > < / o : p > < / p >
< p class = " MsoNormal " > < o : p > & nbsp ; < / o : p > < / p >
< div >
< div style = " border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in " >
< p class = " MsoNormal " > < b > From : < / b > Mitchell Admin & lt ; dummy @example.com & gt ;
< br >
< b > Sent : < / b > Monday , November 20 , 2023 8 : 34 AM < br >
< b > To : < / b > test user & lt ; dummy @example.com & gt ; < br >
< b > Subject : < / b > test ( #23)<o:p></o:p></p>
< / div >
< / div > """
expected = """ <div class= " WordSection1 " >
< p class = " MsoNormal " > Here is a test mail < / p >
< p class = " MsoNormal " > & nbsp ; < / p >
< p class = " MsoNormal " > With a break line < / p >
< p class = " MsoNormal " > & nbsp ; < / p >
< p class = " MsoNormal " > & nbsp ; < / p >
< p class = " MsoNormal " > Then two < / p >
< p class = " MsoNormal " > & nbsp ; < / p >
< div >
< div style = " border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in " >
< p class = " MsoNormal " > < b > From : < / b > Mitchell Admin & lt ; dummy @example.com & gt ;
< br >
< b > Sent : < / b > Monday , November 20 , 2023 8 : 34 AM < br >
< b > To : < / b > test user & lt ; dummy @example.com & gt ; < br >
< b > Subject : < / b > test ( #23)</p>
< / div >
< / div > < / div > """
result = html_sanitize ( case )
self . assertEqual ( result , expected )
def test_sanitize_unescape_emails ( self ) :
not_emails = [
' <blockquote cite= " mid:CAEJSRZvWvud8c6Qp=wfNG6O1+wK3i_jb33qVrF7XyrgPNjnyUA@mail.gmail.com " type= " cite " >cat</blockquote> ' ,
' <img alt= " @github-login " class= " avatar " src= " /web/image/pi " height= " 36 " width= " 36 " > ' ]
for not_email in not_emails :
sanitized = html_sanitize ( not_email )
left_part = not_email . split ( ' > ' ) [ 0 ] # take only left part, as the sanitizer could add data information on node
self . assertNotIn ( misc . html_escape ( not_email ) , sanitized , ' html_sanitize stripped emails of original html ' )
self . assertIn ( left_part , sanitized )
def test_style_parsing ( self ) :
test_data = [
(
' <span style= " position: fixed; top: 0px; left: 50px; width: 40 % ; height: 50 % ; background-color: red; " >Coin coin </span> ' ,
[ ' background-color:red ' , ' Coin coin ' ] ,
[ ' position ' , ' top ' , ' left ' ]
) , (
""" <div style= ' before: " Email Address; coincoin cheval: lapin " ;
font - size : 30 px ; max - width : 100 % ; after : " Not sure
this ; means : anything ? #ùµ"
; some - property : 2 px ; top : 3 ' >youplaboum</div> " " " ,
[ ' font-size:30px ' , ' youplaboum ' ] ,
[ ' some-property ' , ' top ' , ' cheval ' ]
) , (
' <span style= " width " >Coincoin</span> ' ,
[ ] ,
[ ' width ' ]
)
]
for test , in_lst , out_lst in test_data :
new_html = html_sanitize ( test , sanitize_attributes = False , sanitize_style = True , strip_style = False , strip_classes = False )
for text in in_lst :
self . assertIn ( text , new_html )
for text in out_lst :
self . assertNotIn ( text , new_html )
# style should not be sanitized if removed
new_html = html_sanitize ( test_data [ 0 ] [ 0 ] , sanitize_attributes = False , strip_style = True , strip_classes = False )
self . assertEqual ( new_html , u ' <span>Coin coin </span> ' )
def test_style_class ( self ) :
html = html_sanitize ( test_mail_examples . REMOVE_CLASS , sanitize_attributes = True , sanitize_style = True , strip_classes = True )
for ext in test_mail_examples . REMOVE_CLASS_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . REMOVE_CLASS_OUT :
self . assertNotIn ( ext , html , )
def test_style_class_only ( self ) :
html = html_sanitize ( test_mail_examples . REMOVE_CLASS , sanitize_attributes = False , sanitize_style = True , strip_classes = True )
for ext in test_mail_examples . REMOVE_CLASS_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . REMOVE_CLASS_OUT :
self . assertNotIn ( ext , html , )
def test_edi_source ( self ) :
html = html_sanitize ( test_mail_examples . EDI_LIKE_HTML_SOURCE )
self . assertIn (
' font-family: \' Lucida Grande \' , Ubuntu, Arial, Verdana, sans-serif; ' , html ,
' html_sanitize removed valid styling ' )
self . assertIn (
' src= " https://www.paypal.com/en_US/i/btn/btn_paynowCC_LG.gif " ' , html ,
' html_sanitize removed valid img ' )
self . assertNotIn ( ' </body></html> ' , html , ' html_sanitize did not remove extra closing tags ' )
def test_quote_blockquote ( self ) :
html = html_sanitize ( test_mail_examples . QUOTE_BLOCKQUOTE )
for ext in test_mail_examples . QUOTE_BLOCKQUOTE_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . QUOTE_BLOCKQUOTE_OUT :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s ' % misc . html_escape ( ext ) , html )
def test_quote_thunderbird ( self ) :
html = html_sanitize ( test_mail_examples . QUOTE_THUNDERBIRD_1 )
for ext in test_mail_examples . QUOTE_THUNDERBIRD_1_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . QUOTE_THUNDERBIRD_1_OUT :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s </span> ' % misc . html_escape ( ext ) , html )
def test_quote_hotmail_html ( self ) :
html = html_sanitize ( test_mail_examples . QUOTE_HOTMAIL_HTML )
for ext in test_mail_examples . QUOTE_HOTMAIL_HTML_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . QUOTE_HOTMAIL_HTML_OUT :
self . assertIn ( ext , html )
html = html_sanitize ( test_mail_examples . HOTMAIL_1 )
for ext in test_mail_examples . HOTMAIL_1_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . HOTMAIL_1_OUT :
self . assertIn ( ext , html )
def test_quote_outlook_html ( self ) :
html = html_sanitize ( test_mail_examples . QUOTE_OUTLOOK_HTML )
for ext in test_mail_examples . QUOTE_OUTLOOK_HTML_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . QUOTE_OUTLOOK_HTML_OUT :
self . assertIn ( ext , html )
def test_quote_thunderbird_html ( self ) :
html = html_sanitize ( test_mail_examples . QUOTE_THUNDERBIRD_HTML )
for ext in test_mail_examples . QUOTE_THUNDERBIRD_HTML_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . QUOTE_THUNDERBIRD_HTML_OUT :
self . assertIn ( ext , html )
def test_quote_yahoo_html ( self ) :
html = html_sanitize ( test_mail_examples . QUOTE_YAHOO_HTML )
for ext in test_mail_examples . QUOTE_YAHOO_HTML_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . QUOTE_YAHOO_HTML_OUT :
self . assertIn ( ext , html )
def test_quote_basic_text ( self ) :
test_data = [
(
""" This is Sparta! \n -- \n Administrator \n +9988776655 """ ,
[ ' This is Sparta! ' ] ,
[ ' \n -- \n Administrator \n +9988776655 ' ]
) , (
""" <p>This is Sparta! \n -- \n Administrator</p> """ ,
[ ] ,
[ ' \n -- \n Administrator ' ]
) , (
""" <p>This is Sparta!<br/>--<br>Administrator</p> """ ,
[ ' This is Sparta! ' ] ,
[ ]
) , (
""" This is Sparta! \n >Ah bon ? \n Certes \n > Chouette ! \n Clair """ ,
[ ' This is Sparta! ' , ' Certes ' , ' Clair ' ] ,
[ ' \n >Ah bon ? ' , ' \n > Chouette ! ' ]
)
]
for test , in_lst , out_lst in test_data :
new_html = html_sanitize ( test )
for text in in_lst :
self . assertIn ( text , new_html )
for text in out_lst :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s </span> ' % misc . html_escape ( text ) , new_html )
def test_quote_signature ( self ) :
test_data = [
(
""" <div>Hello<pre>--<br />Administrator</pre></div> """ ,
[ " <pre data-o-mail-quote= \" 1 \" >-- " , " <br data-o-mail-quote= \" 1 \" > " ] ,
)
]
for test , in_lst in test_data :
new_html = html_sanitize ( test )
for text in in_lst :
self . assertIn ( text , new_html )
2025-03-04 11:07:12 +07:00
def test_quote_signature_container_propagation ( self ) :
""" Test that applying normalization twice doesn ' t quote more than wanted. """
# quote signature with bare signature in main block
bare_signature_body = (
" <div> "
" <div><p>Hello</p><p>Here is your document</p></div> "
" <div>--<br>Mark Demo</div> "
" <div class= \" bg-300 \" ></div> "
" </div> "
)
expected_result = (
" <div data-o-mail-quote-container= \" 1 \" > "
" <div><p>Hello</p><p>Here is your document</p></div> "
" <div data-o-mail-quote= \" 1 \" >--<br data-o-mail-quote= \" 1 \" >Mark Demo</div> "
" <div class= \" bg-300 \" data-o-mail-quote= \" 1 \" ></div> "
" </div> "
)
sanitized_once = html_sanitize ( bare_signature_body )
sanitized_twice = html_sanitize ( sanitized_once )
self . assertEqual ( sanitized_once , expected_result )
self . assertEqual ( sanitized_twice , expected_result )
2025-01-06 10:57:38 +07:00
def test_quote_gmail ( self ) :
html = html_sanitize ( test_mail_examples . GMAIL_1 )
for ext in test_mail_examples . GMAIL_1_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . GMAIL_1_OUT :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s </span> ' % misc . html_escape ( ext ) , html )
def test_quote_text ( self ) :
html = html_sanitize ( test_mail_examples . TEXT_1 )
for ext in test_mail_examples . TEXT_1_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . TEXT_1_OUT :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s </span> ' % misc . html_escape ( ext ) , html )
html = html_sanitize ( test_mail_examples . TEXT_2 )
for ext in test_mail_examples . TEXT_2_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . TEXT_2_OUT :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s </span> ' % misc . html_escape ( ext ) , html )
def test_quote_bugs ( self ) :
html = html_sanitize ( test_mail_examples . BUG1 )
for ext in test_mail_examples . BUG_1_IN :
self . assertIn ( ext , html )
for ext in test_mail_examples . BUG_1_OUT :
self . assertIn ( u ' <span data-o-mail-quote= " 1 " > %s </span> ' % misc . html_escape ( ext ) , html )
def test_misc ( self ) :
# False / void should not crash
html = html_sanitize ( ' ' )
self . assertEqual ( html , ' ' )
html = html_sanitize ( False )
self . assertEqual ( html , False )
# Message with xml and doctype tags don't crash
html = html_sanitize ( u ' <?xml version= " 1.0 " encoding= " iso-8859-1 " ?> \n <!DOCTYPE html PUBLIC " -//W3C//DTD XHTML 1.0 Transitional//EN " \n " http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd " > \n <html xmlns= " http://www.w3.org/1999/xhtml " xml:lang= " en " lang= " en " > \n <head> \n <title>404 - Not Found</title> \n </head> \n <body> \n <h1>404 - Not Found</h1> \n </body> \n </html> \n ' )
self . assertNotIn ( ' encoding ' , html )
self . assertNotIn ( ' <title>404 - Not Found</title> ' , html )
self . assertIn ( ' <h1>404 - Not Found</h1> ' , html )
def test_cid_with_at ( self ) :
img_tag = ' <img src= " @ " > '
sanitized = html_sanitize ( img_tag , sanitize_tags = False , strip_classes = True )
self . assertEqual ( img_tag , sanitized , " img with can have cid containing @ and shouldn ' t be escaped " )
# ms office is currently not supported, have to find a way to support it
# def test_30_email_msoffice(self):
# new_html = html_sanitize(test_mail_examples.MSOFFICE_1, remove=True)
# for ext in test_mail_examples.MSOFFICE_1_IN:
# self.assertIn(ext, new_html)
# for ext in test_mail_examples.MSOFFICE_1_OUT:
# self.assertNotIn(ext, new_html)
@tagged ( ' mail_sanitize ' )
class TestHtmlTools ( BaseCase ) :
""" Test some of our generic utility functions about html """
def test_plaintext2html ( self ) :
cases = [
( " First \n Second \n Third \n \n Paragraph \n \r -- \n Signature paragraph " , ' div ' ,
" <div><p>First <br/>Second <br/>Third</p><p>Paragraph</p><p>--<br/>Signature paragraph</p></div> " ) ,
( " First<p>It should be escaped</p> \n Signature " , False ,
" <p>First<p>It should be escaped</p><br/>Signature</p> " )
]
for content , container_tag , expected in cases :
html = plaintext2html ( content , container_tag )
self . assertEqual ( html , expected , ' plaintext2html is broken ' )
def test_html_html_to_inner_content ( self ) :
cases = [
( ' <div><p>First <br/>Second <br/>Third Paragraph</p><p>--<br/>Signature paragraph with a <a href= " ./link " >link</a></p></div> ' ,
' First Second Third Paragraph -- Signature paragraph with a link ' ) ,
( ' <p>Now => processing entities​and extra whitespace too. </p> ' ,
' Now => processing \xa0 entities \u200b and extra whitespace too. ' ) ,
( ' <div>Look what happens with <p>unmatched tags</div> ' , ' Look what happens with unmatched tags ' ) ,
( ' <div>Look what happens with <p unclosed tags</div> Are we good? ' , ' Look what happens with Are we good? ' )
]
for content , expected in cases :
text = html_to_inner_content ( content )
self . assertEqual ( text , expected , ' html_html_to_inner_content is broken ' )
def test_append_to_html ( self ) :
test_samples = [
( ' <!DOCTYPE...><HTML encoding= " blah " >some <b>content</b></HtMl> ' , ' -- \n Yours truly ' , True , True , False ,
' <!DOCTYPE...><html encoding= " blah " >some <b>content</b> \n <pre>-- \n Yours truly</pre> \n </html> ' ) ,
( ' <!DOCTYPE...><HTML encoding= " blah " >some <b>content</b></HtMl> ' , ' -- \n Yours truly ' , True , False , False ,
' <!DOCTYPE...><html encoding= " blah " >some <b>content</b> \n <p>--<br/>Yours truly</p> \n </html> ' ) ,
( ' <html><body>some <b>content</b></body></html> ' , ' -- \n Yours & <truly> ' , True , True , False ,
' <html><body>some <b>content</b> \n <pre>-- \n Yours & <truly></pre> \n </body></html> ' ) ,
( ' <html><body>some <b>content</b></body></html> ' , ' <!DOCTYPE...> \n <html><body> \n <p>--</p> \n <p>Yours truly</p> \n </body> \n </html> ' , False , False , False ,
' <html><body>some <b>content</b> \n \n \n <p>--</p> \n <p>Yours truly</p> \n \n \n </body></html> ' ) ,
]
for html , content , plaintext_flag , preserve_flag , container_tag , expected in test_samples :
self . assertEqual ( append_content_to_html ( html , content , plaintext_flag , preserve_flag , container_tag ) , expected , ' append_content_to_html is broken ' )
def test_is_html_empty ( self ) :
void_strings_samples = [ ' ' , False , ' ' ]
for content in void_strings_samples :
self . assertTrue ( is_html_empty ( content ) )
void_html_samples = [
' <section><br /> <b><i/></b></section> ' ,
' <section><br /> <b><i/ ></b></section> ' ,
' <section><br /> <b>< i/ ></b></section> ' ,
' <section><br /> <b>< i / ></b></section> ' ,
' <p><br></p> ' , ' <p><br> </p> ' , ' <p><br /></p > ' ,
' <p style= " margin: 4px " ></p> ' ,
' <div style= " margin: 4px " ></div> ' ,
' <p class= " oe_testing " ><br></p> ' ,
' <p><span style= " font-weight: bolder; " ><font style= " color: rgb(255, 0, 0); " class= " " ></font></span><br></p> ' ,
]
for content in void_html_samples :
self . assertTrue ( is_html_empty ( content ) , ' Failed with %s ' % content )
valid_html_samples = [
' <p><br>1</p> ' , ' <p>1<br > </p> ' , ' <p style= " margin: 4px " >Hello World</p> ' ,
' <div style= " margin: 4px " ><p>Hello World</p></div> ' ,
' <p><span style= " font-weight: bolder; " ><font style= " color: rgb(255, 0, 0); " class= " " >W</font></span><br></p> ' ,
' <span class= " fa fa-heart " ></span> ' ,
' <i class= " fas fa-home " ></i> '
]
for content in valid_html_samples :
self . assertFalse ( is_html_empty ( content ) )
def test_nl2br_enclose ( self ) :
""" Test formatting of nl2br when using Markup: consider new <br> tags
as trusted without validating the whole input content . """
source_all = [
' coucou ' ,
' <p>coucou</p> ' ,
' coucou \n coucou ' ,
' coucou \n \n coucou ' ,
' <p>coucou \n coucou \n \n zbouip</p> \n ' ,
]
expected_all = [
Markup ( ' <div>coucou</div> ' ) ,
Markup ( ' <div><p>coucou</p></div> ' ) ,
Markup ( ' <div>coucou<br> \n coucou</div> ' ) ,
Markup ( ' <div>coucou<br> \n <br> \n coucou</div> ' ) ,
Markup ( ' <div><p>coucou<br> \n coucou<br> \n <br> \n zbouip</p><br> \n </div> ' ) ,
]
for source , expected in zip ( source_all , expected_all ) :
with self . subTest ( source = source , expected = expected ) :
self . assertEqual (
nl2br_enclose ( source , " div " ) ,
expected ,
)
def test_prepend_html_content ( self ) :
body = """
< html >
< body >
< div > test < / div >
< / body >
< / html >
"""
content = " <span>content</span> "
result = prepend_html_content ( body , content )
result = re . sub ( r ' [ \ s \ t] ' , ' ' , result )
self . assertEqual ( result , " <html><body><span>content</span><div>test</div></body></html> " )
body = " <div>test</div> "
content = " <span>content</span> "
result = prepend_html_content ( body , content )
result = re . sub ( r ' [ \ s \ t] ' , ' ' , result )
self . assertEqual ( result , " <span>content</span><div>test</div> " )
body = """
< body >
< div > test < / div >
< / body >
"""
result = prepend_html_content ( body , content )
result = re . sub ( r ' [ \ s \ t] ' , ' ' , result )
self . assertEqual ( result , " <body><span>content</span><div>test</div></body> " )
body = """
< html >
< body >
< div > test < / div >
< / body >
< / html >
"""
content = """
< html >
< body >
< div > test < / div >
< / body >
< / html >
"""
result = prepend_html_content ( body , content )
result = re . sub ( r ' [ \ s \ t] ' , ' ' , result )
self . assertEqual ( result , " <html><body><div>test</div><div>test</div></body></html> " )
@tagged ( ' mail_tools ' )
class TestEmailTools ( BaseCase ) :
""" Test some of our generic utility functions for emails """
@classmethod
def setUpClass ( cls ) :
super ( TestEmailTools , cls ) . setUpClass ( )
cls . sources = [
# single email
' alfred.astaire@test.example.com ' ,
' alfred.astaire@test.example.com ' ,
' Fredo The Great <alfred.astaire@test.example.com> ' ,
' " Fredo The Great " <alfred.astaire@test.example.com> ' ,
' Fredo " The Great " <alfred.astaire@test.example.com> ' ,
# multiple emails
' alfred.astaire@test.example.com, evelyne.gargouillis@test.example.com ' ,
' Fredo The Great <alfred.astaire@test.example.com>, Evelyne The Goat <evelyne.gargouillis@test.example.com> ' ,
' " Fredo The Great " <alfred.astaire@test.example.com>, evelyne.gargouillis@test.example.com ' ,
' " Fredo The Great " <alfred.astaire@test.example.com>, <evelyne.gargouillis@test.example.com> ' ,
# text containing email
' Hello alfred.astaire@test.example.com how are you ? ' ,
' <p>Hello alfred.astaire@test.example.com</p> ' ,
# text containing emails
' Hello " Fredo " <alfred.astaire@test.example.com>, evelyne.gargouillis@test.example.com ' ,
' Hello " Fredo " <alfred.astaire@test.example.com> and evelyne.gargouillis@test.example.com ' ,
# falsy
' <p>Hello Fredo</p> ' ,
' j \' adore écrire des @gmail.com ou " @gmail.com " a bit randomly ' ,
' ' ,
]
def test_email_domain_normalize ( self ) :
cases = [
( " Test.Com " , " test.com " , " Should have normalized domain " ) ,
( " email@test.com " , False , " Domain is not valid, should return False " ) ,
( False , False , " Domain is not valid, should retunr False " ) ,
]
for source , expected , msg in cases :
self . assertEqual ( email_domain_normalize ( source ) , expected , msg )
def test_email_normalize ( self ) :
""" Test ' email_normalize ' . Note that it is built on ' email_split ' so
some use cases are already managed in ' test_email_split(_and_format) '
hence having more specific test cases here about normalization itself . """
format_name = ' My Super Prénom '
format_name_ascii = ' =?utf-8?b?TXkgU3VwZXIgUHLDqW5vbQ==?= '
sources = [
' " Super Déboulonneur " <deboulonneur@example.com> ' , # formatted
' Déboulonneur deboulonneur@example.com ' , # wrong formatting
' deboulonneur@example.com Déboulonneur ' , # wrong formatting (happens, alas)
' " Super Déboulonneur " <DEBOULONNEUR@example.com>, " Super Déboulonneur 2 " <deboulonneur2@EXAMPLE.com> ' , # multi + case
' Déboulonneur deboulonneur@example.com déboulonneur deboulonneur2@example.com ' , # wrong formatting + wrong multi
' " Déboulonneur 😊 " <deboulonneur.😊@example.com> ' , # unicode in name and email left-part
' " Déboulonneur " <déboulonneur@examplé.com> ' , # utf-8
' " Déboulonneur " <DéBoulonneur@Examplé.com> ' , # utf-8
]
expected_list = [
' deboulonneur@example.com ' ,
' deboulonneur@example.com ' ,
' deboulonneur@example.comdéboulonneur ' ,
False ,
False , # need fix over 'getadresses'
' deboulonneur.😊@example.com ' ,
' déboulonneur@examplé.com ' ,
' DéBoulonneur@examplé.com ' ,
]
expected_fmt_utf8_list = [
f ' " { format_name } " <deboulonneur@example.com> ' ,
f ' " { format_name } " <deboulonneur@example.com> ' ,
f ' " { format_name } " <deboulonneur@example.comdéboulonneur> ' ,
f ' " { format_name } " <@> ' ,
f ' " { format_name } " <@> ' ,
f ' " { format_name } " <deboulonneur.😊@example.com> ' ,
f ' " { format_name } " <déboulonneur@examplé.com> ' ,
f ' " { format_name } " <DéBoulonneur@examplé.com> ' ,
]
expected_fmt_ascii_list = [
f ' { format_name_ascii } <deboulonneur@example.com> ' ,
f ' { format_name_ascii } <deboulonneur@example.com> ' ,
f ' { format_name_ascii } <deboulonneur@example.xn--comdboulonneur-ekb> ' ,
f ' { format_name_ascii } <@> ' ,
f ' { format_name_ascii } <@> ' ,
f ' { format_name_ascii } <deboulonneur.😊@example.com> ' ,
f ' { format_name_ascii } <déboulonneur@xn--exampl-gva.com> ' ,
f ' { format_name_ascii } <DéBoulonneur@xn--exampl-gva.com> ' ,
]
for source , expected , expected_utf8_fmt , expected_ascii_fmt in zip ( sources , expected_list , expected_fmt_utf8_list , expected_fmt_ascii_list ) :
with self . subTest ( source = source ) :
self . assertEqual ( email_normalize ( source , strict = True ) , expected )
# standard usage of formataddr
self . assertEqual ( formataddr ( ( format_name , ( expected or ' ' ) ) , charset = ' utf-8 ' ) , expected_utf8_fmt )
# check using INDA at format time, using ascii charset as done when
# sending emails (see extract_rfc2822_addresses)
self . assertEqual ( formataddr ( ( format_name , ( expected or ' ' ) ) , charset = ' ascii ' ) , expected_ascii_fmt )
def test_email_re ( self ) :
""" Test ' email_re ' , finding emails in a given text """
expected = [
# single email
[ ' alfred.astaire@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' ] ,
# multiple emails
[ ' alfred.astaire@test.example.com ' , ' evelyne.gargouillis@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' , ' evelyne.gargouillis@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' , ' evelyne.gargouillis@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' , ' evelyne.gargouillis@test.example.com ' ] ,
# text containing email
[ ' alfred.astaire@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' ] ,
# text containing emails
[ ' alfred.astaire@test.example.com ' , ' evelyne.gargouillis@test.example.com ' ] ,
[ ' alfred.astaire@test.example.com ' , ' evelyne.gargouillis@test.example.com ' ] ,
# falsy
[ ] , [ ] , [ ] ,
]
for src , exp in zip ( self . sources , expected ) :
res = email_re . findall ( src )
self . assertEqual (
res , exp ,
' Seems email_re is broken with %s (expected %r , received %r ) ' % ( src , exp , res )
)
def test_email_split ( self ) :
""" Test ' email_split ' """
cases = [
( " John <12345@gmail.com> " , [ ' 12345@gmail.com ' ] ) , # regular form
( " d@x; 1@2 " , [ ' d@x ' , ' 1@2 ' ] ) , # semi-colon + extra space
( " ' (ss) ' <123@gmail.com>, ' foo ' <foo@bar> " , [ ' 123@gmail.com ' , ' foo@bar ' ] ) , # comma + single-quoting
( ' " john@gmail.com " <johnny@gmail.com> ' , [ ' johnny@gmail.com ' ] ) , # double-quoting
( ' " <jg> " <johnny@gmail.com> ' , [ ' johnny@gmail.com ' ] ) , # double-quoting with brackets
( ' @gmail.com ' , [ ' @gmail.com ' ] ) , # no left-part
# '@domain' corner cases -- all those return a '@gmail.com' (or equivalent)
# email address when going through 'getaddresses'
# - multi @
( ' fr@ncois.th@notgmail.com ' , [ ' fr@ncois.th ' ] ) ,
( ' f@r@nc.gz,ois@notgmail.com ' , [ ' r@nc.gz ' , ' ois@notgmail.com ' ] ) , # still failing, but differently from 'getaddresses' alone
( ' @notgmail.com esteban_gnole@coldmail.com@notgmail.com ' , [ ' esteban_gnole@coldmail.com ' ] ) ,
# - multi emails (with invalid)
(
' Ivan@dezotos.com Cc iv.an@notgmail.com ' ,
[ ' Ivan@dezotos.com ' , ' iv.an@notgmail.com ' ]
) ,
(
' ivan-dredi@coldmail.com ivan.dredi@notgmail.com ' ,
[ ' ivan-dredi@coldmail.com ' , ' ivan.dredi@notgmail.com ' ]
) ,
(
' @notgmail.com ivan@coincoin.com.ar jeanine@coincoin.com.ar ' ,
[ ' ivan@coincoin.com.ar ' , ' jeanine@coincoin.com.ar ' ]
) ,
(
' @notgmail.com whoareyou@youhou.com. ivan.dezotos@notgmail.com ' ,
[ ' whoareyou@youhou.com ' , ' ivan.dezotos@notgmail.com ' ]
) ,
(
' francois@nc.gz CC: ois@notgmail.com ivan@dezotos.com ' ,
[ ' francois@nc.gz ' , ' ois@notgmail.com ' , ' ivan@dezotos.com ' ]
) ,
(
' francois@nc.gz CC: ois@notgmail.com,ivan@dezotos.com ' ,
[ ' francois@nc.gzCC ' , ' ois@notgmail.com ' , ' ivan@dezotos.com ' ]
) ,
# - separated with '/''
(
' ivan.plein@dezotos.com / ivan.plu@notgmail.com ' ,
[ ' ivan.plein@dezotos.com ' , ' ivan.plu@notgmail.com ' ]
) ,
(
' @notgmail.com ivan.parfois@notgmail.com/ ivan.souvent@notgmail.com ' ,
[ ' ivan.parfois@notgmail.com ' , ' ivan.souvent@notgmail.com ' ]
) ,
# - separated with '-''
( ' ivan@dezotos.com - ivan.dezotos@notgmail.com ' , [ ' ivan@dezotos.com ' , ' ivan.dezotos@notgmail.com ' ] ) ,
(
' car.pool@notgmail.com - co (TAMBO) Registration car.warsh@notgmail.com ' ,
[ ' car.pool@notgmail.com ' , ' car.warsh@notgmail.com ' ]
) ,
]
for source , expected in cases :
with self . subTest ( source = source ) :
self . assertEqual ( email_split ( source ) , expected )
def test_email_split_and_format ( self ) :
""" Test ' email_split_and_format ' , notably in case of multi encapsulation
or multi emails . """
sources = [
' deboulonneur@example.com ' ,
' " Super Déboulonneur " <deboulonneur@example.com> ' , # formatted
# wrong formatting
' Déboulonneur <deboulonneur@example.com ' , # with a final typo
' Déboulonneur deboulonneur@example.com ' , # wrong formatting
' deboulonneur@example.com Déboulonneur ' , # wrong formatting (happens, alas)
# multi
' Déboulonneur, deboulonneur@example.com ' , # multi-like with errors
' deboulonneur@example.com, deboulonneur2@example.com ' , # multi
' Déboulonneur deboulonneur@example.com déboulonneur deboulonneur2@example.com ' , # wrong formatting + wrong multi
# format / misc
' " Déboulonneur " < " Déboulonneur Encapsulated " <deboulonneur@example.com>> ' , # double formatting
' " Super Déboulonneur " <deboulonneur@example.com>, " Super Déboulonneur 2 " <deboulonneur2@example.com> ' ,
' " Super Déboulonneur " <deboulonneur@example.com>, wrong, ' ,
' " Déboulonneur 😊 " <deboulonneur@example.com> ' , # unicode in name
' " Déboulonneur 😊 " <deboulonneur.😊@example.com> ' , # unicode in name and email left-part
' " Déboulonneur " <déboulonneur@examplé.com> ' , # utf-8
]
expected_list = [
[ ' deboulonneur@example.com ' ] ,
[ ' " Super Déboulonneur " <deboulonneur@example.com> ' ] ,
# wrong formatting
[ ' " Déboulonneur " <deboulonneur@example.com> ' ] ,
[ ' " Déboulonneur " <deboulonneur@example.com> ' ] , # extra part correctly considered as a name
[ ' deboulonneur@example.comDéboulonneur ' ] , # concatenated, not sure why
# multi
[ ' deboulonneur@example.com ' ] ,
[ ' deboulonneur@example.com ' , ' deboulonneur2@example.com ' ] ,
[ ' deboulonneur@example.com ' , ' deboulonneur2@example.com ' ] , # need fix over 'getadresses'
# format / misc
[ ' deboulonneur@example.com ' ] ,
[ ' " Super Déboulonneur " <deboulonneur@example.com> ' , ' " Super Déboulonneur 2 " <deboulonneur2@example.com> ' ] ,
[ ' " Super Déboulonneur " <deboulonneur@example.com> ' ] ,
[ ' " Déboulonneur 😊 " <deboulonneur@example.com> ' ] ,
[ ' " Déboulonneur 😊 " <deboulonneur.😊@example.com> ' ] ,
[ ' " Déboulonneur " <déboulonneur@examplé.com> ' ] ,
]
for source , expected in zip ( sources , expected_list ) :
with self . subTest ( source = source ) :
self . assertEqual ( email_split_and_format ( source ) , expected )
def test_email_split_tuples ( self ) :
""" Test ' email_split_and_format ' that returns (name, email) pairs
found in text input """
expected = [
# single email
[ ( ' ' , ' alfred.astaire@test.example.com ' ) ] ,
[ ( ' ' , ' alfred.astaire@test.example.com ' ) ] ,
[ ( ' Fredo The Great ' , ' alfred.astaire@test.example.com ' ) ] ,
[ ( ' Fredo The Great ' , ' alfred.astaire@test.example.com ' ) ] ,
[ ( ' Fredo The Great ' , ' alfred.astaire@test.example.com ' ) ] ,
# multiple emails
[ ( ' ' , ' alfred.astaire@test.example.com ' ) , ( ' ' , ' evelyne.gargouillis@test.example.com ' ) ] ,
[ ( ' Fredo The Great ' , ' alfred.astaire@test.example.com ' ) , ( ' Evelyne The Goat ' , ' evelyne.gargouillis@test.example.com ' ) ] ,
[ ( ' Fredo The Great ' , ' alfred.astaire@test.example.com ' ) , ( ' ' , ' evelyne.gargouillis@test.example.com ' ) ] ,
[ ( ' Fredo The Great ' , ' alfred.astaire@test.example.com ' ) , ( ' ' , ' evelyne.gargouillis@test.example.com ' ) ] ,
# text containing email -> fallback on parsing to extract text from email
[ ( ' Hello ' , ' alfred.astaire@test.example.comhowareyou? ' ) ] ,
[ ( ' Hello ' , ' alfred.astaire@test.example.com ' ) ] ,
[ ( ' Hello Fredo ' , ' alfred.astaire@test.example.com ' ) , ( ' ' , ' evelyne.gargouillis@test.example.com ' ) ] ,
[ ( ' Hello Fredo ' , ' alfred.astaire@test.example.com ' ) , ( ' and ' , ' evelyne.gargouillis@test.example.com ' ) ] ,
# falsy -> probably not designed for that
[ ] ,
[ ( ' j \' adore écrire ' , " des@gmail.comou " ) , ( ' ' , ' @gmail.com ' ) ] , [ ] ,
]
for src , exp in zip ( self . sources , expected ) :
res = email_split_tuples ( src )
self . assertEqual (
res , exp ,
' Seems email_split_tuples is broken with %s (expected %r , received %r ) ' % ( src , exp , res )
)
def test_email_formataddr ( self ) :
""" Test custom ' formataddr ' , notably with IDNA support """
email_base = ' joe@example.com '
email_idna = ' joe@examplé.com '
cases = [
# (name, address), charsets expected
( ( ' ' , email_base ) , [ ' ascii ' , ' utf-8 ' ] , ' joe@example.com ' ) ,
( ( ' joe ' , email_base ) , [ ' ascii ' , ' utf-8 ' ] , ' " joe " <joe@example.com> ' ) ,
( ( ' joe doe ' , email_base ) , [ ' ascii ' , ' utf-8 ' ] , ' " joe doe " <joe@example.com> ' ) ,
( ( ' joe " doe ' , email_base ) , [ ' ascii ' , ' utf-8 ' ] , ' " joe \\ " doe " <joe@example.com> ' ) ,
( ( ' joé ' , email_base ) , [ ' ascii ' ] , ' =?utf-8?b?am/DqQ==?= <joe@example.com> ' ) ,
( ( ' joé ' , email_base ) , [ ' utf-8 ' ] , ' " joé " <joe@example.com> ' ) ,
( ( ' ' , email_idna ) , [ ' ascii ' ] , ' joe@xn--exampl-gva.com ' ) ,
( ( ' ' , email_idna ) , [ ' utf-8 ' ] , ' joe@examplé.com ' ) ,
( ( ' joé ' , email_idna ) , [ ' ascii ' ] , ' =?utf-8?b?am/DqQ==?= <joe@xn--exampl-gva.com> ' ) ,
( ( ' joé ' , email_idna ) , [ ' utf-8 ' ] , ' " joé " <joe@examplé.com> ' ) ,
( ( ' ' , ' joé@example.com ' ) , [ ' ascii ' , ' utf-8 ' ] , ' joé@example.com ' ) ,
]
for pair , charsets , expected in cases :
for charset in charsets :
with self . subTest ( pair = pair , charset = charset ) :
self . assertEqual ( formataddr ( pair , charset ) , expected )
def test_extract_rfc2822_addresses ( self ) :
cases = [
( ' " Admin " <admin@example.com> ' , [ ' admin@example.com ' ] ) ,
( ' " Admin " <admin@example.com>, Demo <demo@test.com> ' , [ ' admin@example.com ' , ' demo@test.com ' ] ) ,
( ' admin@example.com ' , [ ' admin@example.com ' ] ) ,
( ' " Admin " <admin@example.com>, Demo <malformed email> ' , [ ' admin@example.com ' ] ) ,
( ' admin@éxample.com ' , [ ' admin@xn--xample-9ua.com ' ] ) ,
# email-like names
(
' " admin@éxample.com " <admin@éxample.com> ' ,
[ ' admin@xn--xample-9ua.com ' , ' admin@xn--xample-9ua.com ' ] ,
) ,
( ' " Robert Le Grand " <robert@notgmail.com> ' , [ ' robert@notgmail.com ' ] ) ,
( ' " robert@notgmail.com " <robert@notgmail.com> ' , [ ' robert@notgmail.com ' , ' robert@notgmail.com ' ] ) ,
# "@' in names
( ' " Bike @ Home " <bike@example.com> ' , [ ' bike@example.com ' ] ) ,
( ' " Bike@Home " <bike@example.com> ' , [ ' Bike@Home ' , ' bike@example.com ' ] ) ,
# combo @ in names + multi email
(
' " Not an Email " <robert@notgmail.com>, " robert@notgmail.com " <robert@notgmail.com> ' ,
[ ' robert@notgmail.com ' , ' robert@notgmail.com ' , ' robert@notgmail.com ' ] ,
) ,
# accents
( ' DéBoulonneur@examplé.com ' , [ ' DéBoulonneur@xn--exampl-gva.com ' ] ) ,
]
for source , expected in cases :
with self . subTest ( source = source ) :
self . assertEqual ( extract_rfc2822_addresses ( source ) , expected )
def test_single_email_re ( self ) :
""" Test ' single_email_re ' , matching text input containing only one email """
expected = [
# single email
[ ' alfred.astaire@test.example.com ' ] ,
[ ] , [ ] , [ ] , [ ] , # formatting issue for single email re
# multiple emails -> couic
[ ] , [ ] , [ ] , [ ] ,
# text containing email -> couic
[ ] , [ ] ,
# text containing emails -> couic
[ ] , [ ] ,
# falsy
[ ] , [ ] , [ ] ,
]
for src , exp in zip ( self . sources , expected ) :
res = single_email_re . findall ( src )
self . assertEqual (
res , exp ,
' Seems single_email_re is broken with %s (expected %r , received %r ) ' % ( src , exp , res )
)
2025-03-04 11:07:12 +07:00
def test_email_anonymize ( self ) :
cases = [
# examples
( ' admin@example.com ' , ' a****@example.com ' , ' a****@e******.com ' ) , # short
( ' portal@example.com ' , ' p***al@example.com ' , ' p***al@e******.com ' ) , # long
# edge cases
( ' a@example.com ' , ' a@example.com ' , ' a@e******.com ' ) , # single letter
( ' joé@example.com ' , ' j**@example.com ' , ' j**@e******.com ' ) , # hidden unicode
( ' élise@example.com ' , ' é****@example.com ' , ' é****@e******.com ' ) , # visible unicode
( ' admin@[127.0.0.1] ' , ' a****@[127.0.0.1] ' , ' a****@[127.0.0.1] ' ) , # IPv4
( ' admin@[IPv6:::1] ' , ' a****@[IPv6:::1] ' , ' a****@[IPv6:::1] ' ) , # IPv6
# bad cases, to show how the system behave
( ' ' , ' ' , ' ' ) , # empty string
( ' @example.com ' , ' @example.com ' , ' @e******.com ' ) , # missing local part
( ' john ' , ' j*** ' , ' j*** ' ) , # missing domain
( ' Jo <j@example.com> ' , ' J****@example.com> ' , ' J****@e******.com> ' ) , # non-normalized
( ' admin@com ' , ' a****@com ' , ' a****@com ' ) , # dotless domain, prohibited by icann
]
for source , expected , expected_redacted_domain in cases :
with self . subTest ( source = source ) :
self . assertEqual ( email_anonymize ( source ) , expected )
self . assertEqual (
email_anonymize ( source , redact_domain = True ) ,
expected_redacted_domain ,
)
2025-01-06 10:57:38 +07:00
class TestMailTools ( BaseCase ) :
""" Test mail utility methods. """
def test_html2plaintext ( self ) :
self . assertEqual ( html2plaintext ( False ) , ' ' )
self . assertEqual ( html2plaintext ( ' \t ' ) , ' ' )
self . assertEqual ( html2plaintext ( ' ' ) , ' ' )
self . assertEqual ( html2plaintext ( """ <h1>Title</h1>
< h2 > Sub title < / h2 >
< br / >
< h3 > Sub sub title < / h3 >
< h4 > Sub sub sub title < / h4 >
< p > Paragraph < em > with < / em > < b > bold < / b > < / p >
< table > < tr > < td > table element 1 < / td > < / tr > < tr > < td > table element 2 < / td > < / tr > < / table >
< p > < special - chars > 0 & lt ; 10 & amp ; & nbsp ; 10 & gt ; 0 < / special - chars > < / p > """ ),
""" **Title**
* * Sub title * *
* Sub sub title *
Sub sub sub title
Paragraph / with / * bold *
table element 1
table element 2
0 < 10 & \N { NO - BREAK SPACE } 10 > 0 """ )
self . assertEqual ( html2plaintext ( ' <p><img src= " /web/image/428-c064ab1b/test-image.jpg?access_token=f72b5ec5-a363-45fb-b9ad-81fc794d6d7b " class= " img img-fluid o_we_custom_image " ><br></p> ' ) ,
""" test-image [1]
[ 1 ] / web / image / 428 - c064ab1b / test - image . jpg ? access_token = f72b5ec5 - a363 - 45 fb - b9ad - 81 fc794d6d7b """ )
