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 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
|
<!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.version 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.version</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.version.Build"><code class="flex name class">
<span>class <span class="ident">Build</span></span>
<span>(</span><span>major_version, minor_version, major_build=0, minor_build=0)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Build:
"""Holds methods for working with build numbers."""
__slots__ = "major_version", "minor_version", "major_build", "minor_build"
def __init__(self, major_version, minor_version, major_build=0, minor_build=0):
if not isinstance(major_version, int):
raise InvalidTypeError("major_version", major_version, int)
if not isinstance(minor_version, int):
raise InvalidTypeError("minor_version", minor_version, int)
if not isinstance(major_build, int):
raise InvalidTypeError("major_build", major_build, int)
if not isinstance(minor_build, int):
raise InvalidTypeError("minor_build", minor_build, int)
self.major_version = major_version
self.minor_version = minor_version
self.major_build = major_build
self.minor_build = minor_build
@classmethod
def from_xml(cls, elem):
xml_elems_map = {
"major_version": "MajorVersion",
"minor_version": "MinorVersion",
"major_build": "MajorBuildNumber",
"minor_build": "MinorBuildNumber",
}
kwargs = {}
for k, xml_elem in xml_elems_map.items():
v = elem.get(xml_elem)
if v is None:
v = get_xml_attr(elem, f"{{{ANS}}}{xml_elem}")
if v is None:
raise ValueError()
kwargs[k] = int(v) # Also raises ValueError
return cls(**kwargs)
def api_version(self):
for build, api_version, _ in VERSIONS:
if self.major_version != build.major_version or self.minor_version != build.minor_version:
continue
if self >= build:
return api_version
raise ValueError(f"API version for build {self} is unknown")
def __cmp__(self, other):
# __cmp__ is not a magic method in Python3. We'll just use it here to implement comparison operators
c = (self.major_version > other.major_version) - (self.major_version < other.major_version)
if c != 0:
return c
c = (self.minor_version > other.minor_version) - (self.minor_version < other.minor_version)
if c != 0:
return c
c = (self.major_build > other.major_build) - (self.major_build < other.major_build)
if c != 0:
return c
return (self.minor_build > other.minor_build) - (self.minor_build < other.minor_build)
def __eq__(self, other):
return self.__cmp__(other) == 0
def __hash__(self):
return hash(repr(self))
def __ne__(self, other):
return self.__cmp__(other) != 0
def __lt__(self, other):
return self.__cmp__(other) < 0
def __le__(self, other):
return self.__cmp__(other) <= 0
def __gt__(self, other):
return self.__cmp__(other) > 0
def __ge__(self, other):
return self.__cmp__(other) >= 0
def __str__(self):
return f"{self.major_version}.{self.minor_version}.{self.major_build}.{self.minor_build}"
def __repr__(self):
return self.__class__.__name__ + repr(
(self.major_version, self.minor_version, self.major_build, self.minor_build)
)</code></pre>
</details>
<div class="desc"><p>Holds methods for working with build numbers.</p></div>
<h3>Static methods</h3>
<dl>
<dt id="exchangelib.version.Build.from_xml"><code class="name flex">
<span>def <span class="ident">from_xml</span></span>(<span>elem)</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.version.Build.major_build"><code class="name">var <span class="ident">major_build</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Build:
"""Holds methods for working with build numbers."""
__slots__ = "major_version", "minor_version", "major_build", "minor_build"
def __init__(self, major_version, minor_version, major_build=0, minor_build=0):
if not isinstance(major_version, int):
raise InvalidTypeError("major_version", major_version, int)
if not isinstance(minor_version, int):
raise InvalidTypeError("minor_version", minor_version, int)
if not isinstance(major_build, int):
raise InvalidTypeError("major_build", major_build, int)
if not isinstance(minor_build, int):
raise InvalidTypeError("minor_build", minor_build, int)
self.major_version = major_version
self.minor_version = minor_version
self.major_build = major_build
self.minor_build = minor_build
@classmethod
def from_xml(cls, elem):
xml_elems_map = {
"major_version": "MajorVersion",
"minor_version": "MinorVersion",
"major_build": "MajorBuildNumber",
"minor_build": "MinorBuildNumber",
}
kwargs = {}
for k, xml_elem in xml_elems_map.items():
v = elem.get(xml_elem)
if v is None:
v = get_xml_attr(elem, f"{{{ANS}}}{xml_elem}")
if v is None:
raise ValueError()
kwargs[k] = int(v) # Also raises ValueError
return cls(**kwargs)
def api_version(self):
for build, api_version, _ in VERSIONS:
if self.major_version != build.major_version or self.minor_version != build.minor_version:
continue
if self >= build:
return api_version
raise ValueError(f"API version for build {self} is unknown")
def __cmp__(self, other):
# __cmp__ is not a magic method in Python3. We'll just use it here to implement comparison operators
c = (self.major_version > other.major_version) - (self.major_version < other.major_version)
if c != 0:
return c
c = (self.minor_version > other.minor_version) - (self.minor_version < other.minor_version)
if c != 0:
return c
c = (self.major_build > other.major_build) - (self.major_build < other.major_build)
if c != 0:
return c
return (self.minor_build > other.minor_build) - (self.minor_build < other.minor_build)
def __eq__(self, other):
return self.__cmp__(other) == 0
def __hash__(self):
return hash(repr(self))
def __ne__(self, other):
return self.__cmp__(other) != 0
def __lt__(self, other):
return self.__cmp__(other) < 0
def __le__(self, other):
return self.__cmp__(other) <= 0
def __gt__(self, other):
return self.__cmp__(other) > 0
def __ge__(self, other):
return self.__cmp__(other) >= 0
def __str__(self):
return f"{self.major_version}.{self.minor_version}.{self.major_build}.{self.minor_build}"
def __repr__(self):
return self.__class__.__name__ + repr(
(self.major_version, self.minor_version, self.major_build, self.minor_build)
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Build.major_version"><code class="name">var <span class="ident">major_version</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Build:
"""Holds methods for working with build numbers."""
__slots__ = "major_version", "minor_version", "major_build", "minor_build"
def __init__(self, major_version, minor_version, major_build=0, minor_build=0):
if not isinstance(major_version, int):
raise InvalidTypeError("major_version", major_version, int)
if not isinstance(minor_version, int):
raise InvalidTypeError("minor_version", minor_version, int)
if not isinstance(major_build, int):
raise InvalidTypeError("major_build", major_build, int)
if not isinstance(minor_build, int):
raise InvalidTypeError("minor_build", minor_build, int)
self.major_version = major_version
self.minor_version = minor_version
self.major_build = major_build
self.minor_build = minor_build
@classmethod
def from_xml(cls, elem):
xml_elems_map = {
"major_version": "MajorVersion",
"minor_version": "MinorVersion",
"major_build": "MajorBuildNumber",
"minor_build": "MinorBuildNumber",
}
kwargs = {}
for k, xml_elem in xml_elems_map.items():
v = elem.get(xml_elem)
if v is None:
v = get_xml_attr(elem, f"{{{ANS}}}{xml_elem}")
if v is None:
raise ValueError()
kwargs[k] = int(v) # Also raises ValueError
return cls(**kwargs)
def api_version(self):
for build, api_version, _ in VERSIONS:
if self.major_version != build.major_version or self.minor_version != build.minor_version:
continue
if self >= build:
return api_version
raise ValueError(f"API version for build {self} is unknown")
def __cmp__(self, other):
# __cmp__ is not a magic method in Python3. We'll just use it here to implement comparison operators
c = (self.major_version > other.major_version) - (self.major_version < other.major_version)
if c != 0:
return c
c = (self.minor_version > other.minor_version) - (self.minor_version < other.minor_version)
if c != 0:
return c
c = (self.major_build > other.major_build) - (self.major_build < other.major_build)
if c != 0:
return c
return (self.minor_build > other.minor_build) - (self.minor_build < other.minor_build)
def __eq__(self, other):
return self.__cmp__(other) == 0
def __hash__(self):
return hash(repr(self))
def __ne__(self, other):
return self.__cmp__(other) != 0
def __lt__(self, other):
return self.__cmp__(other) < 0
def __le__(self, other):
return self.__cmp__(other) <= 0
def __gt__(self, other):
return self.__cmp__(other) > 0
def __ge__(self, other):
return self.__cmp__(other) >= 0
def __str__(self):
return f"{self.major_version}.{self.minor_version}.{self.major_build}.{self.minor_build}"
def __repr__(self):
return self.__class__.__name__ + repr(
(self.major_version, self.minor_version, self.major_build, self.minor_build)
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Build.minor_build"><code class="name">var <span class="ident">minor_build</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Build:
"""Holds methods for working with build numbers."""
__slots__ = "major_version", "minor_version", "major_build", "minor_build"
def __init__(self, major_version, minor_version, major_build=0, minor_build=0):
if not isinstance(major_version, int):
raise InvalidTypeError("major_version", major_version, int)
if not isinstance(minor_version, int):
raise InvalidTypeError("minor_version", minor_version, int)
if not isinstance(major_build, int):
raise InvalidTypeError("major_build", major_build, int)
if not isinstance(minor_build, int):
raise InvalidTypeError("minor_build", minor_build, int)
self.major_version = major_version
self.minor_version = minor_version
self.major_build = major_build
self.minor_build = minor_build
@classmethod
def from_xml(cls, elem):
xml_elems_map = {
"major_version": "MajorVersion",
"minor_version": "MinorVersion",
"major_build": "MajorBuildNumber",
"minor_build": "MinorBuildNumber",
}
kwargs = {}
for k, xml_elem in xml_elems_map.items():
v = elem.get(xml_elem)
if v is None:
v = get_xml_attr(elem, f"{{{ANS}}}{xml_elem}")
if v is None:
raise ValueError()
kwargs[k] = int(v) # Also raises ValueError
return cls(**kwargs)
def api_version(self):
for build, api_version, _ in VERSIONS:
if self.major_version != build.major_version or self.minor_version != build.minor_version:
continue
if self >= build:
return api_version
raise ValueError(f"API version for build {self} is unknown")
def __cmp__(self, other):
# __cmp__ is not a magic method in Python3. We'll just use it here to implement comparison operators
c = (self.major_version > other.major_version) - (self.major_version < other.major_version)
if c != 0:
return c
c = (self.minor_version > other.minor_version) - (self.minor_version < other.minor_version)
if c != 0:
return c
c = (self.major_build > other.major_build) - (self.major_build < other.major_build)
if c != 0:
return c
return (self.minor_build > other.minor_build) - (self.minor_build < other.minor_build)
def __eq__(self, other):
return self.__cmp__(other) == 0
def __hash__(self):
return hash(repr(self))
def __ne__(self, other):
return self.__cmp__(other) != 0
def __lt__(self, other):
return self.__cmp__(other) < 0
def __le__(self, other):
return self.__cmp__(other) <= 0
def __gt__(self, other):
return self.__cmp__(other) > 0
def __ge__(self, other):
return self.__cmp__(other) >= 0
def __str__(self):
return f"{self.major_version}.{self.minor_version}.{self.major_build}.{self.minor_build}"
def __repr__(self):
return self.__class__.__name__ + repr(
(self.major_version, self.minor_version, self.major_build, self.minor_build)
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Build.minor_version"><code class="name">var <span class="ident">minor_version</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Build:
"""Holds methods for working with build numbers."""
__slots__ = "major_version", "minor_version", "major_build", "minor_build"
def __init__(self, major_version, minor_version, major_build=0, minor_build=0):
if not isinstance(major_version, int):
raise InvalidTypeError("major_version", major_version, int)
if not isinstance(minor_version, int):
raise InvalidTypeError("minor_version", minor_version, int)
if not isinstance(major_build, int):
raise InvalidTypeError("major_build", major_build, int)
if not isinstance(minor_build, int):
raise InvalidTypeError("minor_build", minor_build, int)
self.major_version = major_version
self.minor_version = minor_version
self.major_build = major_build
self.minor_build = minor_build
@classmethod
def from_xml(cls, elem):
xml_elems_map = {
"major_version": "MajorVersion",
"minor_version": "MinorVersion",
"major_build": "MajorBuildNumber",
"minor_build": "MinorBuildNumber",
}
kwargs = {}
for k, xml_elem in xml_elems_map.items():
v = elem.get(xml_elem)
if v is None:
v = get_xml_attr(elem, f"{{{ANS}}}{xml_elem}")
if v is None:
raise ValueError()
kwargs[k] = int(v) # Also raises ValueError
return cls(**kwargs)
def api_version(self):
for build, api_version, _ in VERSIONS:
if self.major_version != build.major_version or self.minor_version != build.minor_version:
continue
if self >= build:
return api_version
raise ValueError(f"API version for build {self} is unknown")
def __cmp__(self, other):
# __cmp__ is not a magic method in Python3. We'll just use it here to implement comparison operators
c = (self.major_version > other.major_version) - (self.major_version < other.major_version)
if c != 0:
return c
c = (self.minor_version > other.minor_version) - (self.minor_version < other.minor_version)
if c != 0:
return c
c = (self.major_build > other.major_build) - (self.major_build < other.major_build)
if c != 0:
return c
return (self.minor_build > other.minor_build) - (self.minor_build < other.minor_build)
def __eq__(self, other):
return self.__cmp__(other) == 0
def __hash__(self):
return hash(repr(self))
def __ne__(self, other):
return self.__cmp__(other) != 0
def __lt__(self, other):
return self.__cmp__(other) < 0
def __le__(self, other):
return self.__cmp__(other) <= 0
def __gt__(self, other):
return self.__cmp__(other) > 0
def __ge__(self, other):
return self.__cmp__(other) >= 0
def __str__(self):
return f"{self.major_version}.{self.minor_version}.{self.major_build}.{self.minor_build}"
def __repr__(self):
return self.__class__.__name__ + repr(
(self.major_version, self.minor_version, self.major_build, self.minor_build)
)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="exchangelib.version.Build.api_version"><code class="name flex">
<span>def <span class="ident">api_version</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def api_version(self):
for build, api_version, _ in VERSIONS:
if self.major_version != build.major_version or self.minor_version != build.minor_version:
continue
if self >= build:
return api_version
raise ValueError(f"API version for build {self} is unknown")</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</dd>
<dt id="exchangelib.version.SupportedVersionClassMixIn"><code class="flex name class">
<span>class <span class="ident">SupportedVersionClassMixIn</span></span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class SupportedVersionClassMixIn:
"""Supports specifying the supported versions of services, fields, folders etc.
For distinguished folders, a possibly authoritative source is:
# https://github.com/OfficeDev/ews-managed-api/blob/master/Enumerations/WellKnownFolderName.cs
"""
supported_from = None # The Exchange build when this element was introduced
deprecated_from = None # The Exchange build when this element was deprecated
@classmethod
def __new__(cls, *args, **kwargs):
_check(cls.supported_from, cls.deprecated_from)
return super().__new__(cls)
@classmethod
def supports_version(cls, version):
return _supports_version(cls.supported_from, cls.deprecated_from, version)</code></pre>
</details>
<div class="desc"><p>Supports specifying the supported versions of services, fields, folders etc.</p>
<p>For distinguished folders, a possibly authoritative source is:</p>
<h1 id="httpsgithubcomofficedevews-managed-apiblobmasterenumerationswellknownfoldernamecs"><a href="https://github.com/OfficeDev/ews-managed-api/blob/master/Enumerations/WellKnownFolderName.cs">https://github.com/OfficeDev/ews-managed-api/blob/master/Enumerations/WellKnownFolderName.cs</a></h1></div>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="exchangelib.folders.base.BaseFolder" href="folders/base.html#exchangelib.folders.base.BaseFolder">BaseFolder</a></li>
<li><a title="exchangelib.services.common.EWSService" href="services/common.html#exchangelib.services.common.EWSService">EWSService</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="exchangelib.version.SupportedVersionClassMixIn.deprecated_from"><code class="name">var <span class="ident">deprecated_from</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.version.SupportedVersionClassMixIn.supported_from"><code class="name">var <span class="ident">supported_from</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Static methods</h3>
<dl>
<dt id="exchangelib.version.SupportedVersionClassMixIn.supports_version"><code class="name flex">
<span>def <span class="ident">supports_version</span></span>(<span>version)</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</dd>
<dt id="exchangelib.version.SupportedVersionInstanceMixIn"><code class="flex name class">
<span>class <span class="ident">SupportedVersionInstanceMixIn</span></span>
<span>(</span><span>supported_from=None, deprecated_from=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class SupportedVersionInstanceMixIn:
"""Like SupportedVersionClassMixIn but for class instances"""
def __init__(self, supported_from=None, deprecated_from=None):
_check(supported_from, deprecated_from)
self.supported_from = supported_from
self.deprecated_from = deprecated_from
def supports_version(self, version):
return _supports_version(self.supported_from, self.deprecated_from, version)</code></pre>
</details>
<div class="desc"><p>Like SupportedVersionClassMixIn but for class instances</p></div>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="exchangelib.fields.Choice" href="fields.html#exchangelib.fields.Choice">Choice</a></li>
<li><a title="exchangelib.fields.Field" href="fields.html#exchangelib.fields.Field">Field</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="exchangelib.version.SupportedVersionInstanceMixIn.supports_version"><code class="name flex">
<span>def <span class="ident">supports_version</span></span>(<span>self, version)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def supports_version(self, version):
return _supports_version(self.supported_from, self.deprecated_from, version)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</dd>
<dt id="exchangelib.version.Version"><code class="flex name class">
<span>class <span class="ident">Version</span></span>
<span>(</span><span>build, api_version=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Version:
"""Holds information about the server version."""
__slots__ = "build", "api_version"
def __init__(self, build, api_version=None):
if api_version is None:
if not isinstance(build, Build):
raise InvalidTypeError("build", build, Build)
self.api_version = build.api_version()
else:
if not isinstance(build, (Build, type(None))):
raise InvalidTypeError("build", build, Build)
if not isinstance(api_version, str):
raise InvalidTypeError("api_version", api_version, str)
self.api_version = api_version
self.build = build
@property
def fullname(self):
for build, api_version, full_name in VERSIONS:
if self.build and (
self.build.major_version != build.major_version or self.build.minor_version != build.minor_version
):
continue
if self.api_version == api_version:
return full_name
log.warning("Full name for API version %s build %s is unknown", self.api_version, self.build)
return "UNKNOWN"
@classmethod
def guess(cls, protocol, api_version_hint=None):
"""Ask the server which version it has. We haven't set up an Account object yet, so we generate requests
by hand. We only need a response header containing a ServerVersionInfo element.
To get API version and build numbers from the server, we need to send a valid SOAP request. We can't do that
without a valid API version. To solve this chicken-and-egg problem, we try all possible API versions that this
package supports, until we get a valid response.
:param protocol:
:param api_version_hint: (Default value = None)
"""
from .properties import ENTRY_ID, EWS_ID, AlternateId
from .services import ConvertId
# The protocol doesn't have a version yet, so default to the latest supported version if we don't have a hint.
api_version = api_version_hint or ConvertId.supported_api_versions()[0]
log.debug("Asking server for version info using API version %s", api_version)
# We don't know the build version yet. Hopefully, the server will report it in the SOAP header. Lots of
# places expect a version to have a build, so this is a bit dangerous, but passing a fake build around is also
# dangerous.
protocol.config.version = Version(build=None, api_version=api_version)
# Use ConvertId as a minimal request to the server to test if the version is correct. If not, ConvertId will
# try to guess the version automatically. Make sure the call to ConvertId does not require a version build.
try:
list(ConvertId(protocol=protocol).call([AlternateId(id="DUMMY", format=EWS_ID, mailbox="DUMMY")], ENTRY_ID))
except ResponseMessageError as e:
# We may have survived long enough to get a new version
if not protocol.config.version.build:
raise TransportError(f"No valid version headers found in response ({e!r})")
if not protocol.config.version.build:
raise TransportError("No valid version headers found in response")
return protocol.config.version
@staticmethod
def _is_invalid_version_string(version):
# Check if a version string is bogus, e.g. V2_, V2015_ or V2018_
return re.match(r"V[0-9]{1,4}_.*", version)
@classmethod
def from_soap_header(cls, requested_api_version, header):
info = header.find(f"{{{TNS}}}ServerVersionInfo")
if info is None:
info = header.find(f"{{{ANS}}}ServerVersionInfo")
if info is None:
raise TransportError(f"No ServerVersionInfo in header: {xml_to_str(header)!r}")
try:
build = Build.from_xml(elem=info)
except ValueError:
raise TransportError(f"Bad ServerVersionInfo in response: {xml_to_str(header)!r}")
# Not all Exchange servers send the Version element
api_version_from_server = info.get("Version") or get_xml_attr(info, f"{{{ANS}}}Version") or build.api_version()
if api_version_from_server != requested_api_version:
if cls._is_invalid_version_string(api_version_from_server):
# For unknown reasons, Office 365 may respond with an API version strings that is invalid in a request.
# Detect these, so we can fall back to a valid version string.
log.debug(
'API version "%s" worked but server reports version "%s". Using "%s"',
requested_api_version,
api_version_from_server,
requested_api_version,
)
api_version_from_server = requested_api_version
else:
# Trust API version from server response
log.debug(
'API version "%s" worked but server reports version "%s". Using "%s"',
requested_api_version,
api_version_from_server,
api_version_from_server,
)
return cls(build=build, api_version=api_version_from_server)
def copy(self):
return self.__class__(build=self.build, api_version=self.api_version)
@classmethod
def all_versions(cls):
# Return all supported versions, sorted newest to oldest
return [cls(build=build, api_version=api_version) for build, api_version, _ in VERSIONS]
def __hash__(self):
return hash((self.build, self.api_version))
def __eq__(self, other):
if self.api_version != other.api_version:
return False
if self.build and not other.build:
return False
if other.build and not self.build:
return False
return self.build == other.build
def __repr__(self):
return self.__class__.__name__ + repr((self.build, self.api_version))
def __str__(self):
return f"Build={self.build}, API={self.api_version}, Fullname={self.fullname}"</code></pre>
</details>
<div class="desc"><p>Holds information about the server version.</p></div>
<h3>Static methods</h3>
<dl>
<dt id="exchangelib.version.Version.all_versions"><code class="name flex">
<span>def <span class="ident">all_versions</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Version.from_soap_header"><code class="name flex">
<span>def <span class="ident">from_soap_header</span></span>(<span>requested_api_version, header)</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Version.guess"><code class="name flex">
<span>def <span class="ident">guess</span></span>(<span>protocol, api_version_hint=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Ask the server which version it has. We haven't set up an Account object yet, so we generate requests
by hand. We only need a response header containing a ServerVersionInfo element.</p>
<p>To get API version and build numbers from the server, we need to send a valid SOAP request. We can't do that
without a valid API version. To solve this chicken-and-egg problem, we try all possible API versions that this
package supports, until we get a valid response.</p>
<p>:param protocol:
:param api_version_hint:
(Default value = None)</p></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.version.Version.api_version"><code class="name">var <span class="ident">api_version</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Version:
"""Holds information about the server version."""
__slots__ = "build", "api_version"
def __init__(self, build, api_version=None):
if api_version is None:
if not isinstance(build, Build):
raise InvalidTypeError("build", build, Build)
self.api_version = build.api_version()
else:
if not isinstance(build, (Build, type(None))):
raise InvalidTypeError("build", build, Build)
if not isinstance(api_version, str):
raise InvalidTypeError("api_version", api_version, str)
self.api_version = api_version
self.build = build
@property
def fullname(self):
for build, api_version, full_name in VERSIONS:
if self.build and (
self.build.major_version != build.major_version or self.build.minor_version != build.minor_version
):
continue
if self.api_version == api_version:
return full_name
log.warning("Full name for API version %s build %s is unknown", self.api_version, self.build)
return "UNKNOWN"
@classmethod
def guess(cls, protocol, api_version_hint=None):
"""Ask the server which version it has. We haven't set up an Account object yet, so we generate requests
by hand. We only need a response header containing a ServerVersionInfo element.
To get API version and build numbers from the server, we need to send a valid SOAP request. We can't do that
without a valid API version. To solve this chicken-and-egg problem, we try all possible API versions that this
package supports, until we get a valid response.
:param protocol:
:param api_version_hint: (Default value = None)
"""
from .properties import ENTRY_ID, EWS_ID, AlternateId
from .services import ConvertId
# The protocol doesn't have a version yet, so default to the latest supported version if we don't have a hint.
api_version = api_version_hint or ConvertId.supported_api_versions()[0]
log.debug("Asking server for version info using API version %s", api_version)
# We don't know the build version yet. Hopefully, the server will report it in the SOAP header. Lots of
# places expect a version to have a build, so this is a bit dangerous, but passing a fake build around is also
# dangerous.
protocol.config.version = Version(build=None, api_version=api_version)
# Use ConvertId as a minimal request to the server to test if the version is correct. If not, ConvertId will
# try to guess the version automatically. Make sure the call to ConvertId does not require a version build.
try:
list(ConvertId(protocol=protocol).call([AlternateId(id="DUMMY", format=EWS_ID, mailbox="DUMMY")], ENTRY_ID))
except ResponseMessageError as e:
# We may have survived long enough to get a new version
if not protocol.config.version.build:
raise TransportError(f"No valid version headers found in response ({e!r})")
if not protocol.config.version.build:
raise TransportError("No valid version headers found in response")
return protocol.config.version
@staticmethod
def _is_invalid_version_string(version):
# Check if a version string is bogus, e.g. V2_, V2015_ or V2018_
return re.match(r"V[0-9]{1,4}_.*", version)
@classmethod
def from_soap_header(cls, requested_api_version, header):
info = header.find(f"{{{TNS}}}ServerVersionInfo")
if info is None:
info = header.find(f"{{{ANS}}}ServerVersionInfo")
if info is None:
raise TransportError(f"No ServerVersionInfo in header: {xml_to_str(header)!r}")
try:
build = Build.from_xml(elem=info)
except ValueError:
raise TransportError(f"Bad ServerVersionInfo in response: {xml_to_str(header)!r}")
# Not all Exchange servers send the Version element
api_version_from_server = info.get("Version") or get_xml_attr(info, f"{{{ANS}}}Version") or build.api_version()
if api_version_from_server != requested_api_version:
if cls._is_invalid_version_string(api_version_from_server):
# For unknown reasons, Office 365 may respond with an API version strings that is invalid in a request.
# Detect these, so we can fall back to a valid version string.
log.debug(
'API version "%s" worked but server reports version "%s". Using "%s"',
requested_api_version,
api_version_from_server,
requested_api_version,
)
api_version_from_server = requested_api_version
else:
# Trust API version from server response
log.debug(
'API version "%s" worked but server reports version "%s". Using "%s"',
requested_api_version,
api_version_from_server,
api_version_from_server,
)
return cls(build=build, api_version=api_version_from_server)
def copy(self):
return self.__class__(build=self.build, api_version=self.api_version)
@classmethod
def all_versions(cls):
# Return all supported versions, sorted newest to oldest
return [cls(build=build, api_version=api_version) for build, api_version, _ in VERSIONS]
def __hash__(self):
return hash((self.build, self.api_version))
def __eq__(self, other):
if self.api_version != other.api_version:
return False
if self.build and not other.build:
return False
if other.build and not self.build:
return False
return self.build == other.build
def __repr__(self):
return self.__class__.__name__ + repr((self.build, self.api_version))
def __str__(self):
return f"Build={self.build}, API={self.api_version}, Fullname={self.fullname}"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Version.build"><code class="name">var <span class="ident">build</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Version:
"""Holds information about the server version."""
__slots__ = "build", "api_version"
def __init__(self, build, api_version=None):
if api_version is None:
if not isinstance(build, Build):
raise InvalidTypeError("build", build, Build)
self.api_version = build.api_version()
else:
if not isinstance(build, (Build, type(None))):
raise InvalidTypeError("build", build, Build)
if not isinstance(api_version, str):
raise InvalidTypeError("api_version", api_version, str)
self.api_version = api_version
self.build = build
@property
def fullname(self):
for build, api_version, full_name in VERSIONS:
if self.build and (
self.build.major_version != build.major_version or self.build.minor_version != build.minor_version
):
continue
if self.api_version == api_version:
return full_name
log.warning("Full name for API version %s build %s is unknown", self.api_version, self.build)
return "UNKNOWN"
@classmethod
def guess(cls, protocol, api_version_hint=None):
"""Ask the server which version it has. We haven't set up an Account object yet, so we generate requests
by hand. We only need a response header containing a ServerVersionInfo element.
To get API version and build numbers from the server, we need to send a valid SOAP request. We can't do that
without a valid API version. To solve this chicken-and-egg problem, we try all possible API versions that this
package supports, until we get a valid response.
:param protocol:
:param api_version_hint: (Default value = None)
"""
from .properties import ENTRY_ID, EWS_ID, AlternateId
from .services import ConvertId
# The protocol doesn't have a version yet, so default to the latest supported version if we don't have a hint.
api_version = api_version_hint or ConvertId.supported_api_versions()[0]
log.debug("Asking server for version info using API version %s", api_version)
# We don't know the build version yet. Hopefully, the server will report it in the SOAP header. Lots of
# places expect a version to have a build, so this is a bit dangerous, but passing a fake build around is also
# dangerous.
protocol.config.version = Version(build=None, api_version=api_version)
# Use ConvertId as a minimal request to the server to test if the version is correct. If not, ConvertId will
# try to guess the version automatically. Make sure the call to ConvertId does not require a version build.
try:
list(ConvertId(protocol=protocol).call([AlternateId(id="DUMMY", format=EWS_ID, mailbox="DUMMY")], ENTRY_ID))
except ResponseMessageError as e:
# We may have survived long enough to get a new version
if not protocol.config.version.build:
raise TransportError(f"No valid version headers found in response ({e!r})")
if not protocol.config.version.build:
raise TransportError("No valid version headers found in response")
return protocol.config.version
@staticmethod
def _is_invalid_version_string(version):
# Check if a version string is bogus, e.g. V2_, V2015_ or V2018_
return re.match(r"V[0-9]{1,4}_.*", version)
@classmethod
def from_soap_header(cls, requested_api_version, header):
info = header.find(f"{{{TNS}}}ServerVersionInfo")
if info is None:
info = header.find(f"{{{ANS}}}ServerVersionInfo")
if info is None:
raise TransportError(f"No ServerVersionInfo in header: {xml_to_str(header)!r}")
try:
build = Build.from_xml(elem=info)
except ValueError:
raise TransportError(f"Bad ServerVersionInfo in response: {xml_to_str(header)!r}")
# Not all Exchange servers send the Version element
api_version_from_server = info.get("Version") or get_xml_attr(info, f"{{{ANS}}}Version") or build.api_version()
if api_version_from_server != requested_api_version:
if cls._is_invalid_version_string(api_version_from_server):
# For unknown reasons, Office 365 may respond with an API version strings that is invalid in a request.
# Detect these, so we can fall back to a valid version string.
log.debug(
'API version "%s" worked but server reports version "%s". Using "%s"',
requested_api_version,
api_version_from_server,
requested_api_version,
)
api_version_from_server = requested_api_version
else:
# Trust API version from server response
log.debug(
'API version "%s" worked but server reports version "%s". Using "%s"',
requested_api_version,
api_version_from_server,
api_version_from_server,
)
return cls(build=build, api_version=api_version_from_server)
def copy(self):
return self.__class__(build=self.build, api_version=self.api_version)
@classmethod
def all_versions(cls):
# Return all supported versions, sorted newest to oldest
return [cls(build=build, api_version=api_version) for build, api_version, _ in VERSIONS]
def __hash__(self):
return hash((self.build, self.api_version))
def __eq__(self, other):
if self.api_version != other.api_version:
return False
if self.build and not other.build:
return False
if other.build and not self.build:
return False
return self.build == other.build
def __repr__(self):
return self.__class__.__name__ + repr((self.build, self.api_version))
def __str__(self):
return f"Build={self.build}, API={self.api_version}, Fullname={self.fullname}"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.version.Version.fullname"><code class="name">prop <span class="ident">fullname</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def fullname(self):
for build, api_version, full_name in VERSIONS:
if self.build and (
self.build.major_version != build.major_version or self.build.minor_version != build.minor_version
):
continue
if self.api_version == api_version:
return full_name
log.warning("Full name for API version %s build %s is unknown", self.api_version, self.build)
return "UNKNOWN"</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="exchangelib.version.Version.copy"><code class="name flex">
<span>def <span class="ident">copy</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def copy(self):
return self.__class__(build=self.build, api_version=self.api_version)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</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" href="index.html">exchangelib</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="exchangelib.version.Build" href="#exchangelib.version.Build">Build</a></code></h4>
<ul class="two-column">
<li><code><a title="exchangelib.version.Build.api_version" href="#exchangelib.version.Build.api_version">api_version</a></code></li>
<li><code><a title="exchangelib.version.Build.from_xml" href="#exchangelib.version.Build.from_xml">from_xml</a></code></li>
<li><code><a title="exchangelib.version.Build.major_build" href="#exchangelib.version.Build.major_build">major_build</a></code></li>
<li><code><a title="exchangelib.version.Build.major_version" href="#exchangelib.version.Build.major_version">major_version</a></code></li>
<li><code><a title="exchangelib.version.Build.minor_build" href="#exchangelib.version.Build.minor_build">minor_build</a></code></li>
<li><code><a title="exchangelib.version.Build.minor_version" href="#exchangelib.version.Build.minor_version">minor_version</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="exchangelib.version.SupportedVersionClassMixIn" href="#exchangelib.version.SupportedVersionClassMixIn">SupportedVersionClassMixIn</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.version.SupportedVersionClassMixIn.deprecated_from" href="#exchangelib.version.SupportedVersionClassMixIn.deprecated_from">deprecated_from</a></code></li>
<li><code><a title="exchangelib.version.SupportedVersionClassMixIn.supported_from" href="#exchangelib.version.SupportedVersionClassMixIn.supported_from">supported_from</a></code></li>
<li><code><a title="exchangelib.version.SupportedVersionClassMixIn.supports_version" href="#exchangelib.version.SupportedVersionClassMixIn.supports_version">supports_version</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="exchangelib.version.SupportedVersionInstanceMixIn" href="#exchangelib.version.SupportedVersionInstanceMixIn">SupportedVersionInstanceMixIn</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.version.SupportedVersionInstanceMixIn.supports_version" href="#exchangelib.version.SupportedVersionInstanceMixIn.supports_version">supports_version</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="exchangelib.version.Version" href="#exchangelib.version.Version">Version</a></code></h4>
<ul class="two-column">
<li><code><a title="exchangelib.version.Version.all_versions" href="#exchangelib.version.Version.all_versions">all_versions</a></code></li>
<li><code><a title="exchangelib.version.Version.api_version" href="#exchangelib.version.Version.api_version">api_version</a></code></li>
<li><code><a title="exchangelib.version.Version.build" href="#exchangelib.version.Version.build">build</a></code></li>
<li><code><a title="exchangelib.version.Version.copy" href="#exchangelib.version.Version.copy">copy</a></code></li>
<li><code><a title="exchangelib.version.Version.from_soap_header" href="#exchangelib.version.Version.from_soap_header">from_soap_header</a></code></li>
<li><code><a title="exchangelib.version.Version.fullname" href="#exchangelib.version.Version.fullname">fullname</a></code></li>
<li><code><a title="exchangelib.version.Version.guess" href="#exchangelib.version.Version.guess">guess</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>
|