-
Notifications
You must be signed in to change notification settings - Fork 294
/
client.go
1097 lines (978 loc) · 25.2 KB
/
client.go
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
// Package imapclient implements an IMAP client.
//
// # Charset decoding
//
// By default, only basic charset decoding is performed. For non-UTF-8 decoding
// of message subjects and e-mail address names, users can set
// Options.WordDecoder. For instance, to use go-message's collection of
// charsets:
//
// import (
// "mime"
//
// "github.com/emersion/go-message/charset"
// )
//
// options := &imapclient.Options{
// WordDecoder: &mime.WordDecoder{CharsetReader: charset.Reader},
// }
// client, err := imapclient.DialTLS("imap.example.org:993", options)
package imapclient
import (
"bufio"
"crypto/tls"
"fmt"
"io"
"mime"
"net"
"runtime/debug"
"strconv"
"sync"
"time"
"github.com/emersion/go-imap/v2"
"github.com/emersion/go-imap/v2/internal"
"github.com/emersion/go-imap/v2/internal/imapwire"
)
const (
idleReadTimeout = time.Duration(0)
respReadTimeout = 30 * time.Second
literalReadTimeout = 5 * time.Minute
cmdWriteTimeout = 30 * time.Second
literalWriteTimeout = 5 * time.Minute
)
// SelectedMailbox contains metadata for the currently selected mailbox.
type SelectedMailbox struct {
Name string
NumMessages uint32
Flags []imap.Flag
PermanentFlags []imap.Flag
}
func (mbox *SelectedMailbox) copy() *SelectedMailbox {
copy := *mbox
return ©
}
// Options contains options for Client.
type Options struct {
// Raw ingress and egress data will be written to this writer, if any.
// Note, this may include sensitive information such as credentials used
// during authentication.
DebugWriter io.Writer
// Unilateral data handler.
UnilateralDataHandler *UnilateralDataHandler
// Decoder for RFC 2047 words.
WordDecoder *mime.WordDecoder
}
func (options *Options) wrapReadWriter(rw io.ReadWriter) io.ReadWriter {
if options.DebugWriter == nil {
return rw
}
return struct {
io.Reader
io.Writer
}{
Reader: io.TeeReader(rw, options.DebugWriter),
Writer: io.MultiWriter(rw, options.DebugWriter),
}
}
func (options *Options) decodeText(s string) (string, error) {
wordDecoder := options.WordDecoder
if wordDecoder == nil {
wordDecoder = &mime.WordDecoder{}
}
out, err := wordDecoder.DecodeHeader(s)
if err != nil {
return s, err
}
return out, nil
}
func (options *Options) unilateralDataHandler() *UnilateralDataHandler {
if options.UnilateralDataHandler == nil {
return &UnilateralDataHandler{}
}
return options.UnilateralDataHandler
}
// Client is an IMAP client.
//
// IMAP commands are exposed as methods. These methods will block until the
// command has been sent to the server, but won't block until the server sends
// a response. They return a command struct which can be used to wait for the
// server response. This can be used to execute multiple commands concurrently,
// however care must be taken to avoid ambiguities. See RFC 9051 section 5.5.
//
// A client can be safely used from multiple goroutines, however this doesn't
// guarantee any command ordering and is subject to the same caveats as command
// pipelining (see above). Additionally, some commands (e.g. StartTLS,
// Authenticate, Idle) block the client during their execution.
type Client struct {
conn net.Conn
options Options
br *bufio.Reader
bw *bufio.Writer
dec *imapwire.Decoder
encMutex sync.Mutex
greetingCh chan struct{}
greetingRecv bool
greetingErr error
decCh chan struct{}
decErr error
mutex sync.Mutex
state imap.ConnState
caps imap.CapSet
pendingCapCh chan struct{}
mailbox *SelectedMailbox
cmdTag uint64
pendingCmds []command
contReqs []continuationRequest
closed bool
}
// New creates a new IMAP client.
//
// This function doesn't perform I/O.
//
// A nil options pointer is equivalent to a zero options value.
func New(conn net.Conn, options *Options) *Client {
if options == nil {
options = &Options{}
}
rw := options.wrapReadWriter(conn)
br := bufio.NewReader(rw)
bw := bufio.NewWriter(rw)
client := &Client{
conn: conn,
options: *options,
br: br,
bw: bw,
dec: imapwire.NewDecoder(br, imapwire.ConnSideClient),
greetingCh: make(chan struct{}),
decCh: make(chan struct{}),
state: imap.ConnStateNone,
}
go client.read()
return client
}
// DialTLS connects to an IMAP server with implicit TLS.
func DialTLS(address string, options *Options) (*Client, error) {
conn, err := tls.Dial("tcp", address, &tls.Config{
NextProtos: []string{"imap"},
})
if err != nil {
return nil, err
}
return New(conn, options), nil
}
// DialStartTLS connects to an IMAP server with STARTTLS.
func DialStartTLS(address string, options *Options) (*Client, error) {
host, _, err := net.SplitHostPort(address)
if err != nil {
return nil, err
}
conn, err := net.Dial("tcp", address)
if err != nil {
return nil, err
}
client := New(conn, options)
if err := client.StartTLS(&tls.Config{ServerName: host}); err != nil {
conn.Close()
return nil, err
}
// Per section 7.1.4, refuse PREAUTH when using STARTTLS
if client.State() != imap.ConnStateNotAuthenticated {
client.Close()
return nil, fmt.Errorf("imapclient: server sent PREAUTH on unencrypted connection")
}
return client, err
}
func (c *Client) setReadTimeout(dur time.Duration) {
if dur > 0 {
c.conn.SetReadDeadline(time.Now().Add(dur))
} else {
c.conn.SetReadDeadline(time.Time{})
}
}
func (c *Client) setWriteTimeout(dur time.Duration) {
if dur > 0 {
c.conn.SetWriteDeadline(time.Now().Add(dur))
} else {
c.conn.SetWriteDeadline(time.Time{})
}
}
// State returns the current connection state of the client.
func (c *Client) State() imap.ConnState {
c.mutex.Lock()
defer c.mutex.Unlock()
return c.state
}
func (c *Client) setState(state imap.ConnState) {
c.mutex.Lock()
c.state = state
if c.state != imap.ConnStateSelected {
c.mailbox = nil
}
c.mutex.Unlock()
}
// Caps returns the capabilities advertised by the server.
//
// When the server hasn't sent the capability list, this method will request it
// and block until it's received. If the capabilities cannot be fetched, nil is
// returned.
func (c *Client) Caps() imap.CapSet {
if err := c.WaitGreeting(); err != nil {
return nil
}
c.mutex.Lock()
caps := c.caps
capCh := c.pendingCapCh
c.mutex.Unlock()
if caps != nil {
return caps
}
if capCh == nil {
capCmd := c.Capability()
capCh := make(chan struct{})
go func() {
capCmd.Wait()
close(capCh)
}()
c.mutex.Lock()
c.pendingCapCh = capCh
c.mutex.Unlock()
}
<-capCh
// TODO: this is racy if caps are reset before we get the reply
c.mutex.Lock()
defer c.mutex.Unlock()
return c.caps
}
func (c *Client) setCaps(caps imap.CapSet) {
// If the capabilities are being reset, request the updated capabilities
// from the server
var capCh chan struct{}
if caps == nil {
capCh = make(chan struct{})
// We need to send the CAPABILITY command in a separate goroutine:
// setCaps might be called with Client.encMutex locked
go func() {
c.Capability().Wait()
close(capCh)
}()
}
c.mutex.Lock()
c.caps = caps
c.pendingCapCh = capCh
c.mutex.Unlock()
}
// Mailbox returns the state of the currently selected mailbox.
//
// If there is no currently selected mailbox, nil is returned.
//
// The returned struct must not be mutated.
func (c *Client) Mailbox() *SelectedMailbox {
c.mutex.Lock()
defer c.mutex.Unlock()
return c.mailbox
}
// Close immediately closes the connection.
func (c *Client) Close() error {
c.mutex.Lock()
alreadyClosed := c.closed
c.closed = true
c.mutex.Unlock()
// Ignore net.ErrClosed here, because we also call conn.Close in c.read
if err := c.conn.Close(); err != nil && err != net.ErrClosed {
return err
}
<-c.decCh
if err := c.decErr; err != nil {
return err
}
if alreadyClosed {
return net.ErrClosed
}
return nil
}
// beginCommand starts sending a command to the server.
//
// The command name and a space are written.
//
// The caller must call commandEncoder.end.
func (c *Client) beginCommand(name string, cmd command) *commandEncoder {
c.encMutex.Lock() // unlocked by commandEncoder.end
c.mutex.Lock()
c.cmdTag++
tag := fmt.Sprintf("T%v", c.cmdTag)
c.pendingCmds = append(c.pendingCmds, cmd)
quotedUTF8 := c.caps.Has(imap.CapIMAP4rev2)
literalMinus := c.caps.Has(imap.CapLiteralMinus)
literalPlus := c.caps.Has(imap.CapLiteralPlus)
c.mutex.Unlock()
c.setWriteTimeout(cmdWriteTimeout)
wireEnc := imapwire.NewEncoder(c.bw, imapwire.ConnSideClient)
wireEnc.QuotedUTF8 = quotedUTF8
wireEnc.LiteralMinus = literalMinus
wireEnc.LiteralPlus = literalPlus
wireEnc.NewContinuationRequest = func() *imapwire.ContinuationRequest {
return c.registerContReq(cmd)
}
baseCmd := cmd.base()
*baseCmd = Command{
tag: tag,
done: make(chan error, 1),
}
enc := &commandEncoder{
Encoder: wireEnc,
client: c,
cmd: baseCmd,
}
enc.Atom(tag).SP().Atom(name)
return enc
}
func (c *Client) deletePendingCmdByTag(tag string) command {
c.mutex.Lock()
defer c.mutex.Unlock()
for i, cmd := range c.pendingCmds {
if cmd.base().tag == tag {
c.pendingCmds = append(c.pendingCmds[:i], c.pendingCmds[i+1:]...)
return cmd
}
}
return nil
}
func (c *Client) findPendingCmdFunc(f func(cmd command) bool) command {
c.mutex.Lock()
defer c.mutex.Unlock()
for _, cmd := range c.pendingCmds {
if f(cmd) {
return cmd
}
}
return nil
}
func findPendingCmdByType[T command](c *Client) T {
c.mutex.Lock()
defer c.mutex.Unlock()
for _, cmd := range c.pendingCmds {
if cmd, ok := cmd.(T); ok {
return cmd
}
}
var cmd T
return cmd
}
func (c *Client) completeCommand(cmd command, err error) {
done := cmd.base().done
done <- err
close(done)
// Ensure the command is not blocked waiting on continuation requests
c.mutex.Lock()
var filtered []continuationRequest
for _, contReq := range c.contReqs {
if contReq.cmd != cmd.base() {
filtered = append(filtered, contReq)
} else {
contReq.Cancel(err)
}
}
c.contReqs = filtered
c.mutex.Unlock()
switch cmd := cmd.(type) {
case *authenticateCommand, *loginCommand:
if err == nil {
c.setState(imap.ConnStateAuthenticated)
}
case *unauthenticateCommand:
if err == nil {
c.setState(imap.ConnStateNotAuthenticated)
}
case *SelectCommand:
if err == nil {
c.mutex.Lock()
c.state = imap.ConnStateSelected
c.mailbox = &SelectedMailbox{
Name: cmd.mailbox,
NumMessages: cmd.data.NumMessages,
Flags: cmd.data.Flags,
PermanentFlags: cmd.data.PermanentFlags,
}
c.mutex.Unlock()
}
case *unselectCommand:
if err == nil {
c.setState(imap.ConnStateAuthenticated)
}
case *logoutCommand:
if err == nil {
c.setState(imap.ConnStateLogout)
}
case *ListCommand:
if cmd.pendingData != nil {
cmd.mailboxes <- cmd.pendingData
}
close(cmd.mailboxes)
case *FetchCommand:
close(cmd.msgs)
case *ExpungeCommand:
close(cmd.seqNums)
}
}
func (c *Client) registerContReq(cmd command) *imapwire.ContinuationRequest {
contReq := imapwire.NewContinuationRequest()
c.mutex.Lock()
c.contReqs = append(c.contReqs, continuationRequest{
ContinuationRequest: contReq,
cmd: cmd.base(),
})
c.mutex.Unlock()
return contReq
}
// read continuously reads data coming from the server.
//
// All the data is decoded in the read goroutine, then dispatched via channels
// to pending commands.
func (c *Client) read() {
defer close(c.decCh)
defer func() {
if v := recover(); v != nil {
c.decErr = fmt.Errorf("imapclient: panic reading response: %v\n%s", v, debug.Stack())
}
c.conn.Close()
c.mutex.Lock()
c.state = imap.ConnStateLogout
pendingCmds := c.pendingCmds
c.pendingCmds = nil
c.mutex.Unlock()
cmdErr := c.decErr
if cmdErr == nil {
cmdErr = io.ErrUnexpectedEOF
}
for _, cmd := range pendingCmds {
c.completeCommand(cmd, cmdErr)
}
}()
c.setReadTimeout(idleReadTimeout)
for {
if c.dec.EOF() {
break
}
if err := c.readResponse(); err != nil {
c.decErr = err
break
}
if c.greetingErr != nil {
break
}
}
}
func (c *Client) readResponse() error {
c.setReadTimeout(respReadTimeout)
defer c.setReadTimeout(idleReadTimeout)
if c.dec.Special('+') {
if err := c.readContinueReq(); err != nil {
return fmt.Errorf("in continue-req: %v", err)
}
return nil
}
var tag, typ string
if !c.dec.Expect(c.dec.Special('*') || c.dec.Atom(&tag), "'*' or atom") {
return fmt.Errorf("in response: cannot read tag: %v", c.dec.Err())
}
if !c.dec.ExpectSP() {
return fmt.Errorf("in response: %v", c.dec.Err())
}
if !c.dec.ExpectAtom(&typ) {
return fmt.Errorf("in response: cannot read type: %v", c.dec.Err())
}
var (
token string
err error
startTLS *startTLSCommand
)
if tag != "" {
token = "response-tagged"
startTLS, err = c.readResponseTagged(tag, typ)
} else {
token = "response-data"
err = c.readResponseData(typ)
}
if err != nil {
return fmt.Errorf("in %v: %v", token, err)
}
if !c.dec.ExpectCRLF() {
return fmt.Errorf("in response: %v", c.dec.Err())
}
if startTLS != nil {
c.upgradeStartTLS(startTLS.tlsConfig)
close(startTLS.upgradeDone)
}
return nil
}
func (c *Client) readContinueReq() error {
var text string
if c.dec.SP() {
c.dec.Text(&text)
}
if !c.dec.ExpectCRLF() {
return c.dec.Err()
}
var contReq *imapwire.ContinuationRequest
c.mutex.Lock()
if len(c.contReqs) > 0 {
contReq = c.contReqs[0].ContinuationRequest
c.contReqs = append(c.contReqs[:0], c.contReqs[1:]...)
}
c.mutex.Unlock()
if contReq == nil {
return fmt.Errorf("received unmatched continuation request")
}
contReq.Done(text)
return nil
}
func (c *Client) readResponseTagged(tag, typ string) (startTLS *startTLSCommand, err error) {
cmd := c.deletePendingCmdByTag(tag)
if cmd == nil {
return nil, fmt.Errorf("received tagged response with unknown tag %q", tag)
}
// We've removed the command from the pending queue above. Make sure we
// don't stall it on error.
defer func() {
if err != nil {
c.completeCommand(cmd, err)
}
}()
// Some servers don't provide a text even if the RFC requires it,
// see #500 and #502
hasSP := c.dec.SP()
var code string
if hasSP && c.dec.Special('[') { // resp-text-code
if !c.dec.ExpectAtom(&code) {
return nil, fmt.Errorf("in resp-text-code: %v", c.dec.Err())
}
// TODO: LONGENTRIES and MAXSIZE from METADATA
switch code {
case "CAPABILITY": // capability-data
caps, err := readCapabilities(c.dec)
if err != nil {
return nil, fmt.Errorf("in capability-data: %v", err)
}
c.setCaps(caps)
case "APPENDUID":
var uidValidity, uid uint32
if !c.dec.ExpectSP() || !c.dec.ExpectNumber(&uidValidity) || !c.dec.ExpectSP() || !c.dec.ExpectNumber(&uid) {
return nil, fmt.Errorf("in resp-code-apnd: %v", c.dec.Err())
}
if cmd, ok := cmd.(*AppendCommand); ok {
cmd.data.UID = uid
cmd.data.UIDValidity = uidValidity
}
case "COPYUID":
if !c.dec.ExpectSP() {
return nil, c.dec.Err()
}
uidValidity, srcUIDs, dstUIDs, err := readRespCodeCopy(c.dec)
if err != nil {
return nil, fmt.Errorf("in resp-code-copy: %v", err)
}
if cmd, ok := cmd.(*CopyCommand); ok {
cmd.data.UIDValidity = uidValidity
cmd.data.SourceUIDs = srcUIDs
cmd.data.DestUIDs = dstUIDs
}
default: // [SP 1*<any TEXT-CHAR except "]">]
if c.dec.SP() {
c.dec.DiscardUntilByte(']')
}
}
if !c.dec.ExpectSpecial(']') {
return nil, fmt.Errorf("in resp-text: %v", c.dec.Err())
}
hasSP = c.dec.SP()
}
var text string
if hasSP && !c.dec.ExpectText(&text) {
return nil, fmt.Errorf("in resp-text: %v", c.dec.Err())
}
var cmdErr error
switch typ {
case "OK":
// nothing to do
case "NO", "BAD":
cmdErr = &imap.Error{
Type: imap.StatusResponseType(typ),
Code: imap.ResponseCode(code),
Text: text,
}
default:
return nil, fmt.Errorf("in resp-cond-state: expected OK, NO or BAD status condition, but got %v", typ)
}
c.completeCommand(cmd, cmdErr)
if cmd, ok := cmd.(*startTLSCommand); ok && cmdErr == nil {
startTLS = cmd
}
if cmdErr == nil && code != "CAPABILITY" {
switch cmd.(type) {
case *startTLSCommand, *loginCommand, *authenticateCommand, *unauthenticateCommand:
// These commands invalidate the capabilities
c.setCaps(nil)
}
}
return startTLS, nil
}
func (c *Client) readResponseData(typ string) error {
// number SP ("EXISTS" / "RECENT" / "FETCH" / "EXPUNGE")
var num uint32
if typ[0] >= '0' && typ[0] <= '9' {
v, err := strconv.ParseUint(typ, 10, 32)
if err != nil {
return err
}
num = uint32(v)
if !c.dec.ExpectSP() || !c.dec.ExpectAtom(&typ) {
return c.dec.Err()
}
}
switch typ {
case "OK", "PREAUTH", "NO", "BAD", "BYE": // resp-cond-state / resp-cond-bye / resp-cond-auth
// Some servers don't provide a text even if the RFC requires it,
// see #500 and #502
hasSP := c.dec.SP()
var code string
if hasSP && c.dec.Special('[') { // resp-text-code
if !c.dec.ExpectAtom(&code) {
return fmt.Errorf("in resp-text-code: %v", c.dec.Err())
}
switch code {
case "CAPABILITY": // capability-data
caps, err := readCapabilities(c.dec)
if err != nil {
return fmt.Errorf("in capability-data: %v", err)
}
c.setCaps(caps)
case "PERMANENTFLAGS":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
flags, err := internal.ExpectFlagList(c.dec)
if err != nil {
return err
}
c.mutex.Lock()
if c.state == imap.ConnStateSelected {
c.mailbox = c.mailbox.copy()
c.mailbox.PermanentFlags = flags
}
c.mutex.Unlock()
if cmd := findPendingCmdByType[*SelectCommand](c); cmd != nil {
cmd.data.PermanentFlags = flags
} else if handler := c.options.unilateralDataHandler().Mailbox; handler != nil {
handler(&UnilateralDataMailbox{PermanentFlags: flags})
}
case "UIDNEXT":
var uidNext uint32
if !c.dec.ExpectSP() || !c.dec.ExpectNumber(&uidNext) {
return c.dec.Err()
}
if cmd := findPendingCmdByType[*SelectCommand](c); cmd != nil {
cmd.data.UIDNext = uidNext
}
case "UIDVALIDITY":
var uidValidity uint32
if !c.dec.ExpectSP() || !c.dec.ExpectNumber(&uidValidity) {
return c.dec.Err()
}
if cmd := findPendingCmdByType[*SelectCommand](c); cmd != nil {
cmd.data.UIDValidity = uidValidity
}
case "COPYUID":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
uidValidity, srcUIDs, dstUIDs, err := readRespCodeCopy(c.dec)
if err != nil {
return fmt.Errorf("in resp-code-copy: %v", err)
}
if cmd := findPendingCmdByType[*MoveCommand](c); cmd != nil {
cmd.data.UIDValidity = uidValidity
cmd.data.SourceUIDs = srcUIDs
cmd.data.DestUIDs = dstUIDs
}
case "HIGHESTMODSEQ":
var modSeq uint64
if !c.dec.ExpectSP() || !c.dec.ExpectModSeq(&modSeq) {
return c.dec.Err()
}
if cmd := findPendingCmdByType[*SelectCommand](c); cmd != nil {
cmd.data.HighestModSeq = modSeq
}
case "NOMODSEQ":
// ignore
default: // [SP 1*<any TEXT-CHAR except "]">]
if c.dec.SP() {
c.dec.DiscardUntilByte(']')
}
}
if !c.dec.ExpectSpecial(']') {
return fmt.Errorf("in resp-text: %v", c.dec.Err())
}
hasSP = c.dec.SP()
}
var text string
if hasSP && !c.dec.ExpectText(&text) {
return fmt.Errorf("in resp-text: %v", c.dec.Err())
}
if code == "CLOSED" {
c.setState(imap.ConnStateAuthenticated)
}
if !c.greetingRecv {
switch typ {
case "OK":
c.setState(imap.ConnStateNotAuthenticated)
case "PREAUTH":
c.setState(imap.ConnStateAuthenticated)
default:
c.setState(imap.ConnStateLogout)
c.greetingErr = &imap.Error{
Type: imap.StatusResponseType(typ),
Code: imap.ResponseCode(code),
Text: text,
}
}
c.greetingRecv = true
if c.greetingErr == nil && code != "CAPABILITY" {
c.setCaps(nil) // request initial capabilities
}
close(c.greetingCh)
}
case "CAPABILITY":
return c.handleCapability()
case "ENABLED":
return c.handleEnabled()
case "NAMESPACE":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleNamespace()
case "FLAGS":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleFlags()
case "EXISTS":
return c.handleExists(num)
case "RECENT":
// ignore
case "LIST":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleList()
case "STATUS":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleStatus()
case "FETCH":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleFetch(num)
case "EXPUNGE":
return c.handleExpunge(num)
case "SEARCH":
return c.handleSearch()
case "ESEARCH":
return c.handleESearch()
case "SORT":
return c.handleSort()
case "THREAD":
return c.handleThread()
case "METADATA":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleMetadata()
case "QUOTA":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleQuota()
case "QUOTAROOT":
if !c.dec.ExpectSP() {
return c.dec.Err()
}
return c.handleQuotaRoot()
default:
return fmt.Errorf("unsupported response type %q", typ)
}
return nil
}
// WaitGreeting waits for the server's initial greeting.
func (c *Client) WaitGreeting() error {
<-c.greetingCh
return c.greetingErr
}
// Noop sends a NOOP command.
func (c *Client) Noop() *Command {
cmd := &Command{}
c.beginCommand("NOOP", cmd).end()
return cmd
}
// Logout sends a LOGOUT command.
//
// This command informs the server that the client is done with the connection.
func (c *Client) Logout() *Command {
cmd := &logoutCommand{}
c.beginCommand("LOGOUT", cmd).end()
return &cmd.cmd
}
// Login sends a LOGIN command.
func (c *Client) Login(username, password string) *Command {
cmd := &loginCommand{}
enc := c.beginCommand("LOGIN", cmd)
enc.SP().String(username).SP().String(password)
enc.end()
return &cmd.cmd
}
// Delete sends a DELETE command.
func (c *Client) Delete(mailbox string) *Command {
cmd := &Command{}
enc := c.beginCommand("DELETE", cmd)
enc.SP().Mailbox(mailbox)
enc.end()
return cmd
}
// Rename sends a RENAME command.
func (c *Client) Rename(mailbox, newName string) *Command {
cmd := &Command{}
enc := c.beginCommand("RENAME", cmd)
enc.SP().Mailbox(mailbox).SP().Mailbox(newName)
enc.end()
return cmd
}
// Subscribe sends a SUBSCRIBE command.
func (c *Client) Subscribe(mailbox string) *Command {
cmd := &Command{}
enc := c.beginCommand("SUBSCRIBE", cmd)
enc.SP().Mailbox(mailbox)
enc.end()
return cmd
}
// Subscribe sends an UNSUBSCRIBE command.
func (c *Client) Unsubscribe(mailbox string) *Command {
cmd := &Command{}
enc := c.beginCommand("UNSUBSCRIBE", cmd)
enc.SP().Mailbox(mailbox)
enc.end()
return cmd
}
func uidCmdName(name string, uid bool) string {
if uid {
return "UID " + name
} else {
return name
}
}
type commandEncoder struct {
*imapwire.Encoder
client *Client
cmd *Command
}
// end ends an outgoing command.
//
// A CRLF is written, the encoder is flushed and its lock is released.
func (ce *commandEncoder) end() {
if ce.Encoder != nil {
ce.flush()
}
ce.client.setWriteTimeout(0)
ce.client.encMutex.Unlock()
}
// flush sends an outgoing command, but keeps the encoder lock.
//
// A CRLF is written and the encoder is flushed. Callers must call
// commandEncoder.end to release the lock.
func (ce *commandEncoder) flush() {
if err := ce.Encoder.CRLF(); err != nil {
ce.cmd.err = err