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
|
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>exchangelib.items.message API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>exchangelib.items.message</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="exchangelib.items.message.ForwardItem"><code class="flex name class">
<span>class <span class="ident">ForwardItem</span></span>
<span>(</span><span>**kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ForwardItem(BaseReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/forwarditem"""
ELEMENT_NAME = "ForwardItem"</code></pre>
</details>
<div class="desc"><p>MSDN: <a href="https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/forwarditem">https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/forwarditem</a></p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.items.base.BaseReplyItem" href="base.html#exchangelib.items.base.BaseReplyItem">BaseReplyItem</a></li>
<li><a title="exchangelib.properties.EWSElement" href="../properties.html#exchangelib.properties.EWSElement">EWSElement</a></li>
</ul>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.items.base.BaseReplyItem" href="base.html#exchangelib.items.base.BaseReplyItem">BaseReplyItem</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.items.base.BaseReplyItem.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.author" href="base.html#exchangelib.items.base.BaseReplyItem.author">author</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.bcc_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.bcc_recipients">bcc_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.body" href="base.html#exchangelib.items.base.BaseReplyItem.body">body</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.cc_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.cc_recipients">cc_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.is_delivery_receipt_requested" href="base.html#exchangelib.items.base.BaseReplyItem.is_delivery_receipt_requested">is_delivery_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.is_read_receipt_requested" href="base.html#exchangelib.items.base.BaseReplyItem.is_read_receipt_requested">is_read_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.new_body" href="base.html#exchangelib.items.base.BaseReplyItem.new_body">new_body</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.received_by" href="base.html#exchangelib.items.base.BaseReplyItem.received_by">received_by</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.received_representing" href="base.html#exchangelib.items.base.BaseReplyItem.received_representing">received_representing</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.reference_item_id" href="base.html#exchangelib.items.base.BaseReplyItem.reference_item_id">reference_item_id</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.save" href="base.html#exchangelib.items.base.BaseReplyItem.save">save</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.subject" href="base.html#exchangelib.items.base.BaseReplyItem.subject">subject</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.to_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.to_recipients">to_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="exchangelib.items.message.Message"><code class="flex name class">
<span>class <span class="ident">Message</span></span>
<span>(</span><span>**kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Message(Item):
"""MSDN:
https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/message-ex15websvcsotherref
"""
ELEMENT_NAME = "Message"
sender = MailboxField(field_uri="message:Sender", is_read_only=True, is_read_only_after_send=True)
to_recipients = MailboxListField(
field_uri="message:ToRecipients", is_read_only_after_send=True, is_searchable=False
)
cc_recipients = MailboxListField(
field_uri="message:CcRecipients", is_read_only_after_send=True, is_searchable=False
)
bcc_recipients = MailboxListField(
field_uri="message:BccRecipients", is_read_only_after_send=True, is_searchable=False
)
is_read_receipt_requested = BooleanField(
field_uri="message:IsReadReceiptRequested", is_required=True, default=False, is_read_only_after_send=True
)
is_delivery_receipt_requested = BooleanField(
field_uri="message:IsDeliveryReceiptRequested", is_required=True, default=False, is_read_only_after_send=True
)
conversation_index = Base64Field(field_uri="message:ConversationIndex", is_read_only=True)
conversation_topic = CharField(field_uri="message:ConversationTopic", is_read_only=True)
# Rename 'From' to 'author'. We can't use field name 'from' since it's a Python keyword.
author = MailboxField(field_uri="message:From", is_read_only_after_send=True)
message_id = TextField(field_uri="message:InternetMessageId", is_read_only_after_send=True)
is_read = BooleanField(field_uri="message:IsRead", is_required=True, default=False)
is_response_requested = BooleanField(field_uri="message:IsResponseRequested", default=False, is_required=True)
references = TextField(field_uri="message:References")
reply_to = MailboxListField(field_uri="message:ReplyTo", is_read_only_after_send=True, is_searchable=False)
received_by = MailboxField(field_uri="message:ReceivedBy", is_read_only=True)
received_representing = MailboxField(field_uri="message:ReceivedRepresenting", is_read_only=True)
reminder_message_data = EWSElementField(
field_uri="message:ReminderMessageData",
value_cls=ReminderMessageData,
supported_from=EXCHANGE_2013_SP1,
is_read_only=True,
)
@require_account
def send(
self,
save_copy=True,
copy_to_folder=None,
conflict_resolution=AUTO_RESOLVE,
send_meeting_invitations=SEND_TO_NONE,
):
from ..services import SendItem
# Only sends a message. The message can either be an existing draft stored in EWS or a new message that does
# not yet exist in EWS.
if copy_to_folder and not save_copy:
raise AttributeError("'save_copy' must be True when 'copy_to_folder' is set")
if save_copy and not copy_to_folder:
copy_to_folder = self.account.sent # 'Sent' is default EWS behaviour
if self.id:
SendItem(account=self.account).get(items=[self], saved_item_folder=copy_to_folder)
# The item will be deleted from the original folder
self._id = None
self.folder = copy_to_folder
return None
# New message
if copy_to_folder:
# This would better be done via send_and_save() but let's just support it here
self.folder = copy_to_folder
return self.send_and_save(
conflict_resolution=conflict_resolution, send_meeting_invitations=send_meeting_invitations
)
if self.account.version.build < EXCHANGE_2013 and self.attachments:
# At least some versions prior to Exchange 2013 can't send attachments immediately. You need to first save,
# then attach, then send. This is done in send_and_save(). send() will delete the item again.
self.send_and_save(
conflict_resolution=conflict_resolution, send_meeting_invitations=send_meeting_invitations
)
return None
self._create(message_disposition=SEND_ONLY, send_meeting_invitations=send_meeting_invitations)
return None
def send_and_save(
self, update_fields=None, conflict_resolution=AUTO_RESOLVE, send_meeting_invitations=SEND_TO_NONE
):
# Sends Message and saves a copy in the parent folder. Does not return an ItemId.
if self.id:
return self._update(
update_fieldnames=update_fields,
message_disposition=SEND_AND_SAVE_COPY,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
if self.account.version.build < EXCHANGE_2013 and self.attachments:
# At least some versions prior to Exchange 2013 can't send-and-save attachments immediately. You need
# to first save, then attach, then send. This is done in save().
self.save(
update_fields=update_fields,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
return self.send(
save_copy=False,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
return self._create(message_disposition=SEND_AND_SAVE_COPY, send_meeting_invitations=send_meeting_invitations)
@require_id
def create_reply(self, subject, body, to_recipients=None, cc_recipients=None, bcc_recipients=None, author=None):
if not to_recipients:
if not self.author:
raise ValueError("'to_recipients' must be set when message has no 'author'")
to_recipients = [self.author]
return ReplyToItem(
account=self.account,
reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey),
subject=subject,
new_body=body,
to_recipients=to_recipients,
cc_recipients=cc_recipients,
bcc_recipients=bcc_recipients,
author=author,
)
def reply(self, subject, body, to_recipients=None, cc_recipients=None, bcc_recipients=None, author=None):
return self.create_reply(subject, body, to_recipients, cc_recipients, bcc_recipients, author).send()
@require_id
def create_reply_all(self, subject, body, author=None):
me = MailboxField().clean(self.account.primary_smtp_address.lower())
to_recipients = set(self.to_recipients or [])
to_recipients.discard(me)
cc_recipients = set(self.cc_recipients or [])
cc_recipients.discard(me)
bcc_recipients = set(self.bcc_recipients or [])
bcc_recipients.discard(me)
if self.author:
to_recipients.add(self.author)
return ReplyAllToItem(
account=self.account,
reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey),
subject=subject,
new_body=body,
to_recipients=list(to_recipients),
cc_recipients=list(cc_recipients),
bcc_recipients=list(bcc_recipients),
author=author,
)
def reply_all(self, subject, body, author=None):
return self.create_reply_all(subject, body, author).send()
def mark_as_junk(self, is_junk=True, move_item=True):
"""Mark or un-marks items as junk email.
:param is_junk: If True, the sender will be added from the blocked sender list. Otherwise, the sender will be
removed.
:param move_item: If true, the item will be moved to the junk folder.
:return:
"""
from ..services import MarkAsJunk
res = MarkAsJunk(account=self.account).get(
items=[self], is_junk=is_junk, move_item=move_item, expect_result=None
)
if res is None:
return
self.folder = self.account.junk if is_junk else self.account.inbox
self.id, self.changekey = res</code></pre>
</details>
<div class="desc"><p>MSDN:
<a href="https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/message-ex15websvcsotherref">https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/message-ex15websvcsotherref</a></p>
<p>Pick out optional 'account' and 'folder' kwargs, and pass the rest to the parent class.</p>
<p>:param kwargs:
'account' is optional but allows calling 'send()' and 'delete()'
'folder' is optional but allows calling 'save()'. If 'folder' has an account, and 'account' is not set,
we use folder.account.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.items.item.Item" href="item.html#exchangelib.items.item.Item">Item</a></li>
<li><a title="exchangelib.items.base.BaseItem" href="base.html#exchangelib.items.base.BaseItem">BaseItem</a></li>
<li><a title="exchangelib.items.base.RegisterMixIn" href="base.html#exchangelib.items.base.RegisterMixIn">RegisterMixIn</a></li>
<li><a title="exchangelib.properties.IdChangeKeyMixIn" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn">IdChangeKeyMixIn</a></li>
<li><a title="exchangelib.properties.EWSElement" href="../properties.html#exchangelib.properties.EWSElement">EWSElement</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.items.message.Message.author"><code class="name">var <span class="ident">author</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.bcc_recipients"><code class="name">var <span class="ident">bcc_recipients</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.cc_recipients"><code class="name">var <span class="ident">cc_recipients</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.conversation_index"><code class="name">var <span class="ident">conversation_index</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.conversation_topic"><code class="name">var <span class="ident">conversation_topic</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.is_delivery_receipt_requested"><code class="name">var <span class="ident">is_delivery_receipt_requested</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.is_read"><code class="name">var <span class="ident">is_read</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.is_read_receipt_requested"><code class="name">var <span class="ident">is_read_receipt_requested</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.is_response_requested"><code class="name">var <span class="ident">is_response_requested</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.message_id"><code class="name">var <span class="ident">message_id</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.received_by"><code class="name">var <span class="ident">received_by</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.received_representing"><code class="name">var <span class="ident">received_representing</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.references"><code class="name">var <span class="ident">references</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.reminder_message_data"><code class="name">var <span class="ident">reminder_message_data</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.reply_to"><code class="name">var <span class="ident">reply_to</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.sender"><code class="name">var <span class="ident">sender</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.message.Message.to_recipients"><code class="name">var <span class="ident">to_recipients</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="exchangelib.items.message.Message.create_reply"><code class="name flex">
<span>def <span class="ident">create_reply</span></span>(<span>self,<br>subject,<br>body,<br>to_recipients=None,<br>cc_recipients=None,<br>bcc_recipients=None,<br>author=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def create_reply(self, subject, body, to_recipients=None, cc_recipients=None, bcc_recipients=None, author=None):
if not to_recipients:
if not self.author:
raise ValueError("'to_recipients' must be set when message has no 'author'")
to_recipients = [self.author]
return ReplyToItem(
account=self.account,
reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey),
subject=subject,
new_body=body,
to_recipients=to_recipients,
cc_recipients=cc_recipients,
bcc_recipients=bcc_recipients,
author=author,
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.message.Message.create_reply_all"><code class="name flex">
<span>def <span class="ident">create_reply_all</span></span>(<span>self, subject, body, author=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def create_reply_all(self, subject, body, author=None):
me = MailboxField().clean(self.account.primary_smtp_address.lower())
to_recipients = set(self.to_recipients or [])
to_recipients.discard(me)
cc_recipients = set(self.cc_recipients or [])
cc_recipients.discard(me)
bcc_recipients = set(self.bcc_recipients or [])
bcc_recipients.discard(me)
if self.author:
to_recipients.add(self.author)
return ReplyAllToItem(
account=self.account,
reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey),
subject=subject,
new_body=body,
to_recipients=list(to_recipients),
cc_recipients=list(cc_recipients),
bcc_recipients=list(bcc_recipients),
author=author,
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.message.Message.mark_as_junk"><code class="name flex">
<span>def <span class="ident">mark_as_junk</span></span>(<span>self, is_junk=True, move_item=True)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def mark_as_junk(self, is_junk=True, move_item=True):
"""Mark or un-marks items as junk email.
:param is_junk: If True, the sender will be added from the blocked sender list. Otherwise, the sender will be
removed.
:param move_item: If true, the item will be moved to the junk folder.
:return:
"""
from ..services import MarkAsJunk
res = MarkAsJunk(account=self.account).get(
items=[self], is_junk=is_junk, move_item=move_item, expect_result=None
)
if res is None:
return
self.folder = self.account.junk if is_junk else self.account.inbox
self.id, self.changekey = res</code></pre>
</details>
<div class="desc"><p>Mark or un-marks items as junk email.</p>
<p>:param is_junk: If True, the sender will be added from the blocked sender list. Otherwise, the sender will be
removed.
:param move_item: If true, the item will be moved to the junk folder.
:return:</p></div>
</dd>
<dt id="exchangelib.items.message.Message.reply"><code class="name flex">
<span>def <span class="ident">reply</span></span>(<span>self,<br>subject,<br>body,<br>to_recipients=None,<br>cc_recipients=None,<br>bcc_recipients=None,<br>author=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def reply(self, subject, body, to_recipients=None, cc_recipients=None, bcc_recipients=None, author=None):
return self.create_reply(subject, body, to_recipients, cc_recipients, bcc_recipients, author).send()</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.message.Message.reply_all"><code class="name flex">
<span>def <span class="ident">reply_all</span></span>(<span>self, subject, body, author=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def reply_all(self, subject, body, author=None):
return self.create_reply_all(subject, body, author).send()</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.message.Message.send"><code class="name flex">
<span>def <span class="ident">send</span></span>(<span>self,<br>save_copy=True,<br>copy_to_folder=None,<br>conflict_resolution='AutoResolve',<br>send_meeting_invitations='SendToNone')</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_account
def send(
self,
save_copy=True,
copy_to_folder=None,
conflict_resolution=AUTO_RESOLVE,
send_meeting_invitations=SEND_TO_NONE,
):
from ..services import SendItem
# Only sends a message. The message can either be an existing draft stored in EWS or a new message that does
# not yet exist in EWS.
if copy_to_folder and not save_copy:
raise AttributeError("'save_copy' must be True when 'copy_to_folder' is set")
if save_copy and not copy_to_folder:
copy_to_folder = self.account.sent # 'Sent' is default EWS behaviour
if self.id:
SendItem(account=self.account).get(items=[self], saved_item_folder=copy_to_folder)
# The item will be deleted from the original folder
self._id = None
self.folder = copy_to_folder
return None
# New message
if copy_to_folder:
# This would better be done via send_and_save() but let's just support it here
self.folder = copy_to_folder
return self.send_and_save(
conflict_resolution=conflict_resolution, send_meeting_invitations=send_meeting_invitations
)
if self.account.version.build < EXCHANGE_2013 and self.attachments:
# At least some versions prior to Exchange 2013 can't send attachments immediately. You need to first save,
# then attach, then send. This is done in send_and_save(). send() will delete the item again.
self.send_and_save(
conflict_resolution=conflict_resolution, send_meeting_invitations=send_meeting_invitations
)
return None
self._create(message_disposition=SEND_ONLY, send_meeting_invitations=send_meeting_invitations)
return None</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.message.Message.send_and_save"><code class="name flex">
<span>def <span class="ident">send_and_save</span></span>(<span>self,<br>update_fields=None,<br>conflict_resolution='AutoResolve',<br>send_meeting_invitations='SendToNone')</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def send_and_save(
self, update_fields=None, conflict_resolution=AUTO_RESOLVE, send_meeting_invitations=SEND_TO_NONE
):
# Sends Message and saves a copy in the parent folder. Does not return an ItemId.
if self.id:
return self._update(
update_fieldnames=update_fields,
message_disposition=SEND_AND_SAVE_COPY,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
if self.account.version.build < EXCHANGE_2013 and self.attachments:
# At least some versions prior to Exchange 2013 can't send-and-save attachments immediately. You need
# to first save, then attach, then send. This is done in save().
self.save(
update_fields=update_fields,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
return self.send(
save_copy=False,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
return self._create(message_disposition=SEND_AND_SAVE_COPY, send_meeting_invitations=send_meeting_invitations)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.items.item.Item" href="item.html#exchangelib.items.item.Item">Item</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.items.item.Item.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.items.item.Item.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.items.item.Item.ID_ELEMENT_CLS" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn.ID_ELEMENT_CLS">ID_ELEMENT_CLS</a></code></li>
<li><code><a title="exchangelib.items.item.Item.INSERT_AFTER_FIELD" href="base.html#exchangelib.items.base.RegisterMixIn.INSERT_AFTER_FIELD">INSERT_AFTER_FIELD</a></code></li>
<li><code><a title="exchangelib.items.item.Item.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.items.item.Item.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.items.item.Item.attach" href="item.html#exchangelib.items.item.Item.attach">attach</a></code></li>
<li><code><a title="exchangelib.items.item.Item.attachments" href="item.html#exchangelib.items.item.Item.attachments">attachments</a></code></li>
<li><code><a title="exchangelib.items.item.Item.body" href="item.html#exchangelib.items.item.Item.body">body</a></code></li>
<li><code><a title="exchangelib.items.item.Item.categories" href="item.html#exchangelib.items.item.Item.categories">categories</a></code></li>
<li><code><a title="exchangelib.items.item.Item.conversation_id" href="item.html#exchangelib.items.item.Item.conversation_id">conversation_id</a></code></li>
<li><code><a title="exchangelib.items.item.Item.culture" href="item.html#exchangelib.items.item.Item.culture">culture</a></code></li>
<li><code><a title="exchangelib.items.item.Item.datetime_created" href="item.html#exchangelib.items.item.Item.datetime_created">datetime_created</a></code></li>
<li><code><a title="exchangelib.items.item.Item.datetime_received" href="item.html#exchangelib.items.item.Item.datetime_received">datetime_received</a></code></li>
<li><code><a title="exchangelib.items.item.Item.datetime_sent" href="item.html#exchangelib.items.item.Item.datetime_sent">datetime_sent</a></code></li>
<li><code><a title="exchangelib.items.item.Item.deregister" href="base.html#exchangelib.items.base.RegisterMixIn.deregister">deregister</a></code></li>
<li><code><a title="exchangelib.items.item.Item.detach" href="item.html#exchangelib.items.item.Item.detach">detach</a></code></li>
<li><code><a title="exchangelib.items.item.Item.display_cc" href="item.html#exchangelib.items.item.Item.display_cc">display_cc</a></code></li>
<li><code><a title="exchangelib.items.item.Item.display_to" href="item.html#exchangelib.items.item.Item.display_to">display_to</a></code></li>
<li><code><a title="exchangelib.items.item.Item.effective_rights" href="item.html#exchangelib.items.item.Item.effective_rights">effective_rights</a></code></li>
<li><code><a title="exchangelib.items.item.Item.has_attachments" href="item.html#exchangelib.items.item.Item.has_attachments">has_attachments</a></code></li>
<li><code><a title="exchangelib.items.item.Item.headers" href="item.html#exchangelib.items.item.Item.headers">headers</a></code></li>
<li><code><a title="exchangelib.items.item.Item.importance" href="item.html#exchangelib.items.item.Item.importance">importance</a></code></li>
<li><code><a title="exchangelib.items.item.Item.in_reply_to" href="item.html#exchangelib.items.item.Item.in_reply_to">in_reply_to</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_associated" href="item.html#exchangelib.items.item.Item.is_associated">is_associated</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_draft" href="item.html#exchangelib.items.item.Item.is_draft">is_draft</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_from_me" href="item.html#exchangelib.items.item.Item.is_from_me">is_from_me</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_resend" href="item.html#exchangelib.items.item.Item.is_resend">is_resend</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_submitted" href="item.html#exchangelib.items.item.Item.is_submitted">is_submitted</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_unmodified" href="item.html#exchangelib.items.item.Item.is_unmodified">is_unmodified</a></code></li>
<li><code><a title="exchangelib.items.item.Item.item_class" href="item.html#exchangelib.items.item.Item.item_class">item_class</a></code></li>
<li><code><a title="exchangelib.items.item.Item.last_modified_name" href="item.html#exchangelib.items.item.Item.last_modified_name">last_modified_name</a></code></li>
<li><code><a title="exchangelib.items.item.Item.last_modified_time" href="item.html#exchangelib.items.item.Item.last_modified_time">last_modified_time</a></code></li>
<li><code><a title="exchangelib.items.item.Item.mime_content" href="item.html#exchangelib.items.item.Item.mime_content">mime_content</a></code></li>
<li><code><a title="exchangelib.items.item.Item.parent_folder_id" href="item.html#exchangelib.items.item.Item.parent_folder_id">parent_folder_id</a></code></li>
<li><code><a title="exchangelib.items.item.Item.register" href="base.html#exchangelib.items.base.RegisterMixIn.register">register</a></code></li>
<li><code><a title="exchangelib.items.item.Item.reminder_due_by" href="item.html#exchangelib.items.item.Item.reminder_due_by">reminder_due_by</a></code></li>
<li><code><a title="exchangelib.items.item.Item.reminder_is_set" href="item.html#exchangelib.items.item.Item.reminder_is_set">reminder_is_set</a></code></li>
<li><code><a title="exchangelib.items.item.Item.reminder_minutes_before_start" href="item.html#exchangelib.items.item.Item.reminder_minutes_before_start">reminder_minutes_before_start</a></code></li>
<li><code><a title="exchangelib.items.item.Item.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.items.item.Item.response_objects" href="item.html#exchangelib.items.item.Item.response_objects">response_objects</a></code></li>
<li><code><a title="exchangelib.items.item.Item.sensitivity" href="item.html#exchangelib.items.item.Item.sensitivity">sensitivity</a></code></li>
<li><code><a title="exchangelib.items.item.Item.size" href="item.html#exchangelib.items.item.Item.size">size</a></code></li>
<li><code><a title="exchangelib.items.item.Item.subject" href="item.html#exchangelib.items.item.Item.subject">subject</a></code></li>
<li><code><a title="exchangelib.items.item.Item.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.items.item.Item.text_body" href="item.html#exchangelib.items.item.Item.text_body">text_body</a></code></li>
<li><code><a title="exchangelib.items.item.Item.unique_body" href="item.html#exchangelib.items.item.Item.unique_body">unique_body</a></code></li>
<li><code><a title="exchangelib.items.item.Item.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
<li><code><a title="exchangelib.items.item.Item.web_client_edit_form_query_string" href="item.html#exchangelib.items.item.Item.web_client_edit_form_query_string">web_client_edit_form_query_string</a></code></li>
<li><code><a title="exchangelib.items.item.Item.web_client_read_form_query_string" href="item.html#exchangelib.items.item.Item.web_client_read_form_query_string">web_client_read_form_query_string</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="exchangelib.items.message.ReplyAllToItem"><code class="flex name class">
<span>class <span class="ident">ReplyAllToItem</span></span>
<span>(</span><span>**kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ReplyAllToItem(BaseReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/replyalltoitem"""
ELEMENT_NAME = "ReplyAllToItem"</code></pre>
</details>
<div class="desc"><p>MSDN: <a href="https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/replyalltoitem">https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/replyalltoitem</a></p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.items.base.BaseReplyItem" href="base.html#exchangelib.items.base.BaseReplyItem">BaseReplyItem</a></li>
<li><a title="exchangelib.properties.EWSElement" href="../properties.html#exchangelib.properties.EWSElement">EWSElement</a></li>
</ul>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.items.base.BaseReplyItem" href="base.html#exchangelib.items.base.BaseReplyItem">BaseReplyItem</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.items.base.BaseReplyItem.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.author" href="base.html#exchangelib.items.base.BaseReplyItem.author">author</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.bcc_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.bcc_recipients">bcc_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.body" href="base.html#exchangelib.items.base.BaseReplyItem.body">body</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.cc_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.cc_recipients">cc_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.is_delivery_receipt_requested" href="base.html#exchangelib.items.base.BaseReplyItem.is_delivery_receipt_requested">is_delivery_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.is_read_receipt_requested" href="base.html#exchangelib.items.base.BaseReplyItem.is_read_receipt_requested">is_read_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.new_body" href="base.html#exchangelib.items.base.BaseReplyItem.new_body">new_body</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.received_by" href="base.html#exchangelib.items.base.BaseReplyItem.received_by">received_by</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.received_representing" href="base.html#exchangelib.items.base.BaseReplyItem.received_representing">received_representing</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.reference_item_id" href="base.html#exchangelib.items.base.BaseReplyItem.reference_item_id">reference_item_id</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.save" href="base.html#exchangelib.items.base.BaseReplyItem.save">save</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.subject" href="base.html#exchangelib.items.base.BaseReplyItem.subject">subject</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.to_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.to_recipients">to_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="exchangelib.items.message.ReplyToItem"><code class="flex name class">
<span>class <span class="ident">ReplyToItem</span></span>
<span>(</span><span>**kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ReplyToItem(BaseReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/replytoitem"""
ELEMENT_NAME = "ReplyToItem"</code></pre>
</details>
<div class="desc"><p>MSDN: <a href="https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/replytoitem">https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/replytoitem</a></p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.items.base.BaseReplyItem" href="base.html#exchangelib.items.base.BaseReplyItem">BaseReplyItem</a></li>
<li><a title="exchangelib.properties.EWSElement" href="../properties.html#exchangelib.properties.EWSElement">EWSElement</a></li>
</ul>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.items.base.BaseReplyItem" href="base.html#exchangelib.items.base.BaseReplyItem">BaseReplyItem</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.items.base.BaseReplyItem.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.author" href="base.html#exchangelib.items.base.BaseReplyItem.author">author</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.bcc_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.bcc_recipients">bcc_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.body" href="base.html#exchangelib.items.base.BaseReplyItem.body">body</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.cc_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.cc_recipients">cc_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.is_delivery_receipt_requested" href="base.html#exchangelib.items.base.BaseReplyItem.is_delivery_receipt_requested">is_delivery_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.is_read_receipt_requested" href="base.html#exchangelib.items.base.BaseReplyItem.is_read_receipt_requested">is_read_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.new_body" href="base.html#exchangelib.items.base.BaseReplyItem.new_body">new_body</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.received_by" href="base.html#exchangelib.items.base.BaseReplyItem.received_by">received_by</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.received_representing" href="base.html#exchangelib.items.base.BaseReplyItem.received_representing">received_representing</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.reference_item_id" href="base.html#exchangelib.items.base.BaseReplyItem.reference_item_id">reference_item_id</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.save" href="base.html#exchangelib.items.base.BaseReplyItem.save">save</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.subject" href="base.html#exchangelib.items.base.BaseReplyItem.subject">subject</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.to_recipients" href="base.html#exchangelib.items.base.BaseReplyItem.to_recipients">to_recipients</a></code></li>
<li><code><a title="exchangelib.items.base.BaseReplyItem.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="exchangelib.items" href="index.html">exchangelib.items</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="exchangelib.items.message.ForwardItem" href="#exchangelib.items.message.ForwardItem">ForwardItem</a></code></h4>
</li>
<li>
<h4><code><a title="exchangelib.items.message.Message" href="#exchangelib.items.message.Message">Message</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.items.message.Message.author" href="#exchangelib.items.message.Message.author">author</a></code></li>
<li><code><a title="exchangelib.items.message.Message.bcc_recipients" href="#exchangelib.items.message.Message.bcc_recipients">bcc_recipients</a></code></li>
<li><code><a title="exchangelib.items.message.Message.cc_recipients" href="#exchangelib.items.message.Message.cc_recipients">cc_recipients</a></code></li>
<li><code><a title="exchangelib.items.message.Message.conversation_index" href="#exchangelib.items.message.Message.conversation_index">conversation_index</a></code></li>
<li><code><a title="exchangelib.items.message.Message.conversation_topic" href="#exchangelib.items.message.Message.conversation_topic">conversation_topic</a></code></li>
<li><code><a title="exchangelib.items.message.Message.create_reply" href="#exchangelib.items.message.Message.create_reply">create_reply</a></code></li>
<li><code><a title="exchangelib.items.message.Message.create_reply_all" href="#exchangelib.items.message.Message.create_reply_all">create_reply_all</a></code></li>
<li><code><a title="exchangelib.items.message.Message.is_delivery_receipt_requested" href="#exchangelib.items.message.Message.is_delivery_receipt_requested">is_delivery_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.message.Message.is_read" href="#exchangelib.items.message.Message.is_read">is_read</a></code></li>
<li><code><a title="exchangelib.items.message.Message.is_read_receipt_requested" href="#exchangelib.items.message.Message.is_read_receipt_requested">is_read_receipt_requested</a></code></li>
<li><code><a title="exchangelib.items.message.Message.is_response_requested" href="#exchangelib.items.message.Message.is_response_requested">is_response_requested</a></code></li>
<li><code><a title="exchangelib.items.message.Message.mark_as_junk" href="#exchangelib.items.message.Message.mark_as_junk">mark_as_junk</a></code></li>
<li><code><a title="exchangelib.items.message.Message.message_id" href="#exchangelib.items.message.Message.message_id">message_id</a></code></li>
<li><code><a title="exchangelib.items.message.Message.received_by" href="#exchangelib.items.message.Message.received_by">received_by</a></code></li>
<li><code><a title="exchangelib.items.message.Message.received_representing" href="#exchangelib.items.message.Message.received_representing">received_representing</a></code></li>
<li><code><a title="exchangelib.items.message.Message.references" href="#exchangelib.items.message.Message.references">references</a></code></li>
<li><code><a title="exchangelib.items.message.Message.reminder_message_data" href="#exchangelib.items.message.Message.reminder_message_data">reminder_message_data</a></code></li>
<li><code><a title="exchangelib.items.message.Message.reply" href="#exchangelib.items.message.Message.reply">reply</a></code></li>
<li><code><a title="exchangelib.items.message.Message.reply_all" href="#exchangelib.items.message.Message.reply_all">reply_all</a></code></li>
<li><code><a title="exchangelib.items.message.Message.reply_to" href="#exchangelib.items.message.Message.reply_to">reply_to</a></code></li>
<li><code><a title="exchangelib.items.message.Message.send" href="#exchangelib.items.message.Message.send">send</a></code></li>
<li><code><a title="exchangelib.items.message.Message.send_and_save" href="#exchangelib.items.message.Message.send_and_save">send_and_save</a></code></li>
<li><code><a title="exchangelib.items.message.Message.sender" href="#exchangelib.items.message.Message.sender">sender</a></code></li>
<li><code><a title="exchangelib.items.message.Message.to_recipients" href="#exchangelib.items.message.Message.to_recipients">to_recipients</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="exchangelib.items.message.ReplyAllToItem" href="#exchangelib.items.message.ReplyAllToItem">ReplyAllToItem</a></code></h4>
</li>
<li>
<h4><code><a title="exchangelib.items.message.ReplyToItem" href="#exchangelib.items.message.ReplyToItem">ReplyToItem</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>
|