File: settings.html

package info (click to toggle)
python-exchangelib 5.6.0-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 13,364 kB
sloc: python: 25,367; sh: 6; makefile: 5
file content (323 lines) | stat: -rw-r--r-- 20,684 bytes
<!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.settings 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.settings</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.settings.OofSettings"><code class="flex name class">
<span>class <span class="ident">OofSettings</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 OofSettings(EWSElement):
    &#34;&#34;&#34;MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/oofsettings&#34;&#34;&#34;

    ELEMENT_NAME = &#34;OofSettings&#34;
    REQUEST_ELEMENT_NAME = &#34;UserOofSettings&#34;

    ENABLED = &#34;Enabled&#34;
    SCHEDULED = &#34;Scheduled&#34;
    DISABLED = &#34;Disabled&#34;
    STATE_CHOICES = (ENABLED, SCHEDULED, DISABLED)

    state = ChoiceField(field_uri=&#34;OofState&#34;, is_required=True, choices={Choice(c) for c in STATE_CHOICES})
    external_audience = ChoiceField(
        field_uri=&#34;ExternalAudience&#34;, choices={Choice(&#34;None&#34;), Choice(&#34;Known&#34;), Choice(&#34;All&#34;)}, default=&#34;All&#34;
    )
    start = DateTimeField(field_uri=&#34;StartTime&#34;)
    end = DateTimeField(field_uri=&#34;EndTime&#34;)
    internal_reply = MessageField(field_uri=&#34;InternalReply&#34;)
    external_reply = MessageField(field_uri=&#34;ExternalReply&#34;)

    def clean(self, version=None):
        super().clean(version=version)
        if self.state == self.SCHEDULED:
            if not self.start or not self.end:
                raise ValueError(f&#34;&#39;start&#39; and &#39;end&#39; must be set when state is {self.SCHEDULED!r}&#34;)
            if self.start &gt;= self.end:
                raise ValueError(&#34;&#39;start&#39; must be before &#39;end&#39;&#34;)
            if self.end &lt; datetime.datetime.now(tz=UTC):
                raise ValueError(&#34;&#39;end&#39; must be in the future&#34;)
            # Some servers only like UTC timestamps
            self.start = self.start.astimezone(UTC)
            self.end = self.end.astimezone(UTC)
        if self.state != self.DISABLED and (not self.internal_reply or not self.external_reply):
            raise ValueError(f&#34;&#39;internal_reply&#39; and &#39;external_reply&#39; must be set when state is not {self.DISABLED!r}&#34;)

    @classmethod
    def from_xml(cls, elem, account):
        kwargs = {}
        for attr in (&#34;state&#34;, &#34;external_audience&#34;, &#34;internal_reply&#34;, &#34;external_reply&#34;):
            f = cls.get_field_by_fieldname(attr)
            kwargs[attr] = f.from_xml(elem=elem, account=account)
        kwargs.update(OutOfOffice.duration_to_start_end(elem=elem, account=account))
        cls._clear(elem)
        return cls(**kwargs)

    def to_xml(self, version):
        self.clean(version=version)
        elem = create_element(f&#34;t:{self.REQUEST_ELEMENT_NAME}&#34;)
        for attr in (&#34;state&#34;, &#34;external_audience&#34;):
            value = getattr(self, attr)
            f = self.get_field_by_fieldname(attr)
            set_xml_value(elem, f.to_xml(value, version=version))
        if self.start or self.end:
            duration = create_element(&#34;t:Duration&#34;)
            if self.start:
                f = self.get_field_by_fieldname(&#34;start&#34;)
                set_xml_value(duration, f.to_xml(self.start, version=version))
            if self.end:
                f = self.get_field_by_fieldname(&#34;end&#34;)
                set_xml_value(duration, f.to_xml(self.end, version=version))
            elem.append(duration)
        for attr in (&#34;internal_reply&#34;, &#34;external_reply&#34;):
            value = getattr(self, attr)
            if value is None:
                value = &#34;&#34;  # The value can be empty, but the XML element must always be present
            f = self.get_field_by_fieldname(attr)
            set_xml_value(elem, f.to_xml(value, version=version))
        return elem

    def __hash__(self):
        # Customize comparison
        if self.state == self.DISABLED:
            # All values except state are ignored by the server
            relevant_attrs = (&#34;state&#34;,)
        elif self.state != self.SCHEDULED:
            # &#39;start&#39; and &#39;end&#39; values are ignored by the server, and the server always returns today&#39;s date
            relevant_attrs = tuple(f.name for f in self.FIELDS if f.name not in (&#34;start&#34;, &#34;end&#34;))
        else:
            relevant_attrs = tuple(f.name for f in self.FIELDS)
        return hash(tuple(getattr(self, attr) for attr in relevant_attrs))</code></pre>
</details>
<div class="desc"><p>MSDN: <a href="https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/oofsettings">https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/oofsettings</a></p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.properties.EWSElement" href="properties.html#exchangelib.properties.EWSElement">EWSElement</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="exchangelib.settings.OofSettings.DISABLED"><code class="name">var <span class="ident">DISABLED</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.ENABLED"><code class="name">var <span class="ident">ENABLED</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.REQUEST_ELEMENT_NAME"><code class="name">var <span class="ident">REQUEST_ELEMENT_NAME</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.SCHEDULED"><code class="name">var <span class="ident">SCHEDULED</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.STATE_CHOICES"><code class="name">var <span class="ident">STATE_CHOICES</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.settings.OofSettings.from_xml"><code class="name flex">
<span>def <span class="ident">from_xml</span></span>(<span>elem, account)</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.settings.OofSettings.end"><code class="name">var <span class="ident">end</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.external_audience"><code class="name">var <span class="ident">external_audience</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.external_reply"><code class="name">var <span class="ident">external_reply</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.internal_reply"><code class="name">var <span class="ident">internal_reply</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.start"><code class="name">var <span class="ident">start</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="exchangelib.settings.OofSettings.state"><code class="name">var <span class="ident">state</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.settings.OofSettings.clean"><code class="name flex">
<span>def <span class="ident">clean</span></span>(<span>self, version=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def clean(self, version=None):
    super().clean(version=version)
    if self.state == self.SCHEDULED:
        if not self.start or not self.end:
            raise ValueError(f&#34;&#39;start&#39; and &#39;end&#39; must be set when state is {self.SCHEDULED!r}&#34;)
        if self.start &gt;= self.end:
            raise ValueError(&#34;&#39;start&#39; must be before &#39;end&#39;&#34;)
        if self.end &lt; datetime.datetime.now(tz=UTC):
            raise ValueError(&#34;&#39;end&#39; must be in the future&#34;)
        # Some servers only like UTC timestamps
        self.start = self.start.astimezone(UTC)
        self.end = self.end.astimezone(UTC)
    if self.state != self.DISABLED and (not self.internal_reply or not self.external_reply):
        raise ValueError(f&#34;&#39;internal_reply&#39; and &#39;external_reply&#39; must be set when state is not {self.DISABLED!r}&#34;)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.settings.OofSettings.to_xml"><code class="name flex">
<span>def <span class="ident">to_xml</span></span>(<span>self, version)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def to_xml(self, version):
    self.clean(version=version)
    elem = create_element(f&#34;t:{self.REQUEST_ELEMENT_NAME}&#34;)
    for attr in (&#34;state&#34;, &#34;external_audience&#34;):
        value = getattr(self, attr)
        f = self.get_field_by_fieldname(attr)
        set_xml_value(elem, f.to_xml(value, version=version))
    if self.start or self.end:
        duration = create_element(&#34;t:Duration&#34;)
        if self.start:
            f = self.get_field_by_fieldname(&#34;start&#34;)
            set_xml_value(duration, f.to_xml(self.start, version=version))
        if self.end:
            f = self.get_field_by_fieldname(&#34;end&#34;)
            set_xml_value(duration, f.to_xml(self.end, version=version))
        elem.append(duration)
    for attr in (&#34;internal_reply&#34;, &#34;external_reply&#34;):
        value = getattr(self, attr)
        if value is None:
            value = &#34;&#34;  # The value can be empty, but the XML element must always be present
        f = self.get_field_by_fieldname(attr)
        set_xml_value(elem, f.to_xml(value, version=version))
    return elem</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.properties.EWSElement" href="properties.html#exchangelib.properties.EWSElement">EWSElement</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.properties.EWSElement.ELEMENT_NAME" href="properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.properties.EWSElement.FIELDS" href="properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.properties.EWSElement.NAMESPACE" href="properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.properties.EWSElement.add_field" href="properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.properties.EWSElement.remove_field" href="properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.properties.EWSElement.supported_fields" href="properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.properties.EWSElement.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" 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.settings.OofSettings" href="#exchangelib.settings.OofSettings">OofSettings</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.settings.OofSettings.DISABLED" href="#exchangelib.settings.OofSettings.DISABLED">DISABLED</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.ENABLED" href="#exchangelib.settings.OofSettings.ENABLED">ENABLED</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.REQUEST_ELEMENT_NAME" href="#exchangelib.settings.OofSettings.REQUEST_ELEMENT_NAME">REQUEST_ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.SCHEDULED" href="#exchangelib.settings.OofSettings.SCHEDULED">SCHEDULED</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.STATE_CHOICES" href="#exchangelib.settings.OofSettings.STATE_CHOICES">STATE_CHOICES</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.clean" href="#exchangelib.settings.OofSettings.clean">clean</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.end" href="#exchangelib.settings.OofSettings.end">end</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.external_audience" href="#exchangelib.settings.OofSettings.external_audience">external_audience</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.external_reply" href="#exchangelib.settings.OofSettings.external_reply">external_reply</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.from_xml" href="#exchangelib.settings.OofSettings.from_xml">from_xml</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.internal_reply" href="#exchangelib.settings.OofSettings.internal_reply">internal_reply</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.start" href="#exchangelib.settings.OofSettings.start">start</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.state" href="#exchangelib.settings.OofSettings.state">state</a></code></li>
<li><code><a title="exchangelib.settings.OofSettings.to_xml" href="#exchangelib.settings.OofSettings.to_xml">to_xml</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>