1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
|
<!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.item 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.item</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.item.Item"><code class="flex name class">
<span>class <span class="ident">Item</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 Item(BaseItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/item"""
ELEMENT_NAME = "Item"
mime_content = MimeContentField(field_uri="item:MimeContent", is_read_only_after_send=True)
_id = BaseItem.FIELDS["_id"]
parent_folder_id = EWSElementField(field_uri="item:ParentFolderId", value_cls=ParentFolderId, is_read_only=True)
item_class = CharField(field_uri="item:ItemClass", is_read_only=True)
subject = CharField(field_uri="item:Subject")
sensitivity = ChoiceField(
field_uri="item:Sensitivity",
choices={Choice("Normal"), Choice("Personal"), Choice("Private"), Choice("Confidential")},
is_required=True,
default="Normal",
)
text_body = TextField(field_uri="item:TextBody", is_read_only=True, supported_from=EXCHANGE_2013)
body = BodyField(field_uri="item:Body") # Accepts and returns Body or HTMLBody instances
attachments = AttachmentField(field_uri="item:Attachments") # ItemAttachment or FileAttachment
datetime_received = DateTimeField(field_uri="item:DateTimeReceived", is_read_only=True)
size = IntegerField(field_uri="item:Size", is_read_only=True) # Item size in bytes
categories = CharListField(field_uri="item:Categories")
importance = ChoiceField(
field_uri="item:Importance",
choices={Choice("Low"), Choice("Normal"), Choice("High")},
is_required=True,
default="Normal",
)
in_reply_to = TextField(field_uri="item:InReplyTo")
is_submitted = BooleanField(field_uri="item:IsSubmitted", is_read_only=True)
is_draft = BooleanField(field_uri="item:IsDraft", is_read_only=True)
is_from_me = BooleanField(field_uri="item:IsFromMe", is_read_only=True)
is_resend = BooleanField(field_uri="item:IsResend", is_read_only=True)
is_unmodified = BooleanField(field_uri="item:IsUnmodified", is_read_only=True)
headers = MessageHeaderField(field_uri="item:InternetMessageHeaders", is_read_only=True)
datetime_sent = DateTimeField(field_uri="item:DateTimeSent", is_read_only=True)
datetime_created = DateTimeField(field_uri="item:DateTimeCreated", is_read_only=True)
response_objects = EWSElementField(
field_uri="item:ResponseObjects",
value_cls=ResponseObjects,
is_read_only=True,
)
# Placeholder for ResponseObjects
reminder_due_by = DateTimeField(field_uri="item:ReminderDueBy", is_required_after_save=True, is_searchable=False)
reminder_is_set = BooleanField(field_uri="item:ReminderIsSet", is_required=True, default=False)
reminder_minutes_before_start = IntegerField(
field_uri="item:ReminderMinutesBeforeStart", is_required_after_save=True, min=0, default=0
)
display_cc = TextField(field_uri="item:DisplayCc", is_read_only=True)
display_to = TextField(field_uri="item:DisplayTo", is_read_only=True)
has_attachments = BooleanField(field_uri="item:HasAttachments", is_read_only=True)
# ExtendedProperty fields go here
culture = CultureField(field_uri="item:Culture", is_required_after_save=True, is_searchable=False)
effective_rights = EffectiveRightsField(field_uri="item:EffectiveRights", is_read_only=True)
last_modified_name = CharField(field_uri="item:LastModifiedName", is_read_only=True)
last_modified_time = DateTimeField(field_uri="item:LastModifiedTime", is_read_only=True)
is_associated = BooleanField(field_uri="item:IsAssociated", is_read_only=True, supported_from=EXCHANGE_2010)
web_client_read_form_query_string = URIField(
field_uri="item:WebClientReadFormQueryString", is_read_only=True, supported_from=EXCHANGE_2010
)
web_client_edit_form_query_string = URIField(
field_uri="item:WebClientEditFormQueryString", is_read_only=True, supported_from=EXCHANGE_2010
)
conversation_id = EWSElementField(
field_uri="item:ConversationId", value_cls=ConversationId, is_read_only=True, supported_from=EXCHANGE_2010
)
unique_body = BodyField(field_uri="item:UniqueBody", is_read_only=True, supported_from=EXCHANGE_2010)
FIELDS = Fields()
# Used to register extended properties
INSERT_AFTER_FIELD = "has_attachments"
def __init__(self, **kwargs):
super().__init__(**kwargs)
if self.attachments:
for a in self.attachments:
if a.parent_item:
if a.parent_item is not self:
raise ValueError(f"'parent_item' of attachment {a} must point to this item")
else:
a.parent_item = self
self.attach(self.attachments)
else:
self.attachments = []
def save(self, update_fields=None, conflict_resolution=AUTO_RESOLVE, send_meeting_invitations=SEND_TO_NONE):
from .task import Task
if self.id:
item_id, changekey = self._update(
update_fieldnames=update_fields,
message_disposition=SAVE_ONLY,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
if (
self.id != item_id
and not isinstance(self._id, (OccurrenceItemId, RecurringMasterItemId))
and not isinstance(self, Task)
):
# When we update an item with an OccurrenceItemId as ID, EWS returns the ID of the occurrence, so
# the ID of this item changes.
#
# When we update certain fields on a task, the ID may change. A full description is available at
# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateitem-operation-task
raise ValueError("'id' mismatch in returned update response")
# Don't check that changekeys are different. No-op saves will sometimes leave the changekey intact
self._id = self.ID_ELEMENT_CLS(item_id, changekey)
else:
if update_fields:
raise ValueError("'update_fields' is only valid for updates")
tmp_attachments = None
if self.account and self.account.version.build < EXCHANGE_2013 and self.attachments:
# At least some versions prior to Exchange 2013 can't save attachments immediately. You need to first
# save, then attach. Store the attachment of this item temporarily and attach later.
tmp_attachments, self.attachments = self.attachments, []
item = self._create(message_disposition=SAVE_ONLY, send_meeting_invitations=send_meeting_invitations)
self._id = self.ID_ELEMENT_CLS(item.id, item.changekey)
for old_att, new_att in zip(self.attachments, item.attachments):
if old_att.attachment_id is not None:
raise ValueError("Old 'attachment_id' is not empty")
if new_att.attachment_id is None:
raise ValueError("New 'attachment_id' is empty")
old_att.attachment_id = new_att.attachment_id
if tmp_attachments:
# Exchange 2007 workaround. See above
self.attach(tmp_attachments)
return self
@require_account
def _create(self, message_disposition, send_meeting_invitations):
# Return a BulkCreateResult because we want to return the ID of both the main item *and* attachments. In send
# and send-and-save-copy mode, the server does not return an ID, so we just return True.
from ..services import CreateItem
return CreateItem(account=self.account).get(
items=[self],
folder=self.folder,
message_disposition=message_disposition,
send_meeting_invitations=send_meeting_invitations,
)
def _update_fieldnames(self):
from .contact import Contact, DistributionList
# Return the list of fields we are allowed to update
update_fieldnames = []
for f in self.supported_fields(version=self.account.version):
if f.name == "attachments":
# Attachments are handled separately after item creation
continue
if f.is_read_only:
# These cannot be changed
continue
if (f.is_required or f.is_required_after_save) and (
getattr(self, f.name) is None or (f.is_list and not getattr(self, f.name))
):
# These are required and cannot be deleted
continue
if not self.is_draft and f.is_read_only_after_send:
# These cannot be changed when the item is no longer a draft
continue
if f.name == "message_id" and f.is_read_only_after_send:
# 'message_id' doesn't support updating, no matter the draft status
continue
if f.name == "mime_content" and isinstance(self, (Contact, DistributionList)):
# Contact and DistributionList don't support updating mime_content, no matter the draft status
continue
update_fieldnames.append(f.name)
return update_fieldnames
@require_account
def _update(self, update_fieldnames, message_disposition, conflict_resolution, send_meeting_invitations):
from ..services import UpdateItem
if not self.changekey:
raise ValueError(f"{self.__class__.__name__} must have changekey")
if not update_fieldnames:
# The fields to update was not specified explicitly. Update all fields where update is possible
update_fieldnames = self._update_fieldnames()
return UpdateItem(account=self.account).get(
items=[(self, update_fieldnames)],
message_disposition=message_disposition,
conflict_resolution=conflict_resolution,
send_meeting_invitations_or_cancellations=send_meeting_invitations,
suppress_read_receipts=True,
expect_result=message_disposition != SEND_AND_SAVE_COPY,
)
@require_id
def refresh(self):
# Updates the item based on fresh data from EWS
from ..services import GetItem
additional_fields = {FieldPath(field=f) for f in self.supported_fields(version=self.account.version)}
res = GetItem(account=self.account).get(items=[self], additional_fields=additional_fields, shape=ID_ONLY)
if self.id != res.id and not isinstance(self._id, (OccurrenceItemId, RecurringMasterItemId)):
# When we refresh an item with an OccurrenceItemId as ID, EWS returns the ID of the occurrence, so
# the ID of this item changes.
raise ValueError("'id' mismatch in returned update response")
for f in self.FIELDS:
setattr(self, f.name, getattr(res, f.name))
# 'parent_item' should point to 'self', not 'fresh_item'. That way, 'fresh_item' can be garbage collected.
for a in self.attachments:
a.parent_item = self
return self
@require_id
def copy(self, to_folder):
from ..services import CopyItem
# If 'to_folder' is a public folder or a folder in a different mailbox then None is returned
return CopyItem(account=self.account).get(
items=[self],
to_folder=to_folder,
expect_result=None,
)
@require_id
def move(self, to_folder):
from ..services import MoveItem
res = MoveItem(account=self.account).get(
items=[self],
to_folder=to_folder,
expect_result=None,
)
if res is None:
# Assume 'to_folder' is a public folder or a folder in a different mailbox
self._id = None
return
self._id = self.ID_ELEMENT_CLS(*res)
self.folder = to_folder
def move_to_trash(
self,
send_meeting_cancellations=SEND_TO_NONE,
affected_task_occurrences=ALL_OCCURRENCES,
suppress_read_receipts=True,
):
# Delete and move to the trash folder.
self._delete(
delete_type=MOVE_TO_DELETED_ITEMS,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
self._id = None
self.folder = self.account.trash
def soft_delete(
self,
send_meeting_cancellations=SEND_TO_NONE,
affected_task_occurrences=ALL_OCCURRENCES,
suppress_read_receipts=True,
):
# Delete and move to the dumpster, if it is enabled.
self._delete(
delete_type=SOFT_DELETE,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
self._id = None
self.folder = self.account.recoverable_items_deletions
def delete(
self,
send_meeting_cancellations=SEND_TO_NONE,
affected_task_occurrences=ALL_OCCURRENCES,
suppress_read_receipts=True,
):
# Remove the item permanently. No copies are stored anywhere.
self._delete(
delete_type=HARD_DELETE,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
self._id, self.folder = None, None
@require_id
def _delete(self, delete_type, send_meeting_cancellations, affected_task_occurrences, suppress_read_receipts):
from ..services import DeleteItem
DeleteItem(account=self.account).get(
items=[self],
delete_type=delete_type,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
@require_id
def archive(self, to_folder):
from ..services import ArchiveItem
return ArchiveItem(account=self.account).get(items=[self], to_folder=to_folder, expect_result=True)
def attach(self, attachments):
"""Add an attachment, or a list of attachments, to this item. If the item has already been saved, the
attachments will be created on the server immediately. If the item has not yet been saved, the attachments will
be created on the server when the item is saved.
Adding attachments to an existing item will update the changekey of the item.
:param attachments:
"""
if not is_iterable(attachments, generators_allowed=True):
attachments = [attachments]
for a in attachments:
if not a.parent_item:
a.parent_item = self
if self.id and not a.attachment_id:
# Already saved object. Attach the attachment server-side now
a.attach()
if a not in self.attachments:
self.attachments.append(a)
def detach(self, attachments):
"""Remove an attachment, or a list of attachments, from this item. If the item has already been saved, the
attachments will be deleted on the server immediately. If the item has not yet been saved, the attachments will
simply not be created on the server the item is saved.
Removing attachments from an existing item will update the changekey of the item.
:param attachments:
"""
if not is_iterable(attachments, generators_allowed=True):
attachments = [attachments]
if attachments is self.attachments:
# Don't remove from the same list we are iterating
attachments = list(attachments)
for a in attachments:
if a.parent_item is not self:
raise ValueError("Attachment does not belong to this item")
if self.id:
# Item is already created. Detach the attachment server-side now
a.detach()
if a in self.attachments:
self.attachments.remove(a)
@require_id
def create_forward(self, subject, body, to_recipients, cc_recipients=None, bcc_recipients=None):
from .message import ForwardItem
return ForwardItem(
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,
)
def forward(self, subject, body, to_recipients, cc_recipients=None, bcc_recipients=None):
return self.create_forward(
subject,
body,
to_recipients,
cc_recipients,
bcc_recipients,
).send()</code></pre>
</details>
<div class="desc"><p>MSDN: <a href="https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/item">https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/item</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.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>Subclasses</h3>
<ul class="hlist">
<li><a title="exchangelib.items.calendar_item.BaseMeetingItem" href="calendar_item.html#exchangelib.items.calendar_item.BaseMeetingItem">BaseMeetingItem</a></li>
<li><a title="exchangelib.items.calendar_item.CalendarItem" href="calendar_item.html#exchangelib.items.calendar_item.CalendarItem">CalendarItem</a></li>
<li>exchangelib.items.calendar_item._Booking</li>
<li><a title="exchangelib.items.contact.Contact" href="contact.html#exchangelib.items.contact.Contact">Contact</a></li>
<li><a title="exchangelib.items.contact.DistributionList" href="contact.html#exchangelib.items.contact.DistributionList">DistributionList</a></li>
<li><a title="exchangelib.items.message.Message" href="message.html#exchangelib.items.message.Message">Message</a></li>
<li><a title="exchangelib.items.post.PostItem" href="post.html#exchangelib.items.post.PostItem">PostItem</a></li>
<li><a title="exchangelib.items.post.PostReplyItem" href="post.html#exchangelib.items.post.PostReplyItem">PostReplyItem</a></li>
<li><a title="exchangelib.items.task.Task" href="task.html#exchangelib.items.task.Task">Task</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.items.item.Item.attachments"><code class="name">var <span class="ident">attachments</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.body"><code class="name">var <span class="ident">body</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.categories"><code class="name">var <span class="ident">categories</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.conversation_id"><code class="name">var <span class="ident">conversation_id</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.culture"><code class="name">var <span class="ident">culture</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.datetime_created"><code class="name">var <span class="ident">datetime_created</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.datetime_received"><code class="name">var <span class="ident">datetime_received</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.datetime_sent"><code class="name">var <span class="ident">datetime_sent</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.display_cc"><code class="name">var <span class="ident">display_cc</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.display_to"><code class="name">var <span class="ident">display_to</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.effective_rights"><code class="name">var <span class="ident">effective_rights</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.has_attachments"><code class="name">var <span class="ident">has_attachments</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.headers"><code class="name">var <span class="ident">headers</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.importance"><code class="name">var <span class="ident">importance</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.in_reply_to"><code class="name">var <span class="ident">in_reply_to</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.is_associated"><code class="name">var <span class="ident">is_associated</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.is_draft"><code class="name">var <span class="ident">is_draft</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.is_from_me"><code class="name">var <span class="ident">is_from_me</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.is_resend"><code class="name">var <span class="ident">is_resend</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.is_submitted"><code class="name">var <span class="ident">is_submitted</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.is_unmodified"><code class="name">var <span class="ident">is_unmodified</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.item_class"><code class="name">var <span class="ident">item_class</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.last_modified_name"><code class="name">var <span class="ident">last_modified_name</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.last_modified_time"><code class="name">var <span class="ident">last_modified_time</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.mime_content"><code class="name">var <span class="ident">mime_content</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.parent_folder_id"><code class="name">var <span class="ident">parent_folder_id</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.reminder_due_by"><code class="name">var <span class="ident">reminder_due_by</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.reminder_is_set"><code class="name">var <span class="ident">reminder_is_set</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.reminder_minutes_before_start"><code class="name">var <span class="ident">reminder_minutes_before_start</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.response_objects"><code class="name">var <span class="ident">response_objects</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.sensitivity"><code class="name">var <span class="ident">sensitivity</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.size"><code class="name">var <span class="ident">size</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.subject"><code class="name">var <span class="ident">subject</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.text_body"><code class="name">var <span class="ident">text_body</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.unique_body"><code class="name">var <span class="ident">unique_body</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.web_client_edit_form_query_string"><code class="name">var <span class="ident">web_client_edit_form_query_string</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.items.item.Item.web_client_read_form_query_string"><code class="name">var <span class="ident">web_client_read_form_query_string</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.item.Item.archive"><code class="name flex">
<span>def <span class="ident">archive</span></span>(<span>self, to_folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def archive(self, to_folder):
from ..services import ArchiveItem
return ArchiveItem(account=self.account).get(items=[self], to_folder=to_folder, expect_result=True)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.attach"><code class="name flex">
<span>def <span class="ident">attach</span></span>(<span>self, attachments)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def attach(self, attachments):
"""Add an attachment, or a list of attachments, to this item. If the item has already been saved, the
attachments will be created on the server immediately. If the item has not yet been saved, the attachments will
be created on the server when the item is saved.
Adding attachments to an existing item will update the changekey of the item.
:param attachments:
"""
if not is_iterable(attachments, generators_allowed=True):
attachments = [attachments]
for a in attachments:
if not a.parent_item:
a.parent_item = self
if self.id and not a.attachment_id:
# Already saved object. Attach the attachment server-side now
a.attach()
if a not in self.attachments:
self.attachments.append(a)</code></pre>
</details>
<div class="desc"><p>Add an attachment, or a list of attachments, to this item. If the item has already been saved, the
attachments will be created on the server immediately. If the item has not yet been saved, the attachments will
be created on the server when the item is saved.</p>
<p>Adding attachments to an existing item will update the changekey of the item.</p>
<p>:param attachments:</p></div>
</dd>
<dt id="exchangelib.items.item.Item.copy"><code class="name flex">
<span>def <span class="ident">copy</span></span>(<span>self, to_folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def copy(self, to_folder):
from ..services import CopyItem
# If 'to_folder' is a public folder or a folder in a different mailbox then None is returned
return CopyItem(account=self.account).get(
items=[self],
to_folder=to_folder,
expect_result=None,
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.create_forward"><code class="name flex">
<span>def <span class="ident">create_forward</span></span>(<span>self, subject, body, to_recipients, cc_recipients=None, bcc_recipients=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def create_forward(self, subject, body, to_recipients, cc_recipients=None, bcc_recipients=None):
from .message import ForwardItem
return ForwardItem(
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,
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.delete"><code class="name flex">
<span>def <span class="ident">delete</span></span>(<span>self,<br>send_meeting_cancellations='SendToNone',<br>affected_task_occurrences='AllOccurrences',<br>suppress_read_receipts=True)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def delete(
self,
send_meeting_cancellations=SEND_TO_NONE,
affected_task_occurrences=ALL_OCCURRENCES,
suppress_read_receipts=True,
):
# Remove the item permanently. No copies are stored anywhere.
self._delete(
delete_type=HARD_DELETE,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
self._id, self.folder = None, None</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.detach"><code class="name flex">
<span>def <span class="ident">detach</span></span>(<span>self, attachments)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def detach(self, attachments):
"""Remove an attachment, or a list of attachments, from this item. If the item has already been saved, the
attachments will be deleted on the server immediately. If the item has not yet been saved, the attachments will
simply not be created on the server the item is saved.
Removing attachments from an existing item will update the changekey of the item.
:param attachments:
"""
if not is_iterable(attachments, generators_allowed=True):
attachments = [attachments]
if attachments is self.attachments:
# Don't remove from the same list we are iterating
attachments = list(attachments)
for a in attachments:
if a.parent_item is not self:
raise ValueError("Attachment does not belong to this item")
if self.id:
# Item is already created. Detach the attachment server-side now
a.detach()
if a in self.attachments:
self.attachments.remove(a)</code></pre>
</details>
<div class="desc"><p>Remove an attachment, or a list of attachments, from this item. If the item has already been saved, the
attachments will be deleted on the server immediately. If the item has not yet been saved, the attachments will
simply not be created on the server the item is saved.</p>
<p>Removing attachments from an existing item will update the changekey of the item.</p>
<p>:param attachments:</p></div>
</dd>
<dt id="exchangelib.items.item.Item.forward"><code class="name flex">
<span>def <span class="ident">forward</span></span>(<span>self, subject, body, to_recipients, cc_recipients=None, bcc_recipients=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def forward(self, subject, body, to_recipients, cc_recipients=None, bcc_recipients=None):
return self.create_forward(
subject,
body,
to_recipients,
cc_recipients,
bcc_recipients,
).send()</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.move"><code class="name flex">
<span>def <span class="ident">move</span></span>(<span>self, to_folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def move(self, to_folder):
from ..services import MoveItem
res = MoveItem(account=self.account).get(
items=[self],
to_folder=to_folder,
expect_result=None,
)
if res is None:
# Assume 'to_folder' is a public folder or a folder in a different mailbox
self._id = None
return
self._id = self.ID_ELEMENT_CLS(*res)
self.folder = to_folder</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.move_to_trash"><code class="name flex">
<span>def <span class="ident">move_to_trash</span></span>(<span>self,<br>send_meeting_cancellations='SendToNone',<br>affected_task_occurrences='AllOccurrences',<br>suppress_read_receipts=True)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def move_to_trash(
self,
send_meeting_cancellations=SEND_TO_NONE,
affected_task_occurrences=ALL_OCCURRENCES,
suppress_read_receipts=True,
):
# Delete and move to the trash folder.
self._delete(
delete_type=MOVE_TO_DELETED_ITEMS,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
self._id = None
self.folder = self.account.trash</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.refresh"><code class="name flex">
<span>def <span class="ident">refresh</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@require_id
def refresh(self):
# Updates the item based on fresh data from EWS
from ..services import GetItem
additional_fields = {FieldPath(field=f) for f in self.supported_fields(version=self.account.version)}
res = GetItem(account=self.account).get(items=[self], additional_fields=additional_fields, shape=ID_ONLY)
if self.id != res.id and not isinstance(self._id, (OccurrenceItemId, RecurringMasterItemId)):
# When we refresh an item with an OccurrenceItemId as ID, EWS returns the ID of the occurrence, so
# the ID of this item changes.
raise ValueError("'id' mismatch in returned update response")
for f in self.FIELDS:
setattr(self, f.name, getattr(res, f.name))
# 'parent_item' should point to 'self', not 'fresh_item'. That way, 'fresh_item' can be garbage collected.
for a in self.attachments:
a.parent_item = self
return self</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.save"><code class="name flex">
<span>def <span class="ident">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 save(self, update_fields=None, conflict_resolution=AUTO_RESOLVE, send_meeting_invitations=SEND_TO_NONE):
from .task import Task
if self.id:
item_id, changekey = self._update(
update_fieldnames=update_fields,
message_disposition=SAVE_ONLY,
conflict_resolution=conflict_resolution,
send_meeting_invitations=send_meeting_invitations,
)
if (
self.id != item_id
and not isinstance(self._id, (OccurrenceItemId, RecurringMasterItemId))
and not isinstance(self, Task)
):
# When we update an item with an OccurrenceItemId as ID, EWS returns the ID of the occurrence, so
# the ID of this item changes.
#
# When we update certain fields on a task, the ID may change. A full description is available at
# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateitem-operation-task
raise ValueError("'id' mismatch in returned update response")
# Don't check that changekeys are different. No-op saves will sometimes leave the changekey intact
self._id = self.ID_ELEMENT_CLS(item_id, changekey)
else:
if update_fields:
raise ValueError("'update_fields' is only valid for updates")
tmp_attachments = None
if self.account and self.account.version.build < EXCHANGE_2013 and self.attachments:
# At least some versions prior to Exchange 2013 can't save attachments immediately. You need to first
# save, then attach. Store the attachment of this item temporarily and attach later.
tmp_attachments, self.attachments = self.attachments, []
item = self._create(message_disposition=SAVE_ONLY, send_meeting_invitations=send_meeting_invitations)
self._id = self.ID_ELEMENT_CLS(item.id, item.changekey)
for old_att, new_att in zip(self.attachments, item.attachments):
if old_att.attachment_id is not None:
raise ValueError("Old 'attachment_id' is not empty")
if new_att.attachment_id is None:
raise ValueError("New 'attachment_id' is empty")
old_att.attachment_id = new_att.attachment_id
if tmp_attachments:
# Exchange 2007 workaround. See above
self.attach(tmp_attachments)
return self</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.items.item.Item.soft_delete"><code class="name flex">
<span>def <span class="ident">soft_delete</span></span>(<span>self,<br>send_meeting_cancellations='SendToNone',<br>affected_task_occurrences='AllOccurrences',<br>suppress_read_receipts=True)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def soft_delete(
self,
send_meeting_cancellations=SEND_TO_NONE,
affected_task_occurrences=ALL_OCCURRENCES,
suppress_read_receipts=True,
):
# Delete and move to the dumpster, if it is enabled.
self._delete(
delete_type=SOFT_DELETE,
send_meeting_cancellations=send_meeting_cancellations,
affected_task_occurrences=affected_task_occurrences,
suppress_read_receipts=suppress_read_receipts,
)
self._id = None
self.folder = self.account.recoverable_items_deletions</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.items.base.BaseItem" href="base.html#exchangelib.items.base.BaseItem">BaseItem</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.items.base.BaseItem.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.ID_ELEMENT_CLS" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn.ID_ELEMENT_CLS">ID_ELEMENT_CLS</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.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.base.BaseItem.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.deregister" href="base.html#exchangelib.items.base.RegisterMixIn.deregister">deregister</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.register" href="base.html#exchangelib.items.base.RegisterMixIn.register">register</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.items.base.BaseItem.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.item.Item" href="#exchangelib.items.item.Item">Item</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.items.item.Item.archive" href="#exchangelib.items.item.Item.archive">archive</a></code></li>
<li><code><a title="exchangelib.items.item.Item.attach" href="#exchangelib.items.item.Item.attach">attach</a></code></li>
<li><code><a title="exchangelib.items.item.Item.attachments" href="#exchangelib.items.item.Item.attachments">attachments</a></code></li>
<li><code><a title="exchangelib.items.item.Item.body" href="#exchangelib.items.item.Item.body">body</a></code></li>
<li><code><a title="exchangelib.items.item.Item.categories" href="#exchangelib.items.item.Item.categories">categories</a></code></li>
<li><code><a title="exchangelib.items.item.Item.conversation_id" href="#exchangelib.items.item.Item.conversation_id">conversation_id</a></code></li>
<li><code><a title="exchangelib.items.item.Item.copy" href="#exchangelib.items.item.Item.copy">copy</a></code></li>
<li><code><a title="exchangelib.items.item.Item.create_forward" href="#exchangelib.items.item.Item.create_forward">create_forward</a></code></li>
<li><code><a title="exchangelib.items.item.Item.culture" href="#exchangelib.items.item.Item.culture">culture</a></code></li>
<li><code><a title="exchangelib.items.item.Item.datetime_created" href="#exchangelib.items.item.Item.datetime_created">datetime_created</a></code></li>
<li><code><a title="exchangelib.items.item.Item.datetime_received" href="#exchangelib.items.item.Item.datetime_received">datetime_received</a></code></li>
<li><code><a title="exchangelib.items.item.Item.datetime_sent" href="#exchangelib.items.item.Item.datetime_sent">datetime_sent</a></code></li>
<li><code><a title="exchangelib.items.item.Item.delete" href="#exchangelib.items.item.Item.delete">delete</a></code></li>
<li><code><a title="exchangelib.items.item.Item.detach" href="#exchangelib.items.item.Item.detach">detach</a></code></li>
<li><code><a title="exchangelib.items.item.Item.display_cc" href="#exchangelib.items.item.Item.display_cc">display_cc</a></code></li>
<li><code><a title="exchangelib.items.item.Item.display_to" href="#exchangelib.items.item.Item.display_to">display_to</a></code></li>
<li><code><a title="exchangelib.items.item.Item.effective_rights" href="#exchangelib.items.item.Item.effective_rights">effective_rights</a></code></li>
<li><code><a title="exchangelib.items.item.Item.forward" href="#exchangelib.items.item.Item.forward">forward</a></code></li>
<li><code><a title="exchangelib.items.item.Item.has_attachments" href="#exchangelib.items.item.Item.has_attachments">has_attachments</a></code></li>
<li><code><a title="exchangelib.items.item.Item.headers" href="#exchangelib.items.item.Item.headers">headers</a></code></li>
<li><code><a title="exchangelib.items.item.Item.importance" href="#exchangelib.items.item.Item.importance">importance</a></code></li>
<li><code><a title="exchangelib.items.item.Item.in_reply_to" href="#exchangelib.items.item.Item.in_reply_to">in_reply_to</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_associated" href="#exchangelib.items.item.Item.is_associated">is_associated</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_draft" href="#exchangelib.items.item.Item.is_draft">is_draft</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_from_me" href="#exchangelib.items.item.Item.is_from_me">is_from_me</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_resend" href="#exchangelib.items.item.Item.is_resend">is_resend</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_submitted" href="#exchangelib.items.item.Item.is_submitted">is_submitted</a></code></li>
<li><code><a title="exchangelib.items.item.Item.is_unmodified" href="#exchangelib.items.item.Item.is_unmodified">is_unmodified</a></code></li>
<li><code><a title="exchangelib.items.item.Item.item_class" href="#exchangelib.items.item.Item.item_class">item_class</a></code></li>
<li><code><a title="exchangelib.items.item.Item.last_modified_name" href="#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="#exchangelib.items.item.Item.last_modified_time">last_modified_time</a></code></li>
<li><code><a title="exchangelib.items.item.Item.mime_content" href="#exchangelib.items.item.Item.mime_content">mime_content</a></code></li>
<li><code><a title="exchangelib.items.item.Item.move" href="#exchangelib.items.item.Item.move">move</a></code></li>
<li><code><a title="exchangelib.items.item.Item.move_to_trash" href="#exchangelib.items.item.Item.move_to_trash">move_to_trash</a></code></li>
<li><code><a title="exchangelib.items.item.Item.parent_folder_id" href="#exchangelib.items.item.Item.parent_folder_id">parent_folder_id</a></code></li>
<li><code><a title="exchangelib.items.item.Item.refresh" href="#exchangelib.items.item.Item.refresh">refresh</a></code></li>
<li><code><a title="exchangelib.items.item.Item.reminder_due_by" href="#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="#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="#exchangelib.items.item.Item.reminder_minutes_before_start">reminder_minutes_before_start</a></code></li>
<li><code><a title="exchangelib.items.item.Item.response_objects" href="#exchangelib.items.item.Item.response_objects">response_objects</a></code></li>
<li><code><a title="exchangelib.items.item.Item.save" href="#exchangelib.items.item.Item.save">save</a></code></li>
<li><code><a title="exchangelib.items.item.Item.sensitivity" href="#exchangelib.items.item.Item.sensitivity">sensitivity</a></code></li>
<li><code><a title="exchangelib.items.item.Item.size" href="#exchangelib.items.item.Item.size">size</a></code></li>
<li><code><a title="exchangelib.items.item.Item.soft_delete" href="#exchangelib.items.item.Item.soft_delete">soft_delete</a></code></li>
<li><code><a title="exchangelib.items.item.Item.subject" href="#exchangelib.items.item.Item.subject">subject</a></code></li>
<li><code><a title="exchangelib.items.item.Item.text_body" href="#exchangelib.items.item.Item.text_body">text_body</a></code></li>
<li><code><a title="exchangelib.items.item.Item.unique_body" href="#exchangelib.items.item.Item.unique_body">unique_body</a></code></li>
<li><code><a title="exchangelib.items.item.Item.web_client_edit_form_query_string" href="#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="#exchangelib.items.item.Item.web_client_read_form_query_string">web_client_read_form_query_string</a></code></li>
</ul>
</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>
|