forked from O365/python-o365
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmessage.html
More file actions
922 lines (727 loc) · 48.2 KB
/
Copy pathmessage.html
File metadata and controls
922 lines (727 loc) · 48.2 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Message — O365 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Sharepoint" href="sharepoint.html" />
<link rel="prev" title="Mailbox" href="mailbox.html" />
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> O365
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Detailed Usage</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">O365 API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="account.html">Account</a></li>
<li class="toctree-l2"><a class="reference internal" href="address_book.html">Address Book</a></li>
<li class="toctree-l2"><a class="reference internal" href="attachment.html">Attachment</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar</a></li>
<li class="toctree-l2"><a class="reference internal" href="connection.html">Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="drive.html">One Drive</a></li>
<li class="toctree-l2"><a class="reference internal" href="mailbox.html">Mailbox</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Message</a></li>
<li class="toctree-l2"><a class="reference internal" href="sharepoint.html">Sharepoint</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">O365</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="../api.html">O365 API</a> »</li>
<li>Message</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/message.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
<a href="sharepoint.html" class="btn btn-neutral float-right" title="Sharepoint" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mailbox.html" class="btn btn-neutral" title="Mailbox" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-O365.message">
<span id="message"></span><h1>Message<a class="headerlink" href="#module-O365.message" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="O365.message.Flag">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">Flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Flag" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#O365.utils.utils.CaseEnum" title="O365.utils.utils.CaseEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.utils.CaseEnum</span></code></a></p>
<p>An enumeration.</p>
<dl class="py attribute">
<dt id="O365.message.Flag.Complete">
<code class="sig-name descname">Complete</code><em class="property"> = 'complete'</em><a class="headerlink" href="#O365.message.Flag.Complete" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.Flag.Flagged">
<code class="sig-name descname">Flagged</code><em class="property"> = 'flagged'</em><a class="headerlink" href="#O365.message.Flag.Flagged" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.Flag.NotFlagged">
<code class="sig-name descname">NotFlagged</code><em class="property"> = 'not_flagged'</em><a class="headerlink" href="#O365.message.Flag.NotFlagged" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="O365.message.MeetingMessageType">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">MeetingMessageType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MeetingMessageType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MeetingMessageType" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#O365.utils.utils.CaseEnum" title="O365.utils.utils.CaseEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.utils.CaseEnum</span></code></a></p>
<p>An enumeration.</p>
<dl class="py attribute">
<dt id="O365.message.MeetingMessageType.MeetingAccepted">
<code class="sig-name descname">MeetingAccepted</code><em class="property"> = 'meeting_accepted'</em><a class="headerlink" href="#O365.message.MeetingMessageType.MeetingAccepted" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.MeetingMessageType.MeetingCancelled">
<code class="sig-name descname">MeetingCancelled</code><em class="property"> = 'meeting_cancelled'</em><a class="headerlink" href="#O365.message.MeetingMessageType.MeetingCancelled" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.MeetingMessageType.MeetingDeclined">
<code class="sig-name descname">MeetingDeclined</code><em class="property"> = 'meeting_declined'</em><a class="headerlink" href="#O365.message.MeetingMessageType.MeetingDeclined" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.MeetingMessageType.MeetingRequest">
<code class="sig-name descname">MeetingRequest</code><em class="property"> = 'meeting_request'</em><a class="headerlink" href="#O365.message.MeetingMessageType.MeetingRequest" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.MeetingMessageType.MeetingTentativelyAccepted">
<code class="sig-name descname">MeetingTentativelyAccepted</code><em class="property"> = 'meeting_tentatively_accepted'</em><a class="headerlink" href="#O365.message.MeetingMessageType.MeetingTentativelyAccepted" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="O365.message.Message">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">Message</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">con</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.utils.ApiComponent</span></code></a>, <a class="reference internal" href="attachment.html#O365.utils.attachment.AttachableMixin" title="O365.utils.attachment.AttachableMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.attachment.AttachableMixin</span></code></a>, <a class="reference internal" href="utils.html#O365.utils.utils.HandleRecipientsMixin" title="O365.utils.utils.HandleRecipientsMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.utils.HandleRecipientsMixin</span></code></a></p>
<p>Management of the process of sending, receiving, reading, and
editing emails.</p>
<dl class="py method">
<dt id="O365.message.Message.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">con</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Makes a new message wrapper for sending and receiving messages.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="mailbox.html#O365.mailbox.Folder" title="O365.mailbox.Folder"><em>mailbox.Folder</em></a><em> or </em><a class="reference internal" href="account.html#O365.account.Account" title="O365.account.Account"><em>Account</em></a>) – parent folder/account to create the message in</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
<li><p><strong>download_attachments</strong> (<em>bool</em>) – whether or not to
download attachments (kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.add_category">
<code class="sig-name descname">add_category</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">category</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.add_category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.add_category" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a category to this message current categories list</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.attachments">
<em class="property">property </em><code class="sig-name descname">attachments</code><a class="headerlink" href="#O365.message.Message.attachments" title="Permalink to this definition">¶</a></dt>
<dd><p>List of attachments</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.bcc">
<em class="property">property </em><code class="sig-name descname">bcc</code><a class="headerlink" href="#O365.message.Message.bcc" title="Permalink to this definition">¶</a></dt>
<dd><p>‘BCC’ list of recipients</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.body">
<em class="property">property </em><code class="sig-name descname">body</code><a class="headerlink" href="#O365.message.Message.body" title="Permalink to this definition">¶</a></dt>
<dd><p>Body of the email message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Get body text of current message</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>set html body of the message</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.body_preview">
<em class="property">property </em><code class="sig-name descname">body_preview</code><a class="headerlink" href="#O365.message.Message.body_preview" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the body preview</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.categories">
<em class="property">property </em><code class="sig-name descname">categories</code><a class="headerlink" href="#O365.message.Message.categories" title="Permalink to this definition">¶</a></dt>
<dd><p>Categories of this message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Current list of categories</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Set new categories for the message</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>list[str] or str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.cc">
<em class="property">property </em><code class="sig-name descname">cc</code><a class="headerlink" href="#O365.message.Message.cc" title="Permalink to this definition">¶</a></dt>
<dd><p>‘CC’ list of recipients</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.copy">
<code class="sig-name descname">copy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">folder</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy the message to a given folder</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>folder</strong> (<em>str</em><em> or </em><a class="reference internal" href="mailbox.html#O365.mailbox.Folder" title="O365.mailbox.Folder"><em>mailbox.Folder</em></a>) – Folder object or Folder id or Well-known name to
copy this message to</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the copied message</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.message.Message" title="O365.message.Message">Message</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.created">
<em class="property">property </em><code class="sig-name descname">created</code><a class="headerlink" href="#O365.message.Message.created" title="Permalink to this definition">¶</a></dt>
<dd><p>Created time of the message</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a stored message</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.flag">
<em class="property">property </em><code class="sig-name descname">flag</code><a class="headerlink" href="#O365.message.Message.flag" title="Permalink to this definition">¶</a></dt>
<dd><p>The Message Flag instance</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.forward"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new message that is a forward this message</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>new message</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#O365.message.Message" title="O365.message.Message">Message</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.get_body_soup">
<code class="sig-name descname">get_body_soup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.get_body_soup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.get_body_soup" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the beautifulsoup4 of the html body</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>BeautifulSoup object of body</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>BeautifulSoup</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.get_body_text">
<code class="sig-name descname">get_body_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.get_body_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.get_body_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the body html and returns the body text using bs4</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>body as text</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.get_event">
<code class="sig-name descname">get_event</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.get_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.get_event" title="Permalink to this definition">¶</a></dt>
<dd><p>If this is a EventMessage it should return the related Event</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.get_mime_content">
<code class="sig-name descname">get_mime_content</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.get_mime_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.get_mime_content" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the MIME contents of this message</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.importance">
<em class="property">property </em><code class="sig-name descname">importance</code><a class="headerlink" href="#O365.message.Message.importance" title="Permalink to this definition">¶</a></dt>
<dd><p>Importance of the message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Get the current priority of the message</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Set a different importance level</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str or <a class="reference internal" href="utils.html#O365.utils.utils.ImportanceLevel" title="O365.utils.utils.ImportanceLevel">ImportanceLevel</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.is_delivery_receipt_requested">
<em class="property">property </em><code class="sig-name descname">is_delivery_receipt_requested</code><a class="headerlink" href="#O365.message.Message.is_delivery_receipt_requested" title="Permalink to this definition">¶</a></dt>
<dd><p>if the delivery receipt is requested for this message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Current state of isDeliveryReceiptRequested</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Set isDeliveryReceiptRequested for the message</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.is_draft">
<em class="property">property </em><code class="sig-name descname">is_draft</code><a class="headerlink" href="#O365.message.Message.is_draft" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the message is marked as draft</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.is_event_message">
<em class="property">property </em><code class="sig-name descname">is_event_message</code><a class="headerlink" href="#O365.message.Message.is_event_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns if this message is of type EventMessage
and therefore can return the related event.</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.is_read">
<em class="property">property </em><code class="sig-name descname">is_read</code><a class="headerlink" href="#O365.message.Message.is_read" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the message is read or not</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Get the status of message read</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Mark the message as read</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.is_read_receipt_requested">
<em class="property">property </em><code class="sig-name descname">is_read_receipt_requested</code><a class="headerlink" href="#O365.message.Message.is_read_receipt_requested" title="Permalink to this definition">¶</a></dt>
<dd><p>if the read receipt is requested for this message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Current state of isReadReceiptRequested</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Set isReadReceiptRequested for the message</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.mark_as_read">
<code class="sig-name descname">mark_as_read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.mark_as_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.mark_as_read" title="Permalink to this definition">¶</a></dt>
<dd><p>Marks this message as read in the cloud</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.mark_as_unread">
<code class="sig-name descname">mark_as_unread</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.mark_as_unread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.mark_as_unread" title="Permalink to this definition">¶</a></dt>
<dd><p>Marks this message as unread in the cloud</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.meeting_message_type">
<em class="property">property </em><code class="sig-name descname">meeting_message_type</code><a class="headerlink" href="#O365.message.Message.meeting_message_type" title="Permalink to this definition">¶</a></dt>
<dd><p>If this message is a EventMessage, returns the
meeting type: meetingRequest, meetingCancelled, meetingAccepted,</p>
<blockquote>
<div><p>meetingTentativelyAccepted, meetingDeclined</p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.modified">
<em class="property">property </em><code class="sig-name descname">modified</code><a class="headerlink" href="#O365.message.Message.modified" title="Permalink to this definition">¶</a></dt>
<dd><p>Message last modified time</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.move">
<code class="sig-name descname">move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">folder</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.move" title="Permalink to this definition">¶</a></dt>
<dd><p>Move the message to a given folder</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>folder</strong> (<em>str</em><em> or </em><a class="reference internal" href="mailbox.html#O365.mailbox.Folder" title="O365.mailbox.Folder"><em>mailbox.Folder</em></a>) – Folder object or Folder id or Well-known name to
move this message to</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.received">
<em class="property">property </em><code class="sig-name descname">received</code><a class="headerlink" href="#O365.message.Message.received" title="Permalink to this definition">¶</a></dt>
<dd><p>Message received time</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.reply">
<code class="sig-name descname">reply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">to_all</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.reply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.reply" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new message that is a reply to this message</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>to_all</strong> (<em>bool</em>) – whether or not to replies to all the recipients
instead to just the sender</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>new message</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.message.Message" title="O365.message.Message">Message</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.reply_to">
<em class="property">property </em><code class="sig-name descname">reply_to</code><a class="headerlink" href="#O365.message.Message.reply_to" title="Permalink to this definition">¶</a></dt>
<dd><p>Reply to address</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.save_as_eml">
<code class="sig-name descname">save_as_eml</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">to_path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.save_as_eml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.save_as_eml" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves this message as and EML to the file system
:param Path or str to_path: the path where to store this file</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.save_draft">
<code class="sig-name descname">save_draft</code><span class="sig-paren">(</span><em class="sig-param">target_folder=<OutlookWellKnowFolderNames.DRAFTS: 'Drafts'></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.save_draft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.save_draft" title="Permalink to this definition">¶</a></dt>
<dd><p>Save this message as a draft on the cloud</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>target_folder</strong> – name of the drafts folder</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.save_message">
<code class="sig-name descname">save_message</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.save_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.save_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves changes to a message.
If the message is a new or saved draft it will call ‘save_draft’ otherwise
this will save only properties of a message that are draft-independent such as:</p>
<blockquote>
<div><ul class="simple">
<li><p>is_read</p></li>
<li><p>category</p></li>
<li><p>flag</p></li>
</ul>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.send">
<code class="sig-name descname">send</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">save_to_sent_folder</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.send" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends this message</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>save_to_sent_folder</strong> (<em>bool</em>) – whether or not to save it to
sent folder</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.sender">
<em class="property">property </em><code class="sig-name descname">sender</code><a class="headerlink" href="#O365.message.Message.sender" title="Permalink to this definition">¶</a></dt>
<dd><p>Sender of the message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Get the current sender</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Update the from address with new value</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str or <a class="reference internal" href="utils.html#O365.utils.utils.Recipient" title="O365.utils.utils.Recipient">Recipient</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.sent">
<em class="property">property </em><code class="sig-name descname">sent</code><a class="headerlink" href="#O365.message.Message.sent" title="Permalink to this definition">¶</a></dt>
<dd><p>Message sent time</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.subject">
<em class="property">property </em><code class="sig-name descname">subject</code><a class="headerlink" href="#O365.message.Message.subject" title="Permalink to this definition">¶</a></dt>
<dd><p>Subject of the email message</p>
<dl class="field-list simple">
<dt class="field-odd">Getter</dt>
<dd class="field-odd"><p>Get the current subject</p>
</dd>
<dt class="field-even">Setter</dt>
<dd class="field-even"><p>Assign a new subject</p>
</dd>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.to">
<em class="property">property </em><code class="sig-name descname">to</code><a class="headerlink" href="#O365.message.Message.to" title="Permalink to this definition">¶</a></dt>
<dd><p>‘TO’ list of recipients</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.to_api_data">
<code class="sig-name descname">to_api_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">restrict_keys</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#Message.to_api_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.Message.to_api_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dict representation of this message prepared to be send
to the cloud</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>restrict_keys</strong> (<em>dict</em><em> or </em><em>set</em>) – a set of keys to restrict the returned
data to</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>converted to cloud based keys</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.Message.unique_body">
<em class="property">property </em><code class="sig-name descname">unique_body</code><a class="headerlink" href="#O365.message.Message.unique_body" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The unique body of this message</dt><dd><p>Requires a select to retrieve it.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="O365.message.MessageAttachment">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">MessageAttachment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attachment</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageAttachment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageAttachment" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="attachment.html#O365.utils.attachment.BaseAttachment" title="O365.utils.attachment.BaseAttachment"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.attachment.BaseAttachment</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="O365.message.MessageAttachments">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">MessageAttachments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span></em>, <em class="sig-param"><span class="n">attachments</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageAttachments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageAttachments" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="attachment.html#O365.utils.attachment.BaseAttachments" title="O365.utils.attachment.BaseAttachments"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.attachment.BaseAttachments</span></code></a></p>
<dl class="py method">
<dt id="O365.message.MessageAttachments.save_as_eml">
<code class="sig-name descname">save_as_eml</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attachment</span></em>, <em class="sig-param"><span class="n">to_path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageAttachments.save_as_eml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageAttachments.save_as_eml" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves this message as and EML to the file system
:param MessageAttachment attachment: the MessageAttachment to store as eml.
:param Path or str to_path: the path where to store this file</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="O365.message.MessageFlag">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">MessageFlag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span></em>, <em class="sig-param"><span class="n">flag_data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageFlag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageFlag" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">O365.utils.utils.ApiComponent</span></code></a></p>
<p>A flag on a message</p>
<dl class="py method">
<dt id="O365.message.MessageFlag.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span></em>, <em class="sig-param"><span class="n">flag_data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageFlag.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageFlag.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>An flag on a message
Not available on Outlook Rest Api v2 (only in beta)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="#O365.message.Message" title="O365.message.Message"><em>Message</em></a>) – parent of this</p></li>
<li><p><strong>flag_data</strong> (<em>dict</em>) – flag data from cloud</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.completition_date">
<em class="property">property </em><code class="sig-name descname">completition_date</code><a class="headerlink" href="#O365.message.MessageFlag.completition_date" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.delete_flag">
<code class="sig-name descname">delete_flag</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageFlag.delete_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageFlag.delete_flag" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets this message as un flagged</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.due_date">
<em class="property">property </em><code class="sig-name descname">due_date</code><a class="headerlink" href="#O365.message.MessageFlag.due_date" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.is_completed">
<em class="property">property </em><code class="sig-name descname">is_completed</code><a class="headerlink" href="#O365.message.MessageFlag.is_completed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.is_flagged">
<em class="property">property </em><code class="sig-name descname">is_flagged</code><a class="headerlink" href="#O365.message.MessageFlag.is_flagged" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.set_completed">
<code class="sig-name descname">set_completed</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">completition_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageFlag.set_completed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageFlag.set_completed" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets this message flag as completed
:param completition_date: the datetime this followUp was completed</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.set_flagged">
<code class="sig-name descname">set_flagged</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">start_date</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">due_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageFlag.set_flagged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageFlag.set_flagged" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets this message as flagged
:param start_date: the start datetime of the followUp
:param due_date: the due datetime of the followUp</p>
</dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.start_date">
<em class="property">property </em><code class="sig-name descname">start_date</code><a class="headerlink" href="#O365.message.MessageFlag.start_date" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.status">
<em class="property">property </em><code class="sig-name descname">status</code><a class="headerlink" href="#O365.message.MessageFlag.status" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="O365.message.MessageFlag.to_api_data">
<code class="sig-name descname">to_api_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#MessageFlag.to_api_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.MessageFlag.to_api_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns this data as a dict to be sent to the server</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="O365.message.RecipientType">
<em class="property">class </em><code class="sig-prename descclassname">O365.message.</code><code class="sig-name descname">RecipientType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/message.html#RecipientType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#O365.message.RecipientType" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>An enumeration.</p>
<dl class="py attribute">
<dt id="O365.message.RecipientType.BCC">
<code class="sig-name descname">BCC</code><em class="property"> = 'bcc'</em><a class="headerlink" href="#O365.message.RecipientType.BCC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.RecipientType.CC">
<code class="sig-name descname">CC</code><em class="property"> = 'cc'</em><a class="headerlink" href="#O365.message.RecipientType.CC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="O365.message.RecipientType.TO">
<code class="sig-name descname">TO</code><em class="property"> = 'to'</em><a class="headerlink" href="#O365.message.RecipientType.TO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="sharepoint.html" class="btn btn-neutral float-right" title="Sharepoint" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mailbox.html" class="btn btn-neutral" title="Mailbox" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Narcolapser
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>