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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
|
import re
import imaplib
import datetime
from collections import UserString
from typing import Optional, List, Iterable, Sequence, Union, Tuple, Iterator
from .message import MailMessage
from .folder import MailBoxFolderManager
from .idle import IdleManager
from .consts import UID_PATTERN, PYTHON_VERSION_MINOR, MOVE_RESULT_TAG
from .utils import clean_uids, check_command_status, chunked, encode_folder, clean_flags, check_timeout_arg_support, \
chunked_crop, StrOrBytes
from .errors import MailboxStarttlsError, MailboxLoginError, MailboxLogoutError, MailboxNumbersError, \
MailboxFetchError, MailboxExpungeError, MailboxDeleteError, MailboxCopyError, MailboxFlagError, \
MailboxAppendError, MailboxUidsError, MailboxTaggedResponseError, MailboxMoveError
# Maximal line length when calling readline(). This is to prevent reading arbitrary length lines.
# 20Mb is enough for search response with about 2 000 000 message numbers
imaplib._MAXLINE = 20 * 1024 * 1024 # 20Mb
Criteria = Union[StrOrBytes, UserString]
class BaseMailBox:
"""Working with the email box"""
email_message_class = MailMessage
folder_manager_class = MailBoxFolderManager
idle_manager_class = IdleManager
def __init__(self):
self.client = self._get_mailbox_client()
self.folder = self.folder_manager_class(self)
self.idle = self.idle_manager_class(self)
self.login_result = None
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, exc_traceback):
self.logout()
def _get_mailbox_client(self) -> imaplib.IMAP4:
raise NotImplementedError
def consume_until_tagged_response(self, tag: bytes):
"""Waiting for tagged response"""
tagged_commands = self.client.tagged_commands
response_set = []
while True:
response: bytes = self.client._get_response() # noqa, example: b'IJDH3 OK IDLE Terminated'
if tagged_commands[tag]:
break
response_set.append(response)
result = tagged_commands.pop(tag)
check_command_status(result, MailboxTaggedResponseError)
return result, response_set
def login(self, username: str, password: str, initial_folder: Optional[str] = 'INBOX') -> 'BaseMailBox':
"""Authenticate to account"""
login_result = self.client._simple_command('LOGIN', username, self.client._quote(password)) # noqa
check_command_status(login_result, MailboxLoginError)
self.client.state = 'AUTH' # logic from self.client.login
if initial_folder is not None:
self.folder.set(initial_folder)
self.login_result = login_result
return self # return self in favor of context manager
def login_utf8(self, username: str, password: str, initial_folder: Optional[str] = 'INBOX') -> 'BaseMailBox':
"""Authenticate to an account with a UTF-8 username and/or password"""
# rfc2595 section 6 - PLAIN SASL mechanism
encoded = (b"\0" + username.encode("utf8") + b"\0" + password.encode("utf8"))
# Assumption is the server supports AUTH=PLAIN capability
login_result = self.client.authenticate("PLAIN", lambda x: encoded)
check_command_status(login_result, MailboxLoginError)
if initial_folder is not None:
self.folder.set(initial_folder)
self.login_result = login_result
return self
def xoauth2(self, username: str, access_token: str, initial_folder: Optional[str] = 'INBOX') -> 'BaseMailBox':
"""Authenticate to account using OAuth 2.0 mechanism"""
auth_string = f'user={username}\1auth=Bearer {access_token}\1\1'
result = self.client.authenticate('XOAUTH2', lambda x: auth_string) # noqa
check_command_status(result, MailboxLoginError)
if initial_folder is not None:
self.folder.set(initial_folder)
self.login_result = result
return self
def logout(self) -> tuple:
"""Informs the server that the client is done with the connection"""
result = self.client.logout()
check_command_status(result, MailboxLogoutError, expected='BYE')
return result
def numbers(self, criteria: Criteria = 'ALL', charset: str = 'US-ASCII') -> List[str]:
"""
Search mailbox for matching message numbers in current folder (this is not uids)
Message Sequence Number Message Attribute - to accessing messages by relative position in the mailbox,
it also can be used in mathematical calculations, see rfc3501.
:param criteria: message search criteria (see examples at ./doc/imap_search_criteria.txt)
:param charset: IANA charset, indicates charset of the strings that appear in the search criteria. See rfc2978
:return email message numbers
"""
encoded_criteria = criteria if type(criteria) is bytes else str(criteria).encode(charset)
search_result = self.client.search(charset, encoded_criteria)
check_command_status(search_result, MailboxNumbersError)
return search_result[1][0].decode().split() if search_result[1][0] else []
def numbers_to_uids(self, numbers: List[str]) -> List[str]:
"""Get message uids by message numbers"""
if not numbers:
return []
fetch_result = self.client.fetch(','.join(numbers), "(UID)")
check_command_status(fetch_result, MailboxFetchError)
result = []
for raw_uid_item in fetch_result[1]:
uid_match = re.search(UID_PATTERN, (raw_uid_item or b'').decode())
if uid_match:
result.append(uid_match.group('uid'))
return result
def uids(self, criteria: Criteria = 'ALL', charset: str = 'US-ASCII',
sort: Optional[Union[str, Iterable[str]]] = None) -> List[str]:
"""
Search mailbox for matching message uids in current folder
:param criteria: message search criteria (see examples at ./doc/imap_search_criteria.txt)
:param charset: IANA charset, indicates charset of the strings that appear in the search criteria. See rfc2978
:param sort: criteria for sort messages on server, use SortCriteria constants. Charset arg is important for sort
:return: email message uids
"""
encoded_criteria = criteria if type(criteria) is bytes else str(criteria).encode(charset)
if sort:
sort = (sort,) if isinstance(sort, str) else sort
uid_result = self.client.uid('SORT', f'({" ".join(sort)})', charset, encoded_criteria)
else:
uid_result = self.client.uid('SEARCH', 'CHARSET', charset, encoded_criteria) # *charset are opt here
check_command_status(uid_result, MailboxUidsError)
return uid_result[1][0].decode().split() if uid_result[1][0] else []
def _fetch_by_one(self, uid_list: Sequence[str], message_parts: str) -> Iterator[list]:
for uid in uid_list:
fetch_result = self.client.uid('fetch', uid, message_parts)
check_command_status(fetch_result, MailboxFetchError)
if not fetch_result[1] or fetch_result[1][0] is None:
continue
yield fetch_result[1]
def _fetch_in_bulk(self, uid_list: Sequence[str], message_parts: str, reverse: bool, bulk: int) \
-> Iterator[list]:
if not uid_list:
return
if isinstance(bulk, int) and bulk >= 2:
uid_list_seq = chunked_crop(uid_list, bulk)
elif isinstance(bulk, bool):
uid_list_seq = (uid_list,)
else:
raise ValueError('bulk arg may be bool or int >= 2')
for uid_list_i in uid_list_seq:
fetch_result = self.client.uid('fetch', ','.join(uid_list_i), message_parts)
check_command_status(fetch_result, MailboxFetchError)
if not fetch_result[1] or fetch_result[1][0] is None:
return
for built_fetch_item in chunked((reversed if reverse else iter)(fetch_result[1]), 2):
yield built_fetch_item
def fetch(self, criteria: Criteria = 'ALL', charset: str = 'US-ASCII', limit: Optional[Union[int, slice]] = None,
mark_seen=True, reverse=False, headers_only=False, bulk: Union[bool, int] = False,
sort: Optional[Union[str, Iterable[str]]] = None) \
-> Iterator[MailMessage]:
"""
Mail message generator in current folder by search criteria
:param criteria: message search criteria (see examples at ./doc/imap_search_criteria.txt)
:param charset: IANA charset, indicates charset of the strings that appear in the search criteria. See rfc2978
:param limit: int | slice - limit number of read emails | slice emails range for read
useful for actions with a large number of messages, like "move" | paging
:param mark_seen: mark emails as seen on fetch
:param reverse: in order from the larger date to the smaller
:param headers_only: get only email headers (without text, html, attachments)
:param bulk:
False - fetch each message separately per N commands - low memory consumption, slow
True - fetch all messages per 1 command - high memory consumption, fast. Fails on big bulk at server
int - fetch messages by bulks of the specified size
:param sort: criteria for sort messages on server, use SortCriteria constants. Charset arg is important for sort
:return generator: MailMessage
"""
message_parts = \
f"(BODY{'' if mark_seen else '.PEEK'}[{'HEADER' if headers_only else ''}] UID FLAGS RFC822.SIZE)"
limit_range = slice(0, limit) if type(limit) is int else limit or slice(None)
assert type(limit_range) is slice
uids = tuple((reversed if reverse else iter)(self.uids(criteria, charset, sort)))[limit_range]
if bulk:
message_generator = self._fetch_in_bulk(uids, message_parts, reverse, bulk)
else:
message_generator = self._fetch_by_one(uids, message_parts)
for fetch_item in message_generator:
yield self.email_message_class(fetch_item)
def expunge(self) -> tuple:
result = self.client.expunge()
check_command_status(result, MailboxExpungeError)
return result
def delete(self, uid_list: Union[str, Iterable[str]], chunks: Optional[int] = None) \
-> Optional[List[Tuple[tuple, tuple]]]:
"""
Delete email messages
Do nothing on empty uid_list
:param uid_list: UIDs for delete
:param chunks: Number of UIDs to process at once, to avoid server errors on large set. Proc all at once if None.
:return: None on empty uid_list, command results otherwise
"""
cleaned_uid_list = clean_uids(uid_list)
if not cleaned_uid_list:
return None
results = []
for cleaned_uid_list_i in chunked_crop(cleaned_uid_list, chunks):
store_result = self.client.uid('STORE', ','.join(cleaned_uid_list_i), '+FLAGS', r'(\Deleted)')
check_command_status(store_result, MailboxDeleteError)
expunge_result = self.expunge()
results.append((store_result, expunge_result))
return results
def copy(self, uid_list: Union[str, Iterable[str]], destination_folder: StrOrBytes, chunks: Optional[int] = None) \
-> Optional[List[tuple]]:
"""
Copy email messages into the specified folder.
Do nothing on empty uid_list.
:param uid_list: UIDs for copy
:param destination_folder: Folder for email copies
:param chunks: Number of UIDs to process at once, to avoid server errors on large set. Proc all at once if None.
:return: None on empty uid_list, command results otherwise
"""
cleaned_uid_list = clean_uids(uid_list)
if not cleaned_uid_list:
return None
results = []
for cleaned_uid_list_i in chunked_crop(cleaned_uid_list, chunks):
copy_result = self.client.uid(
'COPY', ','.join(cleaned_uid_list_i), encode_folder(destination_folder)) # noqa
check_command_status(copy_result, MailboxCopyError)
results.append(copy_result)
return results
def move(self, uid_list: Union[str, Iterable[str]], destination_folder: StrOrBytes, chunks: Optional[int] = None) \
-> Optional[List[Tuple[tuple, tuple]]]:
"""
Move email messages into the specified folder.
Do nothing on empty uid_list.
:param uid_list: UIDs for move
:param destination_folder: Folder for move to
:param chunks: Number of UIDs to process at once, to avoid server errors on large set. Proc all at once if None.
:return: None on empty uid_list, command results otherwise
"""
cleaned_uid_list = clean_uids(uid_list)
if not cleaned_uid_list:
return None
if 'MOVE' in self.client.capabilities:
# server side move
results = []
for cleaned_uid_list_i in chunked_crop(cleaned_uid_list, chunks):
move_result = self.client.uid(
'MOVE', ','.join(cleaned_uid_list_i), encode_folder(destination_folder)) # noqa
check_command_status(move_result, MailboxMoveError)
results.append((move_result, MOVE_RESULT_TAG))
return results
else:
# client side move
results = []
for cleaned_uid_list_i in chunked_crop(cleaned_uid_list, chunks):
copy_result = self.copy(cleaned_uid_list_i, destination_folder)
delete_result = self.delete(cleaned_uid_list_i)
results.append((copy_result, delete_result))
return results
def flag(self, uid_list: Union[str, Iterable[str]], flag_set: Union[str, Iterable[str]], value: bool,
chunks: Optional[int] = None) -> Optional[List[Tuple[tuple, tuple]]]:
"""
Set/unset email flags.
Do nothing on empty uid_list.
System flags contains in consts.MailMessageFlags.all
:param uid_list: UIDs for set flag
:param flag_set: Flags for operate
:param value: Should the flags be set: True - yes, False - no
:param chunks: Number of UIDs to process at once, to avoid server errors on large set. Proc all at once if None.
:return: None on empty uid_list, command results otherwise
"""
cleaned_uid_list = clean_uids(uid_list)
if not cleaned_uid_list:
return None
results = []
for cleaned_uid_list_i in chunked_crop(cleaned_uid_list, chunks):
store_result = self.client.uid(
'STORE',
','.join(cleaned_uid_list_i),
('+' if value else '-') + 'FLAGS',
f'({" ".join(clean_flags(flag_set))})'
)
check_command_status(store_result, MailboxFlagError)
expunge_result = self.expunge()
results.append((store_result, expunge_result))
return results
def append(self, message: Union[MailMessage, bytes],
folder: StrOrBytes = 'INBOX',
dt: Optional[datetime.datetime] = None,
flag_set: Optional[Union[str, Iterable[str]]] = None) -> tuple:
"""
Append email messages to server
:param message: MailMessage object or bytes
:param folder: destination folder, INBOX by default
:param dt: email message datetime with tzinfo, now by default, imaplib.Time2Internaldate types supported
:param flag_set: email message flags, no flags by default. System flags at consts.MailMessageFlags.all
:return: command results
"""
if PYTHON_VERSION_MINOR < 6:
timezone = datetime.timezone(datetime.timedelta(hours=0))
else:
timezone = datetime.datetime.now().astimezone().tzinfo # system timezone
cleaned_flags = clean_flags(flag_set or [])
typ, dat = self.client.append(
encode_folder(folder), # noqa
f'({" ".join(cleaned_flags)})' if cleaned_flags else None,
dt or datetime.datetime.now(timezone), # noqa
message if type(message) is bytes else message.obj.as_bytes()
)
append_result = (typ, dat)
check_command_status(append_result, MailboxAppendError)
return append_result
class MailBoxUnencrypted(BaseMailBox):
"""Working with the email box through IMAP4"""
def __init__(self, host='', port=143, timeout=None):
"""
:param host: host's name (default: localhost)
:param port: port number
:param timeout: timeout in seconds for the connection attempt, since python 3.9
"""
check_timeout_arg_support(timeout)
self._host = host
self._port = port
self._timeout = timeout
super().__init__()
def _get_mailbox_client(self) -> imaplib.IMAP4:
if PYTHON_VERSION_MINOR < 9:
return imaplib.IMAP4(self._host, self._port)
elif PYTHON_VERSION_MINOR < 12:
return imaplib.IMAP4(self._host, self._port, self._timeout)
else:
return imaplib.IMAP4(self._host, self._port, timeout=self._timeout)
class MailBox(BaseMailBox):
"""Working with the email box through IMAP4 over SSL connection"""
def __init__(self, host='', port=993, timeout=None, keyfile=None, certfile=None, ssl_context=None):
"""
:param host: host's name (default: localhost)
:param port: port number
:param timeout: timeout in seconds for the connection attempt, since python 3.9
:param keyfile: PEM formatted file that contains your private key (deprecated)
:param certfile: PEM formatted certificate chain file (deprecated)
:param ssl_context: SSLContext object that contains your certificate chain and private key
Since Python 3.9 timeout argument added
Since Python 3.12 keyfile and certfile arguments are deprecated, ssl_context and timeout must be keyword args
"""
check_timeout_arg_support(timeout)
self._host = host
self._port = port
self._timeout = timeout
self._keyfile = keyfile
self._certfile = certfile
self._ssl_context = ssl_context
super().__init__()
def _get_mailbox_client(self) -> imaplib.IMAP4:
if PYTHON_VERSION_MINOR < 9:
return imaplib.IMAP4_SSL(self._host, self._port, self._keyfile, self._certfile, self._ssl_context) # noqa
elif PYTHON_VERSION_MINOR < 12:
return imaplib.IMAP4_SSL(
self._host, self._port, self._keyfile, self._certfile, self._ssl_context, self._timeout) # noqa
else:
return imaplib.IMAP4_SSL(self._host, self._port, ssl_context=self._ssl_context, timeout=self._timeout)
class MailBoxTls(BaseMailBox):
"""Working with the email box through IMAP4 with STARTTLS"""
def __init__(self, host='', port=993, timeout=None, ssl_context=None):
"""
:param host: host's name (default: localhost)
:param port: port number
:param timeout: timeout in seconds for the connection attempt, since python 3.9
:param ssl_context: SSLContext object that contains your certificate chain and private key
"""
check_timeout_arg_support(timeout)
self._host = host
self._port = port
self._timeout = timeout
self._ssl_context = ssl_context
super().__init__()
def _get_mailbox_client(self) -> imaplib.IMAP4:
if PYTHON_VERSION_MINOR < 9:
client = imaplib.IMAP4(self._host, self._port)
elif PYTHON_VERSION_MINOR < 12:
client = imaplib.IMAP4(self._host, self._port, self._timeout)
else:
client = imaplib.IMAP4(self._host, self._port, timeout=self._timeout)
result = client.starttls(self._ssl_context)
check_command_status(result, MailboxStarttlsError)
return client
|