-
Notifications
You must be signed in to change notification settings - Fork 0
/
ActiveUp.Net.Imap4.xml
2503 lines (2283 loc) · 103 KB
/
ActiveUp.Net.Imap4.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>ActiveUp.Net.Imap4</name>
</assembly>
<members>
<member name="T:ActiveUp.Net.Mail.Fetch">
<summary>
Allows to fetch (retrieve) partial or complete messages, as well as specific message informations.
</summary>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Body(System.Int32)">
<summary>
Returns a non-extensible form of the BodyStructure() method.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The server's response containing a parenthesized list.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
string body = inbox.Fetch.Body(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim body As String = inbox.Fetch.Body(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var body:string = inbox.Fetch.Body(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.BodySection(System.Int32,System.Int32)">
<summary>
Fetches a specific section of the message's body.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="section">The section (part number) to be fetched.</param>
<returns>The server's response.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
string body = inbox.Fetch.BodySection(1,3);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim body As String = inbox.Fetch.Body(1,3);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var body:string = inbox.Fetch.Body(1,3);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.BodyStructure(System.Int32)">
<summary>
Fetches the message's body structure.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The server's response containing a parenthesized list</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
string body = inbox.Fetch.BodyStructure(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim body As String = inbox.Fetch.BodyStructure(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var body:string = inbox.Fetch.BodyStructure(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.InternalDate(System.Int32)">
<summary>
Fetches the message's internal date.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's internal date.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
string internalDate = inbox.Fetch.InternalDate(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim internalDate As String = inbox.Fetch.InternalDate(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var internalDate:string = inbox.Fetch.InternalDate(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Flags(System.Int32)">
<summary>
Fetches the message's flags.
</summary>
<param name="messageOrdinal">The ordinal position of the message info to be fetched.</param>
<returns>A collection of flags.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
FlagCollection flags = inbox.Fetch.Flags(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim flags As FlagCollection = inbox.Fetch.Flags(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var flags:FlagCollection = inbox.Fetch.Flags(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Header(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant Header (parsable by the Parsing namespace classes).
</summary>
<param name="messageOrdinal">The ordinal position of the Header to be fetched.</param>
<returns>The message's Header as a byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderObject(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant header.
</summary>
<param name="messageOrdinal">The ordinal position of the Header to be fetched.</param>
<returns>The message's Header as a Header object.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
Header Header = inbox.Fetch.Header(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim Header As Header = inbox.Fetch.Header(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var header:Header = inbox.Fetch.Header(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderStream(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant Header (parsable by the Parsing namespace classes).
</summary>
<param name="messageOrdinal">The ordinal position of the Header to be fetched.</param>
<returns>The message's Header as a MemoryStream.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.HeaderObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderString(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant Header (parsable by the Parsing namespace classes).
</summary>
<param name="messageOrdinal">The ordinal position of the Header to be fetched.</param>
<returns>The message's Header as a string.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.HeaderObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderLinesPeek(System.Int32,System.String[])">
<summary>
Fetches the requested Header lines without setting the \Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="headerHeaders">An array of string representing the requested headers.</param>
<returns>A NameValueCollection where Names are the Header delimiters and Values are the Header bodies.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
//Request the message's subject and from header.
NameValueCollection lines = inbox.Fetch.HeaderLinesPeek(1,new string[] {"subject","from"});
//Extract the subject.
string messageSubject = lines["subject"];
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
'Request the message's subject and from header.
Dim lines As NameValueCollection = inbox.Fetch.HeaderLinesPeek(1,new string[] {"subject","from"})
'Extract the subject.
Dim messageSubject As String = lines("subject")
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
//Request the message's subject and from header.
var lines:NameValueCollection = inbox.Fetch.HeaderLinesPeek(1,new string[] {"subject","from"});
//Extract the subject.
var messageSubject:string = lines["subject"];
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderLinesNotPeek(System.Int32,System.String[])">
<summary>
Same as HeaderLines except that it will return all headers EXCEPT the specified ones, without setting the \Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="headerHeaders">An array of string representing the NOT-requested headers.</param>
<returns>A NameValueCollection where Names are the Header delimiters and Values are the Header bodies.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.HeaderLines(System.Int32,System.String[])"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderLines(System.Int32,System.String[])">
<summary>
Fetches the requested Header lines.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="headerHeaders">An array of string representing the requested headers.</param>
<returns>A NameValueCollection where Names are the Header delimiters and Values are the Header bodies.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
//Request the message's subject and from header.
NameValueCollection lines = inbox.Fetch.HeaderLines(1,new string[] {"subject","from"});
//Extract the subject.
string messageSubject = lines["subject"];
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
'Request the message's subject and from header.
Dim lines As NameValueCollection = inbox.Fetch.HeaderLines(1,new string[] {"subject","from"})
'Extract the subject.
Dim messageSubject As String = lines("subject")
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
//Request the message's subject and from header.
var lines:NameValueCollection = inbox.Fetch.HeaderLines(1,new string[] {"subject","from"});
//Extract the subject.
var messageSubject:string = lines["subject"];
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.HeaderLinesNot(System.Int32,System.String[])">
<summary>
Same as HeaderLines except that it will return all headers EXCEPT the specified ones.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="headerHeaders">An array of string representing the NOT-requested headers.</param>
<returns>A NameValueCollection where Names are the Header delimiters and Values are the Header bodies.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.HeaderLines(System.Int32,System.String[])"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Message(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant form.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a byte array.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageObject(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant form.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a Message object.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
Message message = inbox.Fetch.Message(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim message As Message = inbox.Fetch.Message(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var message:Message = inbox.Fetch.Message(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageObjectWithGMailExtensions(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant form and adds the GMail specific headers
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a Message object.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageObjectPeekWithGMailExtensions(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant form and adds the GMail specific headers without marking it as read
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a Message object.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageStream(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant form.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a MemoryStream.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageString(System.Int32)">
<summary>
Fetches the message's Rfc822 compliant form.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a string.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageRawString(System.Int32,System.Boolean,System.String[])">
<summary>
Fetches the raw reponse for a message fetch.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="markMessagesAsRead">Set to true to mark the retrieved messages as read</param>
<param name="extraDataItemToFetch">Extra fields to retrive besides rfc822</param>
<returns>The response data as a string.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessagePeek(System.Int32)">
<summary>
Same as Message() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a byte array.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageObjectPeek(System.Int32)">
<summary>
Same as MessageObject() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a Message object.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageObject(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageSreamPeek(System.Int32)">
<summary>
Same as MessageStream() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a MemoryStream.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageStream(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.MessageStringPeek(System.Int32)">
<summary>
Same as MessageString() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's data as a string.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.MessageString(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Size(System.Int32)">
<summary>
Fetches the specified message's size (in bytes).
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's size in bytes.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
int size = inbox.Fetch.Size(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim size As Integer = inbox.Fetch.Size(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var size:int = inbox.Fetch.Size(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Text(System.Int32)">
<summary>
Fetches the specified message's text (body).
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's text.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
string messageBody = inbox.Fetch.Text(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim messageBody As Header = inbox.Fetch.Text(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var messageBody:string = inbox.Fetch.Text(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.TextPeek(System.Int32)">
<summary>
Same as Text() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's text.</returns>
<example><see cref="M:ActiveUp.Net.Mail.Fetch.Text(System.Int32)"/></example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.Uid(System.Int32)">
<summary>
Fetches the specified message's Unique Identifier number.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<returns>The message's unique identifier number.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
Mailbox inbox = imap.SelectMailbox("inbox");
int uid = inbox.Fetch.Uid(1);
inbox.Close();
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
Dim inbox As Mailbox = imap.SelectMailbox("inbox")
Dim uid As Integer = inbox.Fetch.Uid(1);
inbox.Close()
imap.Disconnect()
JScript.NET
var imap:Imap4Client = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
var inbox:Mailbox = imap.SelectMailbox("inbox");
var uid:int = inbox.Fetch.Uid(1);
inbox.Close();
imap.Disconnect();
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialBodySection(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of BodySection().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="section">The message's body section to be retrieved.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialHeader(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of Header().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialMessage(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of Message().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialMessagePeek(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of MessagePeek().
Same as PartialMessage() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialText(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of Text().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialTextPeek(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of TextPeek().
Same as PartialText() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialBodySectionString(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of BodySectionString().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array converted to a string.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialHeaderString(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of HeaderString().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array converted to a string.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialMessageString(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of MessageString().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array converted to a string.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialMessageStringPeek(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of MessagePeekString().
Same as PartialMessageString() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array converted to a string.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialTextString(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of TextString().
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array converted to a string.</returns>
</member>
<member name="M:ActiveUp.Net.Mail.Fetch.PartialTextStringPeek(System.Int32,System.Int32,System.Int32)">
<summary>
Fetches [count] bytes starting at [index].
Partial version of TextPeekString().
Same as PartialTextString() except that it doesn't set the Seen flag.
</summary>
<param name="messageOrdinal">The ordinal position of the message to be fetched.</param>
<param name="index">The byte index to start retrieving from.</param>
<param name="count">The amount of bytes to be retrieved, starting at index.</param>
<returns>The requested byte array converted to a string.</returns>
</member>
<member name="P:ActiveUp.Net.Mail.Fetch.ParentMailbox">
<summary>
The Fetch's parent mailbox.
</summary>
</member>
<member name="T:ActiveUp.Net.Mail.Flag">
<summary>
Represents a flag.
</summary>
</member>
<member name="M:ActiveUp.Net.Mail.Flag.ToString">
<summary>
The name of the flag.
</summary>
<returns>The name of the flag.</returns>
</member>
<member name="P:ActiveUp.Net.Mail.Flag.Name">
<summary>
The flags's name.
</summary>
</member>
<member name="T:ActiveUp.Net.Mail.FlagCollection">
<summary>
Represents a collection of Flags.
</summary>
</member>
<member name="M:ActiveUp.Net.Mail.FlagCollection.Add(ActiveUp.Net.Mail.IFlag)">
<summary>
Adds the provided flag to the collection.
</summary>
<param name="flag"></param>
</member>
<member name="M:ActiveUp.Net.Mail.FlagCollection.Add(System.String)">
<summary>
Adds a new flag to the collection with the specified name.
</summary>
<param name="flagName"></param>
</member>
<member name="P:ActiveUp.Net.Mail.FlagCollection.Item(System.Int32)">
<summary>
Retrieves the flag at index [index] in the collection.
</summary>
</member>
<member name="P:ActiveUp.Net.Mail.FlagCollection.Item(System.String)">
<summary>
Retrieves the flag with the specified name in the collection.
</summary>
</member>
<member name="P:ActiveUp.Net.Mail.FlagCollection.Merged">
<summary>
A string representing the collection (in IMAP4rev1 compatible format).
</summary>
</member>
<member name="T:ActiveUp.Net.Mail.Imap4Client">
<summary>
This class allows communication with an IMAP4 or IMAP4rev1 compatible server.
</summary>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.renderSafeParam(System.String)">
<summary>
Takes a command parameter and makes it safe for IMAP
</summary>
<param name="commandParam"></param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.Connect(System.String)">
<summary>
Connects to the server.
</summary>
<param name="host">Server address.</param>
<returns>The server's response greeting.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
...
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
...
JScript.NET
var imap:Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
...
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.BeginConnect(System.String,System.AsyncCallback)">
<summary>
Begins the connect.
</summary>
<param name="host">The host.</param>
<param name="callback">The callback.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.Connect(System.String,System.Int32)">
<summary>
Connects to the server.
</summary>
<param name="host">Server address.</param>
<param name="port">Server port.</param>
<returns>The server's response greeting.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com",8505);
...
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com",8505)
...
JScript.NET
var imap:Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com",8505);
...
</code>
</example>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.BeginConnect(System.String,System.Int32,System.AsyncCallback)">
<summary>
Begins the connect.
</summary>
<param name="host">The host.</param>
<param name="port">The port.</param>
<param name="callback">The callback.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.Connect(System.Net.IPAddress,System.Int32)">
<summary>
Connects the specified addr.
</summary>
<param name="addr">The addr.</param>
<param name="port">The port.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.BeginConnect(System.Net.IPAddress,System.Int32,System.AsyncCallback)">
<summary>
Begins the connect.
</summary>
<param name="addr">The addr.</param>
<param name="port">The port.</param>
<param name="callback">The callback.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.Connect(System.Net.IPAddress[],System.Int32)">
<summary>
Connects the specified addresses.
</summary>
<param name="addresses">The addresses.</param>
<param name="port">The port.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.BeginConnect(System.String,System.String,System.String,System.AsyncCallback)">
<summary>
Begins the connect.
</summary>
<param name="host">The host.</param>
<param name="username">The username.</param>
<param name="password">The password.</param>
<param name="callback">The callback.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.Connect(System.String,System.Int32,System.String,System.String)">
<summary>
Connects the specified host.
</summary>
<param name="host">The host.</param>
<param name="port">The port.</param>
<param name="username">The username.</param>
<param name="password">The password.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.BeginConnect(System.String,System.Int32,System.String,System.String,System.AsyncCallback)">
<summary>
Begins the connect.
</summary>
<param name="host">The host.</param>
<param name="port">The port.</param>
<param name="username">The username.</param>
<param name="password">The password.</param>
<param name="callback">The callback.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.EndConnect(System.IAsyncResult)">
<summary>
Ends the connect.
</summary>
<param name="result">The result.</param>
<returns></returns>
</member>
<member name="M:ActiveUp.Net.Mail.Imap4Client.Disconnect">
<summary>
Logs out and closes the connection with the server.
</summary>
<returns>The server's googbye greeting.</returns>
<example>
<code>
C#
Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
//Do some work...
imap.Disconnect();
VB.NET
Dim imap As New Imap4Client
imap.Connect("mail.myhost.com")
imap.Login("jdoe1234","tanstaaf")
'Do some work...
imap.Disconnect()
JScript.NET
var imap:Imap4Client imap = new Imap4Client();
imap.Connect("mail.myhost.com");
imap.Login("jdoe1234","tanstaaf");
//Do some work...
imap.Disconnect();
</code>
</example>
</member>