FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
Source.Python/addons/source-python/Python3/imaplib.py at master · durof/Source.Python · GitHub
durof
Source.Python
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
Source.Python
/
addons
/
source-python
/
Python3
/
imaplib.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
1606 lines (1211 loc) · 51.6 KB
Breadcrumbs
Source.Python
/
addons
/
source-python
/
Python3
/
imaplib.py
Copy path
File metadata and controls
1606 lines (1211 loc) · 51.6 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""IMAP4 client.
Based on RFC 2060.
Public class: IMAP4
Public variable: Debug
Public functions: Internaldate2tuple
Int2AP
ParseFlags
Time2Internaldate
"""
# Author: Piers Lauder <piers@cs.su.oz.au> December 1997.
#
# Authentication code contributed by Donn Cave <donn@u.washington.edu> June 1998.
# String method conversion by ESR, February 2001.
# GET/SETACL contributed by Anthony Baxter <anthony@interlink.com.au> April 2001.
# IMAP4_SSL contributed by Tino Lange <Tino.Lange@isg.de> March 2002.
# GET/SETQUOTA contributed by Andreas Zeidler <az@kreativkombinat.de> June 2002.
# PROXYAUTH contributed by Rick Holbert <holbert.13@osu.edu> November 2002.
# GET/SETANNOTATION contributed by Tomas Lindroos <skitta@abo.fi> June 2005.
__version__
=
"2.58"
import
binascii
,
errno
,
random
,
re
,
socket
,
subprocess
,
sys
,
time
,
calendar
from
datetime
import
datetime
,
timezone
,
timedelta
from
io
import
DEFAULT_BUFFER_SIZE
try
:
import
ssl
HAVE_SSL
=
True
except
ImportError
:
HAVE_SSL
=
False
__all__
=
[
"IMAP4"
,
"IMAP4_stream"
,
"Internaldate2tuple"
,
"Int2AP"
,
"ParseFlags"
,
"Time2Internaldate"
]
# Globals
CRLF
=
b'
\r
\n
'
Debug
=
0
IMAP4_PORT
=
143
IMAP4_SSL_PORT
=
993
AllowedVersions
=
(
'IMAP4REV1'
,
'IMAP4'
)
# Most recent first
# Maximal line length when calling readline(). This is to prevent
# reading arbitrary length lines. RFC 3501 and 2060 (IMAP 4rev1)
# don't specify a line length. RFC 2683 suggests limiting client
# command lines to 1000 octets and that servers should be prepared
# to accept command lines up to 8000 octets, so we used to use 10K here.
# In the modern world (eg: gmail) the response to, for example, a
# search command can be quite large, so we now use 1M.
_MAXLINE
=
1000000
# Commands
Commands
=
{
# name valid states
'APPEND'
: (
'AUTH'
,
'SELECTED'
),
'AUTHENTICATE'
: (
'NONAUTH'
,),
'CAPABILITY'
: (
'NONAUTH'
,
'AUTH'
,
'SELECTED'
,
'LOGOUT'
),
'CHECK'
: (
'SELECTED'
,),
'CLOSE'
: (
'SELECTED'
,),
'COPY'
: (
'SELECTED'
,),
'CREATE'
: (
'AUTH'
,
'SELECTED'
),
'DELETE'
: (
'AUTH'
,
'SELECTED'
),
'DELETEACL'
: (
'AUTH'
,
'SELECTED'
),
'ENABLE'
: (
'AUTH'
, ),
'EXAMINE'
: (
'AUTH'
,
'SELECTED'
),
'EXPUNGE'
: (
'SELECTED'
,),
'FETCH'
: (
'SELECTED'
,),
'GETACL'
: (
'AUTH'
,
'SELECTED'
),
'GETANNOTATION'
:(
'AUTH'
,
'SELECTED'
),
'GETQUOTA'
: (
'AUTH'
,
'SELECTED'
),
'GETQUOTAROOT'
: (
'AUTH'
,
'SELECTED'
),
'MYRIGHTS'
: (
'AUTH'
,
'SELECTED'
),
'LIST'
: (
'AUTH'
,
'SELECTED'
),
'LOGIN'
: (
'NONAUTH'
,),
'LOGOUT'
: (
'NONAUTH'
,
'AUTH'
,
'SELECTED'
,
'LOGOUT'
),
'LSUB'
: (
'AUTH'
,
'SELECTED'
),
'NAMESPACE'
: (
'AUTH'
,
'SELECTED'
),
'NOOP'
: (
'NONAUTH'
,
'AUTH'
,
'SELECTED'
,
'LOGOUT'
),
'PARTIAL'
: (
'SELECTED'
,),
# NB: obsolete
'PROXYAUTH'
: (
'AUTH'
,),
'RENAME'
: (
'AUTH'
,
'SELECTED'
),
'SEARCH'
: (
'SELECTED'
,),
'SELECT'
: (
'AUTH'
,
'SELECTED'
),
'SETACL'
: (
'AUTH'
,
'SELECTED'
),
'SETANNOTATION'
:(
'AUTH'
,
'SELECTED'
),
'SETQUOTA'
: (
'AUTH'
,
'SELECTED'
),
'SORT'
: (
'SELECTED'
,),
'STARTTLS'
: (
'NONAUTH'
,),
'STATUS'
: (
'AUTH'
,
'SELECTED'
),
'STORE'
: (
'SELECTED'
,),
'SUBSCRIBE'
: (
'AUTH'
,
'SELECTED'
),
'THREAD'
: (
'SELECTED'
,),
'UID'
: (
'SELECTED'
,),
'UNSUBSCRIBE'
: (
'AUTH'
,
'SELECTED'
),
}
# Patterns to match server responses
Continuation
=
re
.
compile
(
br'\+( (?P<data>.*))?'
)
Flags
=
re
.
compile
(
br'.*FLAGS \((?P<flags>[^\)]*)\)'
)
InternalDate
=
re
.
compile
(
br'.*INTERNALDATE "'
br'(?P<day>[ 0123][0-9])-(?P<mon>[A-Z][a-z][a-z])-(?P<year>[0-9][0-9][0-9][0-9])'
br' (?P<hour>[0-9][0-9]):(?P<min>[0-9][0-9]):(?P<sec>[0-9][0-9])'
br' (?P<zonen>[-+])(?P<zoneh>[0-9][0-9])(?P<zonem>[0-9][0-9])'
br'"'
)
# Literal is no longer used; kept for backward compatibility.
Literal
=
re
.
compile
(
br'.*{(?P<size>\d+)}$'
,
re
.
ASCII
)
MapCRLF
=
re
.
compile
(
br'\r\n|\r|\n'
)
# We no longer exclude the ']' character from the data portion of the response
# code, even though it violates the RFC. Popular IMAP servers such as Gmail
# allow flags with ']', and there are programs (including imaplib!) that can
# produce them. The problem with this is if the 'text' portion of the response
# includes a ']' we'll parse the response wrong (which is the point of the RFC
# restriction). However, that seems less likely to be a problem in practice
# than being unable to correctly parse flags that include ']' chars, which
# was reported as a real-world problem in issue #21815.
Response_code
=
re
.
compile
(
br'\[(?P<type>[A-Z-]+)( (?P<data>.*))?\]'
)
Untagged_response
=
re
.
compile
(
br'\* (?P<type>[A-Z-]+)( (?P<data>.*))?'
)
# Untagged_status is no longer used; kept for backward compatibility
Untagged_status
=
re
.
compile
(
br'\* (?P<data>\d+) (?P<type>[A-Z-]+)( (?P<data2>.*))?'
,
re
.
ASCII
)
# We compile these in _mode_xxx.
_Literal
=
br'.*{(?P<size>\d+)}$'
_Untagged_status
=
br'\* (?P<data>\d+) (?P<type>[A-Z-]+)( (?P<data2>.*))?'
class
IMAP4
:
r"""IMAP4 client class.
Instantiate with: IMAP4([host[, port]])
host - host's name (default: localhost);
port - port number (default: standard IMAP4 port).
All IMAP4rev1 commands are supported by methods of the same
name (in lower-case).
All arguments to commands are converted to strings, except for
AUTHENTICATE, and the last argument to APPEND which is passed as
an IMAP4 literal. If necessary (the string contains any
non-printing characters or white-space and isn't enclosed with
either parentheses or double quotes) each string is quoted.
However, the 'password' argument to the LOGIN command is always
quoted. If you want to avoid having an argument string quoted
(eg: the 'flags' argument to STORE) then enclose the string in
parentheses (eg: "(\Deleted)").
Each command returns a tuple: (type, [data, ...]) where 'type'
is usually 'OK' or 'NO', and 'data' is either the text from the
tagged response, or untagged results from command. Each 'data'
is either a string, or a tuple. If a tuple, then the first part
is the header of the response, and the second part contains
the data (ie: 'literal' value).
Errors raise the exception class <instance>.error("<reason>").
IMAP4 server errors raise <instance>.abort("<reason>"),
which is a sub-class of 'error'. Mailbox status changes
from READ-WRITE to READ-ONLY raise the exception class
<instance>.readonly("<reason>"), which is a sub-class of 'abort'.
"error" exceptions imply a program error.
"abort" exceptions imply the connection should be reset, and
the command re-tried.
"readonly" exceptions imply the command should be re-tried.
Note: to use this module, you must read the RFCs pertaining to the
IMAP4 protocol, as the semantics of the arguments to each IMAP4
command are left to the invoker, not to mention the results. Also,
most IMAP servers implement a sub-set of the commands available here.
"""
class
error
(
Exception
):
pass
# Logical errors - debug required
class
abort
(
error
):
pass
# Service errors - close and retry
class
readonly
(
abort
):
pass
# Mailbox status changed to READ-ONLY
def
__init__
(
self
,
host
=
''
,
port
=
IMAP4_PORT
):
self
.
debug
=
Debug
self
.
state
=
'LOGOUT'
self
.
literal
=
None
# A literal argument to a command
self
.
tagged_commands
=
{}
# Tagged commands awaiting response
self
.
untagged_responses
=
{}
# {typ: [data, ...], ...}
self
.
continuation_response
=
''
# Last continuation response
self
.
is_readonly
=
False
# READ-ONLY desired state
self
.
tagnum
=
0
self
.
_tls_established
=
False
self
.
_mode_ascii
()
# Open socket to server.
self
.
open
(
host
,
port
)
try
:
self
.
_connect
()
except
Exception
:
try
:
self
.
shutdown
()
except
OSError
:
pass
raise
def
_mode_ascii
(
self
):
self
.
utf8_enabled
=
False
self
.
_encoding
=
'ascii'
self
.
Literal
=
re
.
compile
(
_Literal
,
re
.
ASCII
)
self
.
Untagged_status
=
re
.
compile
(
_Untagged_status
,
re
.
ASCII
)
def
_mode_utf8
(
self
):
self
.
utf8_enabled
=
True
self
.
_encoding
=
'utf-8'
self
.
Literal
=
re
.
compile
(
_Literal
)
self
.
Untagged_status
=
re
.
compile
(
_Untagged_status
)
def
_connect
(
self
):
# Create unique tag for this session,
# and compile tagged response matcher.
self
.
tagpre
=
Int2AP
(
random
.
randint
(
4096
,
65535
))
self
.
tagre
=
re
.
compile
(
br'(?P<tag>'
+
self
.
tagpre
+
br'\d+) (?P<type>[A-Z]+) (?P<data>.*)'
,
re
.
ASCII
)
# Get server welcome message,
# request and store CAPABILITY response.
if
__debug__
:
self
.
_cmd_log_len
=
10
self
.
_cmd_log_idx
=
0
self
.
_cmd_log
=
{}
# Last `_cmd_log_len' interactions
if
self
.
debug
>=
1
:
self
.
_mesg
(
'imaplib version %s'
%
__version__
)
self
.
_mesg
(
'new IMAP4 connection, tag=%s'
%
self
.
tagpre
)
self
.
welcome
=
self
.
_get_response
()
if
'PREAUTH'
in
self
.
untagged_responses
:
self
.
state
=
'AUTH'
elif
'OK'
in
self
.
untagged_responses
:
self
.
state
=
'NONAUTH'
else
:
raise
self
.
error
(
self
.
welcome
)
self
.
_get_capabilities
()
if
__debug__
:
if
self
.
debug
>=
3
:
self
.
_mesg
(
'CAPABILITIES: %r'
%
(
self
.
capabilities
,))
for
version
in
AllowedVersions
:
if
not
version
in
self
.
capabilities
:
continue
self
.
PROTOCOL_VERSION
=
version
return
raise
self
.
error
(
'server not IMAP4 compliant'
)
def
__getattr__
(
self
,
attr
):
# Allow UPPERCASE variants of IMAP4 command methods.
if
attr
in
Commands
:
return
getattr
(
self
,
attr
.
lower
())
raise
AttributeError
(
"Unknown IMAP4 command: '%s'"
%
attr
)
def
__enter__
(
self
):
return
self
def
__exit__
(
self
,
*
args
):
try
:
self
.
logout
()
except
OSError
:
pass
# Overridable methods
def
_create_socket
(
self
):
return
socket
.
create_connection
((
self
.
host
,
self
.
port
))
def
open
(
self
,
host
=
''
,
port
=
IMAP4_PORT
):
"""Setup connection to remote server on "host:port"
(default: localhost:standard IMAP4 port).
This connection will be used by the routines:
read, readline, send, shutdown.
"""
self
.
host
=
host
self
.
port
=
port
self
.
sock
=
self
.
_create_socket
()
self
.
file
=
self
.
sock
.
makefile
(
'rb'
)
def
read
(
self
,
size
):
"""Read 'size' bytes from remote."""
return
self
.
file
.
read
(
size
)
def
readline
(
self
):
"""Read line from remote."""
line
=
self
.
file
.
readline
(
_MAXLINE
+
1
)
if
len
(
line
)
>
_MAXLINE
:
raise
self
.
error
(
"got more than %d bytes"
%
_MAXLINE
)
return
line
def
send
(
self
,
data
):
"""Send data to remote."""
self
.
sock
.
sendall
(
data
)
def
shutdown
(
self
):
"""Close I/O established in "open"."""
self
.
file
.
close
()
try
:
self
.
sock
.
shutdown
(
socket
.
SHUT_RDWR
)
except
OSError
as
e
:
# The server might already have closed the connection
if
e
.
errno
!=
errno
.
ENOTCONN
:
raise
finally
:
self
.
sock
.
close
()
def
socket
(
self
):
"""Return socket instance used to connect to IMAP4 server.
socket = <instance>.socket()
"""
return
self
.
sock
# Utility methods
def
recent
(
self
):
"""Return most recent 'RECENT' responses if any exist,
else prompt server for an update using the 'NOOP' command.
(typ, [data]) = <instance>.recent()
'data' is None if no new messages,
else list of RECENT responses, most recent last.
"""
name
=
'RECENT'
typ
,
dat
=
self
.
_untagged_response
(
'OK'
, [
None
],
name
)
if
dat
[
-
1
]:
return
typ
,
dat
typ
,
dat
=
self
.
noop
()
# Prod server for response
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
response
(
self
,
code
):
"""Return data for response 'code' if received, or None.
Old value for response 'code' is cleared.
(code, [data]) = <instance>.response(code)
"""
return
self
.
_untagged_response
(
code
, [
None
],
code
.
upper
())
# IMAP4 commands
def
append
(
self
,
mailbox
,
flags
,
date_time
,
message
):
"""Append message to named mailbox.
(typ, [data]) = <instance>.append(mailbox, flags, date_time, message)
All args except `message' can be None.
"""
name
=
'APPEND'
if
not
mailbox
:
mailbox
=
'INBOX'
if
flags
:
if
(
flags
[
0
],
flags
[
-
1
])
!=
(
'('
,
')'
):
flags
=
'(%s)'
%
flags
else
:
flags
=
None
if
date_time
:
date_time
=
Time2Internaldate
(
date_time
)
else
:
date_time
=
None
literal
=
MapCRLF
.
sub
(
CRLF
,
message
)
if
self
.
utf8_enabled
:
literal
=
b'UTF8 ('
+
literal
+
b')'
self
.
literal
=
literal
return
self
.
_simple_command
(
name
,
mailbox
,
flags
,
date_time
)
def
authenticate
(
self
,
mechanism
,
authobject
):
"""Authenticate command - requires response processing.
'mechanism' specifies which authentication mechanism is to
be used - it must appear in <instance>.capabilities in the
form AUTH=<mechanism>.
'authobject' must be a callable object:
data = authobject(response)
It will be called to process server continuation responses; the
response argument it is passed will be a bytes. It should return bytes
data that will be base64 encoded and sent to the server. It should
return None if the client abort response '*' should be sent instead.
"""
mech
=
mechanism
.
upper
()
# XXX: shouldn't this code be removed, not commented out?
#cap = 'AUTH=%s' % mech
#if not cap in self.capabilities: # Let the server decide!
# raise self.error("Server doesn't allow %s authentication." % mech)
self
.
literal
=
_Authenticator
(
authobject
).
process
typ
,
dat
=
self
.
_simple_command
(
'AUTHENTICATE'
,
mech
)
if
typ
!=
'OK'
:
raise
self
.
error
(
dat
[
-
1
].
decode
(
'utf-8'
,
'replace'
))
self
.
state
=
'AUTH'
return
typ
,
dat
def
capability
(
self
):
"""(typ, [data]) = <instance>.capability()
Fetch capabilities list from server."""
name
=
'CAPABILITY'
typ
,
dat
=
self
.
_simple_command
(
name
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
check
(
self
):
"""Checkpoint mailbox on server.
(typ, [data]) = <instance>.check()
"""
return
self
.
_simple_command
(
'CHECK'
)
def
close
(
self
):
"""Close currently selected mailbox.
Deleted messages are removed from writable mailbox.
This is the recommended command before 'LOGOUT'.
(typ, [data]) = <instance>.close()
"""
try
:
typ
,
dat
=
self
.
_simple_command
(
'CLOSE'
)
finally
:
self
.
state
=
'AUTH'
return
typ
,
dat
def
copy
(
self
,
message_set
,
new_mailbox
):
"""Copy 'message_set' messages onto end of 'new_mailbox'.
(typ, [data]) = <instance>.copy(message_set, new_mailbox)
"""
return
self
.
_simple_command
(
'COPY'
,
message_set
,
new_mailbox
)
def
create
(
self
,
mailbox
):
"""Create new mailbox.
(typ, [data]) = <instance>.create(mailbox)
"""
return
self
.
_simple_command
(
'CREATE'
,
mailbox
)
def
delete
(
self
,
mailbox
):
"""Delete old mailbox.
(typ, [data]) = <instance>.delete(mailbox)
"""
return
self
.
_simple_command
(
'DELETE'
,
mailbox
)
def
deleteacl
(
self
,
mailbox
,
who
):
"""Delete the ACLs (remove any rights) set for who on mailbox.
(typ, [data]) = <instance>.deleteacl(mailbox, who)
"""
return
self
.
_simple_command
(
'DELETEACL'
,
mailbox
,
who
)
def
enable
(
self
,
capability
):
"""Send an RFC5161 enable string to the server.
(typ, [data]) = <intance>.enable(capability)
"""
if
'ENABLE'
not
in
self
.
capabilities
:
raise
IMAP4
.
error
(
"Server does not support ENABLE"
)
typ
,
data
=
self
.
_simple_command
(
'ENABLE'
,
capability
)
if
typ
==
'OK'
and
'UTF8=ACCEPT'
in
capability
.
upper
():
self
.
_mode_utf8
()
return
typ
,
data
def
expunge
(
self
):
"""Permanently remove deleted items from selected mailbox.
Generates 'EXPUNGE' response for each deleted message.
(typ, [data]) = <instance>.expunge()
'data' is list of 'EXPUNGE'd message numbers in order received.
"""
name
=
'EXPUNGE'
typ
,
dat
=
self
.
_simple_command
(
name
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
fetch
(
self
,
message_set
,
message_parts
):
"""Fetch (parts of) messages.
(typ, [data, ...]) = <instance>.fetch(message_set, message_parts)
'message_parts' should be a string of selected parts
enclosed in parentheses, eg: "(UID BODY[TEXT])".
'data' are tuples of message part envelope and data.
"""
name
=
'FETCH'
typ
,
dat
=
self
.
_simple_command
(
name
,
message_set
,
message_parts
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
getacl
(
self
,
mailbox
):
"""Get the ACLs for a mailbox.
(typ, [data]) = <instance>.getacl(mailbox)
"""
typ
,
dat
=
self
.
_simple_command
(
'GETACL'
,
mailbox
)
return
self
.
_untagged_response
(
typ
,
dat
,
'ACL'
)
def
getannotation
(
self
,
mailbox
,
entry
,
attribute
):
"""(typ, [data]) = <instance>.getannotation(mailbox, entry, attribute)
Retrieve ANNOTATIONs."""
typ
,
dat
=
self
.
_simple_command
(
'GETANNOTATION'
,
mailbox
,
entry
,
attribute
)
return
self
.
_untagged_response
(
typ
,
dat
,
'ANNOTATION'
)
def
getquota
(
self
,
root
):
"""Get the quota root's resource usage and limits.
Part of the IMAP4 QUOTA extension defined in rfc2087.
(typ, [data]) = <instance>.getquota(root)
"""
typ
,
dat
=
self
.
_simple_command
(
'GETQUOTA'
,
root
)
return
self
.
_untagged_response
(
typ
,
dat
,
'QUOTA'
)
def
getquotaroot
(
self
,
mailbox
):
"""Get the list of quota roots for the named mailbox.
(typ, [[QUOTAROOT responses...], [QUOTA responses]]) = <instance>.getquotaroot(mailbox)
"""
typ
,
dat
=
self
.
_simple_command
(
'GETQUOTAROOT'
,
mailbox
)
typ
,
quota
=
self
.
_untagged_response
(
typ
,
dat
,
'QUOTA'
)
typ
,
quotaroot
=
self
.
_untagged_response
(
typ
,
dat
,
'QUOTAROOT'
)
return
typ
, [
quotaroot
,
quota
]
def
list
(
self
,
directory
=
'""'
,
pattern
=
'*'
):
"""List mailbox names in directory matching pattern.
(typ, [data]) = <instance>.list(directory='""', pattern='*')
'data' is list of LIST responses.
"""
name
=
'LIST'
typ
,
dat
=
self
.
_simple_command
(
name
,
directory
,
pattern
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
login
(
self
,
user
,
password
):
"""Identify client using plaintext password.
(typ, [data]) = <instance>.login(user, password)
NB: 'password' will be quoted.
"""
typ
,
dat
=
self
.
_simple_command
(
'LOGIN'
,
user
,
self
.
_quote
(
password
))
if
typ
!=
'OK'
:
raise
self
.
error
(
dat
[
-
1
])
self
.
state
=
'AUTH'
return
typ
,
dat
def
login_cram_md5
(
self
,
user
,
password
):
""" Force use of CRAM-MD5 authentication.
(typ, [data]) = <instance>.login_cram_md5(user, password)
"""
self
.
user
,
self
.
password
=
user
,
password
return
self
.
authenticate
(
'CRAM-MD5'
,
self
.
_CRAM_MD5_AUTH
)
def
_CRAM_MD5_AUTH
(
self
,
challenge
):
""" Authobject to use with CRAM-MD5 authentication. """
import
hmac
pwd
=
(
self
.
password
.
encode
(
'utf-8'
)
if
isinstance
(
self
.
password
,
str
)
else
self
.
password
)
return
self
.
user
+
" "
+
hmac
.
HMAC
(
pwd
,
challenge
,
'md5'
).
hexdigest
()
def
logout
(
self
):
"""Shutdown connection to server.
(typ, [data]) = <instance>.logout()
Returns server 'BYE' response.
"""
self
.
state
=
'LOGOUT'
try
:
typ
,
dat
=
self
.
_simple_command
(
'LOGOUT'
)
except
:
typ
,
dat
=
'NO'
, [
'%s: %s'
%
sys
.
exc_info
()[:
2
]]
self
.
shutdown
()
if
'BYE'
in
self
.
untagged_responses
:
return
'BYE'
,
self
.
untagged_responses
[
'BYE'
]
return
typ
,
dat
def
lsub
(
self
,
directory
=
'""'
,
pattern
=
'*'
):
"""List 'subscribed' mailbox names in directory matching pattern.
(typ, [data, ...]) = <instance>.lsub(directory='""', pattern='*')
'data' are tuples of message part envelope and data.
"""
name
=
'LSUB'
typ
,
dat
=
self
.
_simple_command
(
name
,
directory
,
pattern
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
myrights
(
self
,
mailbox
):
"""Show my ACLs for a mailbox (i.e. the rights that I have on mailbox).
(typ, [data]) = <instance>.myrights(mailbox)
"""
typ
,
dat
=
self
.
_simple_command
(
'MYRIGHTS'
,
mailbox
)
return
self
.
_untagged_response
(
typ
,
dat
,
'MYRIGHTS'
)
def
namespace
(
self
):
""" Returns IMAP namespaces ala rfc2342
(typ, [data, ...]) = <instance>.namespace()
"""
name
=
'NAMESPACE'
typ
,
dat
=
self
.
_simple_command
(
name
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
noop
(
self
):
"""Send NOOP command.
(typ, [data]) = <instance>.noop()
"""
if
__debug__
:
if
self
.
debug
>=
3
:
self
.
_dump_ur
(
self
.
untagged_responses
)
return
self
.
_simple_command
(
'NOOP'
)
def
partial
(
self
,
message_num
,
message_part
,
start
,
length
):
"""Fetch truncated part of a message.
(typ, [data, ...]) = <instance>.partial(message_num, message_part, start, length)
'data' is tuple of message part envelope and data.
"""
name
=
'PARTIAL'
typ
,
dat
=
self
.
_simple_command
(
name
,
message_num
,
message_part
,
start
,
length
)
return
self
.
_untagged_response
(
typ
,
dat
,
'FETCH'
)
def
proxyauth
(
self
,
user
):
"""Assume authentication as "user".
Allows an authorised administrator to proxy into any user's
mailbox.
(typ, [data]) = <instance>.proxyauth(user)
"""
name
=
'PROXYAUTH'
return
self
.
_simple_command
(
'PROXYAUTH'
,
user
)
def
rename
(
self
,
oldmailbox
,
newmailbox
):
"""Rename old mailbox name to new.
(typ, [data]) = <instance>.rename(oldmailbox, newmailbox)
"""
return
self
.
_simple_command
(
'RENAME'
,
oldmailbox
,
newmailbox
)
def
search
(
self
,
charset
,
*
criteria
):
"""Search mailbox for matching messages.
(typ, [data]) = <instance>.search(charset, criterion, ...)
'data' is space separated list of matching message numbers.
If UTF8 is enabled, charset MUST be None.
"""
name
=
'SEARCH'
if
charset
:
if
self
.
utf8_enabled
:
raise
IMAP4
.
error
(
"Non-None charset not valid in UTF8 mode"
)
typ
,
dat
=
self
.
_simple_command
(
name
,
'CHARSET'
,
charset
,
*
criteria
)
else
:
typ
,
dat
=
self
.
_simple_command
(
name
,
*
criteria
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
select
(
self
,
mailbox
=
'INBOX'
,
readonly
=
False
):
"""Select a mailbox.
Flush all untagged responses.
(typ, [data]) = <instance>.select(mailbox='INBOX', readonly=False)
'data' is count of messages in mailbox ('EXISTS' response).
Mandated responses are ('FLAGS', 'EXISTS', 'RECENT', 'UIDVALIDITY'), so
other responses should be obtained via <instance>.response('FLAGS') etc.
"""
self
.
untagged_responses
=
{}
# Flush old responses.
self
.
is_readonly
=
readonly
if
readonly
:
name
=
'EXAMINE'
else
:
name
=
'SELECT'
typ
,
dat
=
self
.
_simple_command
(
name
,
mailbox
)
if
typ
!=
'OK'
:
self
.
state
=
'AUTH'
# Might have been 'SELECTED'
return
typ
,
dat
self
.
state
=
'SELECTED'
if
'READ-ONLY'
in
self
.
untagged_responses
\
and
not
readonly
:
if
__debug__
:
if
self
.
debug
>=
1
:
self
.
_dump_ur
(
self
.
untagged_responses
)
raise
self
.
readonly
(
'%s is not writable'
%
mailbox
)
return
typ
,
self
.
untagged_responses
.
get
(
'EXISTS'
, [
None
])
def
setacl
(
self
,
mailbox
,
who
,
what
):
"""Set a mailbox acl.
(typ, [data]) = <instance>.setacl(mailbox, who, what)
"""
return
self
.
_simple_command
(
'SETACL'
,
mailbox
,
who
,
what
)
def
setannotation
(
self
,
*
args
):
"""(typ, [data]) = <instance>.setannotation(mailbox[, entry, attribute]+)
Set ANNOTATIONs."""
typ
,
dat
=
self
.
_simple_command
(
'SETANNOTATION'
,
*
args
)
return
self
.
_untagged_response
(
typ
,
dat
,
'ANNOTATION'
)
def
setquota
(
self
,
root
,
limits
):
"""Set the quota root's resource limits.
(typ, [data]) = <instance>.setquota(root, limits)
"""
typ
,
dat
=
self
.
_simple_command
(
'SETQUOTA'
,
root
,
limits
)
return
self
.
_untagged_response
(
typ
,
dat
,
'QUOTA'
)
def
sort
(
self
,
sort_criteria
,
charset
,
*
search_criteria
):
"""IMAP4rev1 extension SORT command.
(typ, [data]) = <instance>.sort(sort_criteria, charset, search_criteria, ...)
"""
name
=
'SORT'
#if not name in self.capabilities: # Let the server decide!
# raise self.error('unimplemented extension command: %s' % name)
if
(
sort_criteria
[
0
],
sort_criteria
[
-
1
])
!=
(
'('
,
')'
):
sort_criteria
=
'(%s)'
%
sort_criteria
typ
,
dat
=
self
.
_simple_command
(
name
,
sort_criteria
,
charset
,
*
search_criteria
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
starttls
(
self
,
ssl_context
=
None
):
name
=
'STARTTLS'
if
not
HAVE_SSL
:
raise
self
.
error
(
'SSL support missing'
)
if
self
.
_tls_established
:
raise
self
.
abort
(
'TLS session already established'
)
if
name
not
in
self
.
capabilities
:
raise
self
.
abort
(
'TLS not supported by server'
)
# Generate a default SSL context if none was passed.
if
ssl_context
is
None
:
ssl_context
=
ssl
.
_create_stdlib_context
()
typ
,
dat
=
self
.
_simple_command
(
name
)
if
typ
==
'OK'
:
self
.
sock
=
ssl_context
.
wrap_socket
(
self
.
sock
,
server_hostname
=
self
.
host
)
self
.
file
=
self
.
sock
.
makefile
(
'rb'
)
self
.
_tls_established
=
True
self
.
_get_capabilities
()
else
:
raise
self
.
error
(
"Couldn't establish TLS session"
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
status
(
self
,
mailbox
,
names
):
"""Request named status conditions for mailbox.
(typ, [data]) = <instance>.status(mailbox, names)
"""
name
=
'STATUS'
#if self.PROTOCOL_VERSION == 'IMAP4': # Let the server decide!
# raise self.error('%s unimplemented in IMAP4 (obtain IMAP4rev1 server, or re-code)' % name)
typ
,
dat
=
self
.
_simple_command
(
name
,
mailbox
,
names
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
store
(
self
,
message_set
,
command
,
flags
):
"""Alters flag dispositions for messages in mailbox.
(typ, [data]) = <instance>.store(message_set, command, flags)
"""
if
(
flags
[
0
],
flags
[
-
1
])
!=
(
'('
,
')'
):
flags
=
'(%s)'
%
flags
# Avoid quoting the flags
typ
,
dat
=
self
.
_simple_command
(
'STORE'
,
message_set
,
command
,
flags
)
return
self
.
_untagged_response
(
typ
,
dat
,
'FETCH'
)
def
subscribe
(
self
,
mailbox
):
"""Subscribe to new mailbox.
(typ, [data]) = <instance>.subscribe(mailbox)
"""
return
self
.
_simple_command
(
'SUBSCRIBE'
,
mailbox
)
def
thread
(
self
,
threading_algorithm
,
charset
,
*
search_criteria
):
"""IMAPrev1 extension THREAD command.
(type, [data]) = <instance>.thread(threading_algorithm, charset, search_criteria, ...)
"""
name
=
'THREAD'
typ
,
dat
=
self
.
_simple_command
(
name
,
threading_algorithm
,
charset
,
*
search_criteria
)
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
uid
(
self
,
command
,
*
args
):
"""Execute "command arg ..." with messages identified by UID,
rather than message number.
(typ, [data]) = <instance>.uid(command, arg1, arg2, ...)
Returns response appropriate to 'command'.
"""
command
=
command
.
upper
()
if
not
command
in
Commands
:
raise
self
.
error
(
"Unknown IMAP4 UID command: %s"
%
command
)
if
self
.
state
not
in
Commands
[
command
]:
raise
self
.
error
(
"command %s illegal in state %s, "
"only allowed in states %s"
%
(
command
,
self
.
state
,
', '
.
join
(
Commands
[
command
])))
name
=
'UID'
typ
,
dat
=
self
.
_simple_command
(
name
,
command
,
*
args
)
if
command
in
(
'SEARCH'
,
'SORT'
,
'THREAD'
):
name
=
command
else
:
name
=
'FETCH'
return
self
.
_untagged_response
(
typ
,
dat
,
name
)
def
unsubscribe
(
self
,
mailbox
):
"""Unsubscribe from old mailbox.
(typ, [data]) = <instance>.unsubscribe(mailbox)
"""
return
self
.
_simple_command
(
'UNSUBSCRIBE'
,
mailbox
)
def
xatom
(
self
,
name
,
*
args
):
"""Allow simple extension commands
notified by server in CAPABILITY response.
Assumes command is legal in current state.
(typ, [data]) = <instance>.xatom(name, arg, ...)
Returns response appropriate to extension command `name'.
"""
name
=
name
.
upper
()
#if not name in self.capabilities: # Let the server decide!
# raise self.error('unknown extension command: %s' % name)
if
not
name
in
Commands
:
Commands
[
name
]
=
(
self
.
state
,)
return
self
.
_simple_command
(
name
,
*
args
)
# Private methods
def
_append_untagged
(
self
,
typ
,
dat
):
if
dat
is
None
:
dat
=
b''
ur
=
self
.
untagged_responses
if
__debug__
:
if
self
.
debug
>=
5
:
self
.
_mesg
(
'untagged_responses[%s] %s += ["%r"]'
%
(
typ
,
len
(
ur
.
get
(
typ
,
''
)),
dat
))
if
typ
in
ur
:
ur
[
typ
].
append
(
dat
)
else
:
ur
[
typ
]
=
[
dat
]
def
_check_bye
(
self
):
bye
=
self
.
untagged_responses
.
get
(
'BYE'
)
if
bye
:
raise
self
.
abort
(
bye
[
-
1
].
decode
(
self
.
_encoding
,
'replace'
))
def
_command
(
self
,
name
,
*
args
):
if
self
.
state
not
in
Commands
[
name
]:
self
.
literal
=
None
raise
self
.
error
(
"command %s illegal in state %s, "
"only allowed in states %s"
%
(
name
,
self
.
state
,
', '
.
join
(
Commands
[
name
])))
for
typ
in
(
'OK'
,
'NO'
,
'BAD'
):
if
typ
in
self
.
untagged_responses
:
del
self
.
untagged_responses
[
typ
]
if
'READ-ONLY'
in
self
.
untagged_responses
\
and
not
self
.
is_readonly
:
raise
self
.
readonly
(
'mailbox status changed to READ-ONLY'
)
tag
=
self
.
_new_tag
()
name
=
bytes
(
name
,
self
.
_encoding
)
data
=
tag
+
b' '
+
name
for
arg
in
args
:
if
arg
is
None
:
continue
if
isinstance
(
arg
,
str
):
arg
=
bytes
(
arg
,
self
.
_encoding
)
data
=
data
+
b' '
+
arg
literal
=
self
.
literal
if
literal
is
not
None
:
self
.
literal
=
None
if
type
(
literal
)
is
type
(
self
.
_command
):
literator
=
literal
else
:
literator
=
None
data
=
data
+
bytes
(
' {%s}'
%
len
(
literal
),
self
.
_encoding
)
if
__debug__
:
if
self
.
debug
>=
4
:
self
.
_mesg
(
'> %r'
%
data
)
else
:
self
.
_log
(
'> %r'
%
data
)
try
:
self
.
send
(
data
+
CRLF
)
except
OSError
as
val
:
raise
self
.
abort
(
'socket error: %s'
%
val
)
if
literal
is
None
:
return
tag
while
1
:
# Wait for continuation response
while
self
.
_get_response
():
if
self
.
tagged_commands
[
tag
]:
# BAD/NO?
return
tag
# Send literal
if
literator
:
literal
=
literator
(
self
.
continuation_response
)
if
__debug__
:
if
self
.
debug
>=
4
:
self
.
_mesg
(
'write literal size %s'
%
len
(
literal
))
try
:
self
.
send
(
literal
)
self
.
send
(
CRLF
)
except
OSError
as
val
:
raise
self
.
abort
(
'socket error: %s'
%
val
)
if
not
literator
:
View remainder of file in raw view
Back
|
FazBrowse Home
|
New Git URL