1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
|
import re
import sys
import datetime
from itertools import zip_longest
from email.utils import getaddresses, parsedate_to_datetime
from email.header import decode_header, Header
from typing import Union, Optional, Tuple, Iterable, Any, List, Dict, Iterator, Sequence
from .consts import SHORT_MONTH_NAMES, MailMessageFlags
from .imap_utf7 import utf7_encode
StrOrBytes = Union[str, bytes]
def clean_uids(uid_set: Union[str, Iterable[str]]) -> List[str]:
"""
Prepare set of uid for use in IMAP commands
uid RE patterns are not strict and allow invalid combinations, but simple. Example: 2,4:7,9,12:*
:param uid_set:
str, that is comma separated uids
Iterable, that contains str uids
:return: list of str - cleaned uids
"""
# str
if type(uid_set) is str:
if re.search(r'^([\d*:]+,)*[\d*:]+$', uid_set): # *optimization for already good str
return uid_set.split(',')
uid_set = uid_set.split(',')
# check uid types
for uid in uid_set:
if type(uid) is not str:
raise TypeError(f'uid "{str(uid)}" is not string')
if not re.match(r'^[\d*:]+$', uid.strip()):
raise TypeError(f'Wrong uid: "{uid}"')
return [i.strip() for i in uid_set]
def check_command_status(command_result: tuple, exception: type, expected='OK'):
"""
Check that IMAP command responses status equals <expected> status
If not, raise specified <exception>
:param command_result: imap command result: tuple(typ, data)
:param exception: exception subclass of UnexpectedCommandStatusError, that raises
:param expected: expected command status
"""
typ, data = command_result[0], command_result[1]
if typ != expected:
raise exception(command_result=command_result, expected=expected)
def decode_value(value: StrOrBytes, encoding: Optional[str] = None) -> str:
"""Converts value to utf-8 encoding"""
if isinstance(encoding, str):
encoding = encoding.lower()
if isinstance(value, bytes):
try:
return value.decode(encoding or 'utf-8', 'ignore')
except LookupError: # unknown encoding
return value.decode('utf-8', 'ignore')
return value
class EmailAddress:
"""Parsed email address info"""
__slots__ = 'name', 'email'
def __init__(self, name: str, email: str):
self.name = name
self.email = email
@property
def full(self):
return f'{self.name} <{self.email}>' if self.name and self.email else self.name or self.email
def __repr__(self):
return f"{self.__class__.__name__}(name={repr(self.name)}, email={repr(self.email)})"
def __eq__(self, other):
return all(getattr(self, i) == getattr(other, i) for i in self.__slots__)
def remove_non_printable(value: str) -> str:
"""Remove non-printable character from value"""
return ''.join(i for i in value if i.isprintable())
def parse_email_addresses(raw_header: Union[str, Header]) -> Tuple[EmailAddress, ...]:
"""
Parse email addresses from header
:param raw_header: example: '=?UTF-8?B?0J7Qu9C1=?= <name@company.ru>,\r\n "\'\\"z, z\\"\'" <imap.tools@ya.ru>'
:return: (EmailAddress, ...)
"""
result = []
if type(raw_header) is Header:
raw_header = decode_value(*decode_header(raw_header)[0])
for raw_name, email in getaddresses([remove_non_printable(raw_header)]):
name = decode_value(*decode_header(raw_name)[0]).strip()
email = email.strip()
if not (name or email):
continue
result.append(EmailAddress(
name=name or (email if '@' not in email else ''),
email=email if '@' in email else '',
))
return tuple(result)
def parse_email_date(value: str) -> datetime.datetime:
"""
Parsing the date described in rfc2822
Result datetime may be naive or with tzinfo
1900-1-1 for unparsed
"""
try:
return parsedate_to_datetime(value)
except Exception: # noqa
pass
match = re.search(
r'(?P<date>\d{1,2}\s+(' + '|'.join(SHORT_MONTH_NAMES) + r')\s+\d{4})\s+' +
r'(?P<time>\d{1,2}:\d{1,2}(:\d{1,2})?)\s*' +
r'(?P<zone_sign>[+-])?(?P<zone>\d{4})?',
value
)
if match:
group = match.groupdict()
day, month, year = group['date'].split()
time_values = group['time'].split(':')
zone_sign = int(f'{group.get("zone_sign") or "+"}1')
zone = group['zone']
try:
return datetime.datetime(
year=int(year),
month=SHORT_MONTH_NAMES.index(month) + 1,
day=int(day),
hour=int(time_values[0]),
minute=int(time_values[1]),
second=int(time_values[2]) if len(time_values) > 2 else 0,
tzinfo=datetime.timezone(datetime.timedelta(
hours=int(zone[:2]) * zone_sign,
minutes=int(zone[2:]) * zone_sign
)) if zone else None,
)
except ValueError:
pass
return datetime.datetime(1900, 1, 1)
def quote(value: StrOrBytes) -> StrOrBytes:
if isinstance(value, str):
return '"' + value.replace('\\', '\\\\').replace('"', '\\"') + '"'
else:
return b'"' + value.replace(b'\\', b'\\\\').replace(b'"', b'\\"') + b'"'
def pairs_to_dict(items: List[Any]) -> Dict[Any, Any]:
"""Example: ['MESSAGES', '3', 'UIDNEXT', '4'] -> {'MESSAGES': '3', 'UIDNEXT': '4'}"""
if len(items) % 2 != 0:
raise ValueError('An even-length array is expected')
return dict((items[i * 2], items[i * 2 + 1]) for i in range(len(items) // 2))
def encode_folder(folder: StrOrBytes) -> bytes:
"""Encode folder name"""
if isinstance(folder, bytes):
return folder
else:
return quote(utf7_encode(folder))
def clean_flags(flag_set: Union[str, Iterable[str]]) -> List[str]:
"""
Check the correctness of the flags
:return: list of str - flags
"""
if type(flag_set) is str:
flag_set = [flag_set]
upper_sys_flags = tuple(i.upper() for i in MailMessageFlags.all)
for flag in flag_set:
if not type(flag) is str:
raise ValueError(f'Flag - str value expected, but {type(flag_set)} received')
if flag.upper() not in upper_sys_flags and flag.startswith('\\'):
raise ValueError('Non system flag must not start with "\\"')
return flag_set
def check_timeout_arg_support(timeout):
"""If timeout arg not supports - raise ValueError"""
if timeout is not None and sys.version_info.minor < 9:
raise ValueError('imaplib.IMAP4 timeout argument supported since python 3.9')
def replace_html_ct_charset(html: str, new_charset: str) -> str:
"""Replace charset in META tag with content-type attribute in HTML text"""
meta_ct_match = re.search(r'<\s*meta .*?content-type.*?>', html, re.IGNORECASE | re.DOTALL)
if meta_ct_match:
meta = meta_ct_match.group(0)
meta_new = re.sub(
pattern=r'charset\s*=\s*[a-zA-Z0-9_:.+-]+',
repl=f'charset={new_charset}',
string=meta,
count=1,
flags=re.IGNORECASE
)
html = html.replace(meta, meta_new)
return html
def chunked(iterable: Iterable[Any], n: int, fill_value: Optional[Any] = None) -> Iterator[Tuple[Any, ...]]:
"""
Group data into fixed-length chunks or blocks
[iter(iterable)]*n creates one iterator, repeated n times in the list
izip_longest then effectively performs a round-robin of "each" (same) iterator
Examples:
chunked('ABCDEFGH', 3, '?') --> [('A', 'B', 'C'), ('D', 'E', 'F'), ('G', 'H', '?')]
chunked([1, 2, 3, 4, 5], 2) --> [(1, 2), (3, 4), (5, None)]
"""
return zip_longest(*[iter(iterable)] * n, fillvalue=fill_value)
def chunked_crop(seq: Sequence, chunk_size: Optional[int]) -> Iterator[list]:
"""
Yield successive n-sized chunks from seq.
Yield seq if chunk_size is False-like
:param seq: Sequence to chunks
:param chunk_size: chunk size
:return: Iterator
import pprint
pprint.pprint(list(chunked_crop(range(10, 75), 10)))
[[10, 11, 12, 13, 14, 15, 16, 17, 18, 19],
[20, 21, 22, 23, 24, 25, 26, 27, 28, 29],
[30, 31, 32, 33, 34, 35, 36, 37, 38, 39],
[40, 41, 42, 43, 44, 45, 46, 47, 48, 49],
[50, 51, 52, 53, 54, 55, 56, 57, 58, 59],
[60, 61, 62, 63, 64, 65, 66, 67, 68, 69],
[70, 71, 72, 73, 74]]
"""
if not chunk_size:
yield seq
return
if chunk_size < 0:
raise ValueError('False-like or int>=0 expected')
for i in range(0, len(seq), chunk_size):
yield seq[i:i + chunk_size]
|