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
|
"""IMAP Query builder"""
import datetime
import itertools
import functools
from collections import UserString
from typing import Iterable, Optional, Dict, Any, List, Union, Iterator
from .consts import SHORT_MONTH_NAMES
from .utils import clean_uids, quote
class Header:
"""Header value for search by header key"""
__slots__ = ('name', 'value')
def __init__(self, name: str, value: str):
if not isinstance(name, str):
raise TypeError(f'Header-name expected str value, "{type(name)}" received')
self.name = quote(name)
if not isinstance(value, str):
raise TypeError(f'Header-value expected str value, "{type(value)}" received')
self.value = quote(value)
def __str__(self):
return f'{self.name}: {self.value}'
def __lt__(self, other):
return f'{self.name}{self.value}' < f'{other.name}{other.value}'
class UidRange:
"""
UID range value for search by uid key
* - represents the largest number in use.
x:y - represents sequence range, example: 4:*
NOTE: UID range of <value>:* always includes the UID of the last message in the mailbox,
even if <value> is higher than any assigned UID value ->
any UID range with * indicates at least one message (with the highest numbered UID), unless the mailbox is empty.
"""
__slots__ = ('start', 'end')
def __init__(self, start: str, end: Optional[str] = None):
self.start = str(start).strip()
if not (self.start.isdigit() or self.start == '*'):
raise TypeError('UidRange start arg must be str with digits or *')
if end is None:
self.end = None
else:
self.end = str(end).strip()
if not (self.end.isdigit() or self.end == '*'):
raise TypeError('UidRange end arg must be str with digits or *')
def __str__(self):
return f'{self.start}{f":{self.end}" if self.end else ""}'
class LogicOperator(UserString):
def __init__(
self,
*converted_strings: Union[str, UserString],
answered: Optional[bool] = None,
seen: Optional[bool] = None,
flagged: Optional[bool] = None,
draft: Optional[bool] = None,
deleted: Optional[bool] = None,
keyword: Optional[Union[str, List[str]]] = None,
no_keyword: Optional[Union[str, List[str]]] = None,
from_: Optional[Union[str, List[str]]] = None,
to: Optional[Union[str, List[str]]] = None,
subject: Optional[Union[str, List[str]]] = None,
body: Optional[Union[str, List[str]]] = None,
text: Optional[Union[str, List[str]]] = None,
bcc: Optional[Union[str, List[str]]] = None,
cc: Optional[Union[str, List[str]]] = None,
date: Optional[Union[datetime.date, List[datetime.date]]] = None,
date_gte: Optional[Union[datetime.date, List[datetime.date]]] = None,
date_lt: Optional[Union[datetime.date, List[datetime.date]]] = None,
sent_date: Optional[Union[datetime.date, List[datetime.date]]] = None,
sent_date_gte: Optional[Union[datetime.date, List[datetime.date]]] = None,
sent_date_lt: Optional[Union[datetime.date, List[datetime.date]]] = None,
size_gt: Optional[int] = None,
size_lt: Optional[int] = None,
new: Optional[bool] = None,
old: Optional[bool] = None,
recent: Optional[bool] = None,
all: Optional[bool] = None, # noqa
uid: Optional[Union[str, Iterable[str], UidRange]] = None,
header: Optional[Union[Header, List[Header]]] = None,
gmail_label: Optional[Union[str, List[str]]] = None):
self.converted_strings = converted_strings
for val in converted_strings:
if not any(isinstance(val, t) for t in (str, UserString)):
raise TypeError(f'Unexpected type "{type(val)}" for converted part, str like obj expected')
unconverted_dict = {k: v for k, v in locals().items() if k in SEARCH_KEYS and v is not None}
self.converted_params = ParamConverter(unconverted_dict).convert()
if not any((self.converted_strings, self.converted_params)):
raise ValueError(f'{self.__class__.__name__} expects params')
super().__init__(self.combine_params())
def combine_params(self) -> str:
"""combine self.converted_strings and self.converted_params to IMAP search criteria format"""
raise NotImplementedError
@staticmethod
def prefix_join(operator: str, params: Iterable[str]) -> str:
"""Join params by prefix notation rules, enclose group in parentheses"""
return f'({functools.reduce(lambda a, b: f"{operator}{a} {b}", params)})'
class AND(LogicOperator):
"""Combines conditions by logical AND"""
def combine_params(self) -> str:
return self.prefix_join('', itertools.chain(self.converted_strings, self.converted_params))
class OR(LogicOperator):
"""Combines conditions by logical OR"""
def combine_params(self) -> str:
return self.prefix_join('OR ', itertools.chain(self.converted_strings, self.converted_params))
class NOT(LogicOperator):
"""Inverts the result of a logical expression"""
def combine_params(self) -> str:
return f'NOT {self.prefix_join("", itertools.chain(self.converted_strings, self.converted_params))}'
class ParamConverter:
"""Convert search params to IMAP format"""
multi_key_allowed = (
'keyword', 'no_keyword', 'from_', 'to', 'subject', 'body', 'text', 'bcc', 'cc',
'date', 'date_gte', 'date_lt', 'sent_date', 'sent_date_gte', 'sent_date_lt',
'header', 'gmail_label',
)
def __init__(self, params: Dict[str, Any]):
self.params = params
def _gen_values(self, key: str, value: Any) -> Iterator[Any]:
"""Values generator"""
# single value
if key not in self.multi_key_allowed or isinstance(value, str):
yield value
else:
try:
# multiple values
for i in value:
yield i
except TypeError:
# single value
yield value
def convert(self) -> List[str]:
"""
:return: params in IMAP format
"""
converted = []
for key, raw_val in sorted(self.params.items(), key=lambda x: x[0]):
for val in sorted(self._gen_values(key, raw_val)):
convert_func = getattr(self, f'convert_{key}', None)
if not convert_func:
raise KeyError(f'"{key}" is an invalid parameter.')
converted.append(convert_func(key, val))
return converted
@classmethod
def format_date(cls, value: datetime.date) -> str:
"""To avoid locale affects"""
return f'{value.day}-{SHORT_MONTH_NAMES[value.month - 1]}-{value.year}'
@staticmethod
def cleaned_str(key: str, value: str) -> str:
if type(value) is not str:
raise TypeError(f'"{key}" expected str value, "{type(value)}" received')
return str(value)
@staticmethod
def cleaned_date(key: str, value: datetime.date) -> datetime.date:
if type(value) is not datetime.date:
raise TypeError(f'"{key}" expected datetime.date value, "{type(value)}" received')
return value
@staticmethod
def cleaned_bool(key: str, value: bool) -> bool:
if type(value) is not bool:
raise TypeError(f'"{key}" expected bool value, "{type(value)}" received')
return bool(value)
@staticmethod
def cleaned_true(key: str, value: bool) -> True:
if value is not True:
raise TypeError(f'"{key}" expected "True", "{type(value)}" received')
return True
@staticmethod
def cleaned_uint(key: str, value: int) -> int:
if type(value) is not int or int(value) < 0:
raise TypeError(f'"{key}" expected int value >= 0, "{type(value)}" received')
return int(value)
@staticmethod
def cleaned_uid(key: str, value: Union[str, Iterable[str], UidRange]) -> str:
# range
if isinstance(value, UidRange):
return str(value)
# set
try:
return ','.join(clean_uids(value))
except TypeError as e:
raise TypeError(f'{key} parse error: {str(e)}')
@staticmethod
def cleaned_header(key: str, value: Header) -> Header:
if not isinstance(value, Header):
raise TypeError(f'"{key}" expected Header (H) value, "{type(value)}" received')
return value
def convert_answered(self, key, value) -> str:
"""Messages [with/without] the Answered flag set. (ANSWERED, UNANSWERED)"""
return 'ANSWERED' if self.cleaned_bool(key, value) else 'UNANSWERED'
def convert_seen(self, key, value) -> str:
"""Messages that [have/do not have] the Seen flag set. (SEEN, UNSEEN)"""
return 'SEEN' if self.cleaned_bool(key, value) else 'UNSEEN'
def convert_flagged(self, key, value) -> str:
"""Messages [with/without] the Flagged flag set. (FLAGGED, UNFLAGGED)"""
return 'FLAGGED' if self.cleaned_bool(key, value) else 'UNFLAGGED'
def convert_draft(self, key, value) -> str:
"""Messages that [have/do not have] the Draft flag set. (DRAFT, UNDRAFT)"""
return 'DRAFT' if self.cleaned_bool(key, value) else 'UNDRAFT'
def convert_deleted(self, key, value) -> str:
"""Messages that [have/do not have] the Deleted flag set. (DELETED, UNDELETED)"""
return 'DELETED' if self.cleaned_bool(key, value) else 'UNDELETED'
def convert_keyword(self, key, value) -> str:
"""Messages with the specified keyword flag set. (KEYWORD)"""
return f'KEYWORD {self.cleaned_str(key, value)}'
def convert_no_keyword(self, key, value) -> str:
"""Messages that do not have the specified keyword flag set. (UNKEYWORD)"""
return f'UNKEYWORD {self.cleaned_str(key, value)}'
def convert_from_(self, key, value) -> str:
"""Messages that contain the specified string in the envelope structure's FROM field."""
return f'FROM {quote(self.cleaned_str(key, value))}'
def convert_to(self, key, value) -> str:
"""Messages that contain the specified string in the envelope structure's TO field."""
return f'TO {quote(self.cleaned_str(key, value))}'
def convert_subject(self, key, value) -> str:
"""Messages that contain the specified string in the envelope structure's SUBJECT field."""
return f'SUBJECT {quote(self.cleaned_str(key, value))}'
def convert_body(self, key, value) -> str:
"""Messages that contain the specified string in the body of the message."""
return f'BODY {quote(self.cleaned_str(key, value))}'
def convert_text(self, key, value) -> str:
"""Messages that contain the specified string in the header or body of the message."""
return f'TEXT {quote(self.cleaned_str(key, value))}'
def convert_bcc(self, key, value) -> str:
"""Messages that contain the specified string in the envelope structure's BCC field."""
return f'BCC {quote(self.cleaned_str(key, value))}'
def convert_cc(self, key, value) -> str:
"""Messages that contain the specified string in the envelope structure's CC field."""
return f'CC {quote(self.cleaned_str(key, value))}'
def convert_date(self, key, value) -> str:
"""
Messages whose internal date (disregarding time and timezone)
is within the specified date. (ON)
"""
return f'ON {self.format_date(self.cleaned_date(key, value))}'
def convert_date_gte(self, key, value) -> str:
"""
Messages whose internal date (disregarding time and timezone)
is within or later than the specified date. (SINCE)
"""
return f'SINCE {self.format_date(self.cleaned_date(key, value))}'
def convert_date_lt(self, key, value) -> str:
"""
Messages whose internal date (disregarding time and timezone)
is earlier than the specified date. (BEFORE)
"""
return f'BEFORE {self.format_date(self.cleaned_date(key, value))}'
def convert_sent_date(self, key, value) -> str:
"""
Messages whose [RFC-2822] Date: header (disregarding time and timezone)
is within the specified date. (SENTON)
"""
return f'SENTON {self.format_date(self.cleaned_date(key, value))}'
def convert_sent_date_gte(self, key, value) -> str:
"""
Messages whose [RFC-2822] Date: header (disregarding time and timezone)
is within or later than the specified date. (SENTSINCE)
"""
return f'SENTSINCE {self.format_date(self.cleaned_date(key, value))}'
def convert_sent_date_lt(self, key, value) -> str:
"""
Messages whose [RFC-2822] Date: header (disregarding time and timezone)
is earlier than the specified date. (SENTBEFORE)
"""
return f'SENTBEFORE {self.format_date(self.cleaned_date(key, value))}'
def convert_size_gt(self, key, value) -> str:
"""Messages with an [RFC-2822] size larger than the specified number of octets. (LARGER)"""
return f'LARGER {self.cleaned_uint(key, value)}'
def convert_size_lt(self, key, value) -> str:
"""Messages with an [RFC-2822] size smaller than the specified number of octets. (SMALLER)"""
return f'SMALLER {self.cleaned_uint(key, value)}'
def convert_new(self, key, value) -> str:
"""
Messages that have the Recent flag set but not the Seen flag.
This is functionally equivalent to "(RECENT UNSEEN)".
"""
self.cleaned_true(key, value)
return 'NEW'
def convert_old(self, key, value) -> str:
"""
Messages that do not have the Recent flag set.
This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
"""
self.cleaned_true(key, value)
return 'OLD'
def convert_recent(self, key, value) -> str:
"""Messages that have the Recent flag set."""
self.cleaned_true(key, value)
return 'RECENT'
def convert_all(self, key, value) -> str:
"""All messages in the mailbox; the default initial key for ANDing."""
self.cleaned_true(key, value)
return 'ALL'
def convert_header(self, key, value) -> str:
"""
Messages that have a header with the specified field-name (as defined in [RFC-2822])
and that contains the specified string in the text of the header (what comes after the colon).
If the string to search is zero-length, this matches all messages that have a header line
with the specified field-name regardless of the contents.
"""
return f'HEADER {self.cleaned_header(key, value).name} {self.cleaned_header(key, value).value}'
def convert_uid(self, key, value) -> str:
"""Messages with unique identifiers corresponding to the specified unique identifier set."""
return f'UID {self.cleaned_uid(key, value)}'
def convert_gmail_label(self, key, value) -> str:
return f'X-GM-LABELS {quote(self.cleaned_str(key, value))}'
SEARCH_KEYS = tuple(i.replace('convert_', '') for i in dir(ParamConverter) if 'convert_' in i)
# Short alias set:
A = AND
O = OR # noqa
N = NOT
H = Header
U = UidRange
|