File: roots.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 (1041 lines) | stat: -rw-r--r-- 79,666 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.folders.roots 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.folders.roots</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.folders.roots.ArchiveRoot"><code class="flex name class">
<span>class <span class="ident">ArchiveRoot</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 ArchiveRoot(RootOfHierarchy):
    &#34;&#34;&#34;The root of the archive folders hierarchy. Not available on all mailboxes.&#34;&#34;&#34;

    DISTINGUISHED_FOLDER_ID = &#34;archiveroot&#34;
    supported_from = EXCHANGE_2010_SP1
    WELLKNOWN_FOLDERS = WELLKNOWN_FOLDERS_IN_ARCHIVE_ROOT</code></pre>
</details>
<div class="desc"><p>The root of the archive folders hierarchy. Not available on all mailboxes.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></li>
<li><a title="exchangelib.folders.base.BaseFolder" href="base.html#exchangelib.folders.base.BaseFolder">BaseFolder</a></li>
<li><a title="exchangelib.items.base.RegisterMixIn" href="../items/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>
<li><a title="exchangelib.queryset.SearchableMixIn" href="../queryset.html#exchangelib.queryset.SearchableMixIn">SearchableMixIn</a></li>
<li><a title="exchangelib.version.SupportedVersionClassMixIn" href="../version.html#exchangelib.version.SupportedVersionClassMixIn">SupportedVersionClassMixIn</a></li>
</ul>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.CONTAINER_CLASS" href="base.html#exchangelib.folders.base.BaseFolder.CONTAINER_CLASS">CONTAINER_CLASS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DEFAULT_FOLDER_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_FOLDER_TRAVERSAL_DEPTH">DEFAULT_FOLDER_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DEFAULT_ITEM_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_ITEM_TRAVERSAL_DEPTH">DEFAULT_ITEM_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DISTINGUISHED_FOLDER_ID" href="base.html#exchangelib.folders.base.BaseFolder.DISTINGUISHED_FOLDER_ID">DISTINGUISHED_FOLDER_ID</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ID_ELEMENT_CLS" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn.ID_ELEMENT_CLS">ID_ELEMENT_CLS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.INSERT_AFTER_FIELD" href="../items/base.html#exchangelib.items.base.RegisterMixIn.INSERT_AFTER_FIELD">INSERT_AFTER_FIELD</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ITEM_MODEL_MAP" href="base.html#exchangelib.folders.base.BaseFolder.ITEM_MODEL_MAP">ITEM_MODEL_MAP</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.LOCALIZED_NAMES" href="base.html#exchangelib.folders.base.BaseFolder.LOCALIZED_NAMES">LOCALIZED_NAMES</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS" href="#exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS">WELLKNOWN_FOLDERS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.account" href="base.html#exchangelib.folders.base.BaseFolder.account">account</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.all" href="../queryset.html#exchangelib.queryset.SearchableMixIn.all">all</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.child_folder_count" href="base.html#exchangelib.folders.base.BaseFolder.child_folder_count">child_folder_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.deprecated_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.deprecated_from">deprecated_from</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.deregister" href="../items/base.html#exchangelib.items.base.RegisterMixIn.deregister">deregister</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.effective_rights" href="#exchangelib.folders.roots.RootOfHierarchy.effective_rights">effective_rights</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.exclude" href="../queryset.html#exchangelib.queryset.SearchableMixIn.exclude">exclude</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.filter" href="../queryset.html#exchangelib.queryset.SearchableMixIn.filter">filter</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_class">folder_class</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_container_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_cls_from_container_class">folder_cls_from_container_class</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name" href="#exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name">folder_cls_from_folder_name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get" href="../queryset.html#exchangelib.queryset.SearchableMixIn.get">get</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_default_folder" href="#exchangelib.folders.roots.RootOfHierarchy.get_default_folder">get_default_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_distinguished" href="#exchangelib.folders.roots.RootOfHierarchy.get_distinguished">get_distinguished</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_events" href="base.html#exchangelib.folders.base.BaseFolder.get_events">get_events</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_folder_allowed" href="base.html#exchangelib.folders.base.BaseFolder.get_folder_allowed">get_folder_allowed</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_streaming_events" href="base.html#exchangelib.folders.base.BaseFolder.get_streaming_events">get_streaming_events</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.name" href="base.html#exchangelib.folders.base.BaseFolder.name">name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.none" href="../queryset.html#exchangelib.queryset.SearchableMixIn.none">none</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.parent" href="base.html#exchangelib.folders.base.BaseFolder.parent">parent</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.parent_folder_id" href="base.html#exchangelib.folders.base.BaseFolder.parent_folder_id">parent_folder_id</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.people" href="../queryset.html#exchangelib.queryset.SearchableMixIn.people">people</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.register" href="../items/base.html#exchangelib.items.base.RegisterMixIn.register">register</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.root" href="base.html#exchangelib.folders.base.BaseFolder.root">root</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_pull" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_pull">subscribe_to_pull</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_push" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_push">subscribe_to_push</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_streaming" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_streaming">subscribe_to_streaming</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.supported_from">supported_from</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_item_models" href="base.html#exchangelib.folders.base.BaseFolder.supported_item_models">supported_item_models</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.sync_hierarchy" href="base.html#exchangelib.folders.base.BaseFolder.sync_hierarchy">sync_hierarchy</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.sync_items" href="base.html#exchangelib.folders.base.BaseFolder.sync_items">sync_items</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.test_access" href="base.html#exchangelib.folders.base.BaseFolder.test_access">test_access</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.total_count" href="base.html#exchangelib.folders.base.BaseFolder.total_count">total_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.tree" href="base.html#exchangelib.folders.base.BaseFolder.tree">tree</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.unread_count" href="base.html#exchangelib.folders.base.BaseFolder.unread_count">unread_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.unsubscribe" href="base.html#exchangelib.folders.base.BaseFolder.unsubscribe">unsubscribe</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="exchangelib.folders.roots.PublicFoldersRoot"><code class="flex name class">
<span>class <span class="ident">PublicFoldersRoot</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 PublicFoldersRoot(RootOfHierarchy):
    &#34;&#34;&#34;The root of the public folder hierarchy. Not available on all mailboxes.&#34;&#34;&#34;

    DISTINGUISHED_FOLDER_ID = &#34;publicfoldersroot&#34;
    DEFAULT_FOLDER_TRAVERSAL_DEPTH = SHALLOW
    supported_from = EXCHANGE_2007_SP1

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        if self._distinguished_id:
            self._distinguished_id.mailbox = None  # See DistinguishedFolderId.clean()

    @property
    def _folders_map(self):
        # Top-level public folders may point to the root folder of the owning account and not the public folders root
        # of this account. This breaks the assumption of get_children(). Fix it by overwriting the parent folder.
        fix_parents = self._subfolders is None
        res = super()._folders_map
        if fix_parents:
            with self._subfolders_lock:
                for f in res.values():
                    if f.id != self.id:
                        f.parent = self
        return res

    def get_children(self, folder):
        # EWS does not allow deep traversal of public folders, so self._folders_map will only populate the top-level
        # subfolders. To traverse public folders at arbitrary depth, we need to get child folders on demand.

        # Let&#39;s check if this folder already has any cached children. If so, assume we can just return those.
        children = list(super().get_children(folder=folder))
        if children:
            # Return a generator like our parent does
            yield from children
            return

        # Also return early if the server told us that there are no child folders.
        if folder.child_folder_count == 0:
            return

        children_map = {}
        with suppress(ErrorAccessDenied):
            for f in (
                SingleFolderQuerySet(account=self.account, folder=folder)
                .depth(self.DEFAULT_FOLDER_TRAVERSAL_DEPTH)
                .all()
            ):
                if isinstance(f, MISSING_FOLDER_ERRORS):
                    # We were unlucky. The folder disappeared between the FindFolder and the GetFolder calls
                    continue
                if isinstance(f, Exception):
                    raise f
                children_map[f.id] = f

        # Let&#39;s update the cache atomically, to avoid partial reads of the cache.
        with self._subfolders_lock:
            self._subfolders.update(children_map)

        # Child folders have been cached now. Try super().get_children() again.
        yield from super().get_children(folder=folder)</code></pre>
</details>
<div class="desc"><p>The root of the public folder hierarchy. Not available on all mailboxes.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></li>
<li><a title="exchangelib.folders.base.BaseFolder" href="base.html#exchangelib.folders.base.BaseFolder">BaseFolder</a></li>
<li><a title="exchangelib.items.base.RegisterMixIn" href="../items/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>
<li><a title="exchangelib.queryset.SearchableMixIn" href="../queryset.html#exchangelib.queryset.SearchableMixIn">SearchableMixIn</a></li>
<li><a title="exchangelib.version.SupportedVersionClassMixIn" href="../version.html#exchangelib.version.SupportedVersionClassMixIn">SupportedVersionClassMixIn</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="exchangelib.folders.roots.PublicFoldersRoot.get_children"><code class="name flex">
<span>def <span class="ident">get_children</span></span>(<span>self, folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_children(self, folder):
    # EWS does not allow deep traversal of public folders, so self._folders_map will only populate the top-level
    # subfolders. To traverse public folders at arbitrary depth, we need to get child folders on demand.

    # Let&#39;s check if this folder already has any cached children. If so, assume we can just return those.
    children = list(super().get_children(folder=folder))
    if children:
        # Return a generator like our parent does
        yield from children
        return

    # Also return early if the server told us that there are no child folders.
    if folder.child_folder_count == 0:
        return

    children_map = {}
    with suppress(ErrorAccessDenied):
        for f in (
            SingleFolderQuerySet(account=self.account, folder=folder)
            .depth(self.DEFAULT_FOLDER_TRAVERSAL_DEPTH)
            .all()
        ):
            if isinstance(f, MISSING_FOLDER_ERRORS):
                # We were unlucky. The folder disappeared between the FindFolder and the GetFolder calls
                continue
            if isinstance(f, Exception):
                raise f
            children_map[f.id] = f

    # Let&#39;s update the cache atomically, to avoid partial reads of the cache.
    with self._subfolders_lock:
        self._subfolders.update(children_map)

    # Child folders have been cached now. Try super().get_children() again.
    yield from super().get_children(folder=folder)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.CONTAINER_CLASS" href="base.html#exchangelib.folders.base.BaseFolder.CONTAINER_CLASS">CONTAINER_CLASS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DEFAULT_FOLDER_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_FOLDER_TRAVERSAL_DEPTH">DEFAULT_FOLDER_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DEFAULT_ITEM_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_ITEM_TRAVERSAL_DEPTH">DEFAULT_ITEM_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DISTINGUISHED_FOLDER_ID" href="base.html#exchangelib.folders.base.BaseFolder.DISTINGUISHED_FOLDER_ID">DISTINGUISHED_FOLDER_ID</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ID_ELEMENT_CLS" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn.ID_ELEMENT_CLS">ID_ELEMENT_CLS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.INSERT_AFTER_FIELD" href="../items/base.html#exchangelib.items.base.RegisterMixIn.INSERT_AFTER_FIELD">INSERT_AFTER_FIELD</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ITEM_MODEL_MAP" href="base.html#exchangelib.folders.base.BaseFolder.ITEM_MODEL_MAP">ITEM_MODEL_MAP</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.LOCALIZED_NAMES" href="base.html#exchangelib.folders.base.BaseFolder.LOCALIZED_NAMES">LOCALIZED_NAMES</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS" href="#exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS">WELLKNOWN_FOLDERS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.account" href="base.html#exchangelib.folders.base.BaseFolder.account">account</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.all" href="../queryset.html#exchangelib.queryset.SearchableMixIn.all">all</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.child_folder_count" href="base.html#exchangelib.folders.base.BaseFolder.child_folder_count">child_folder_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.deprecated_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.deprecated_from">deprecated_from</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.deregister" href="../items/base.html#exchangelib.items.base.RegisterMixIn.deregister">deregister</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.effective_rights" href="#exchangelib.folders.roots.RootOfHierarchy.effective_rights">effective_rights</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.exclude" href="../queryset.html#exchangelib.queryset.SearchableMixIn.exclude">exclude</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.filter" href="../queryset.html#exchangelib.queryset.SearchableMixIn.filter">filter</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_class">folder_class</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_container_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_cls_from_container_class">folder_cls_from_container_class</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name" href="#exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name">folder_cls_from_folder_name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get" href="../queryset.html#exchangelib.queryset.SearchableMixIn.get">get</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_default_folder" href="#exchangelib.folders.roots.RootOfHierarchy.get_default_folder">get_default_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_distinguished" href="#exchangelib.folders.roots.RootOfHierarchy.get_distinguished">get_distinguished</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_events" href="base.html#exchangelib.folders.base.BaseFolder.get_events">get_events</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_folder_allowed" href="base.html#exchangelib.folders.base.BaseFolder.get_folder_allowed">get_folder_allowed</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_streaming_events" href="base.html#exchangelib.folders.base.BaseFolder.get_streaming_events">get_streaming_events</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.name" href="base.html#exchangelib.folders.base.BaseFolder.name">name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.none" href="../queryset.html#exchangelib.queryset.SearchableMixIn.none">none</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.parent" href="base.html#exchangelib.folders.base.BaseFolder.parent">parent</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.parent_folder_id" href="base.html#exchangelib.folders.base.BaseFolder.parent_folder_id">parent_folder_id</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.people" href="../queryset.html#exchangelib.queryset.SearchableMixIn.people">people</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.register" href="../items/base.html#exchangelib.items.base.RegisterMixIn.register">register</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.root" href="base.html#exchangelib.folders.base.BaseFolder.root">root</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_pull" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_pull">subscribe_to_pull</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_push" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_push">subscribe_to_push</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_streaming" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_streaming">subscribe_to_streaming</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.supported_from">supported_from</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_item_models" href="base.html#exchangelib.folders.base.BaseFolder.supported_item_models">supported_item_models</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.sync_hierarchy" href="base.html#exchangelib.folders.base.BaseFolder.sync_hierarchy">sync_hierarchy</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.sync_items" href="base.html#exchangelib.folders.base.BaseFolder.sync_items">sync_items</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.test_access" href="base.html#exchangelib.folders.base.BaseFolder.test_access">test_access</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.total_count" href="base.html#exchangelib.folders.base.BaseFolder.total_count">total_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.tree" href="base.html#exchangelib.folders.base.BaseFolder.tree">tree</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.unread_count" href="base.html#exchangelib.folders.base.BaseFolder.unread_count">unread_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.unsubscribe" href="base.html#exchangelib.folders.base.BaseFolder.unsubscribe">unsubscribe</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="exchangelib.folders.roots.Root"><code class="flex name class">
<span>class <span class="ident">Root</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 Root(RootOfHierarchy):
    &#34;&#34;&#34;The root of the standard folder hierarchy.&#34;&#34;&#34;

    DISTINGUISHED_FOLDER_ID = &#34;root&#34;
    WELLKNOWN_FOLDERS = WELLKNOWN_FOLDERS_IN_ROOT

    @property
    def tois(self):
        # &#39;Top of Information Store&#39; is a folder available in some Exchange accounts. It usually contains the
        # distinguished folders belonging to the account (inbox, calendar, trash etc.).
        return self.get_default_folder(MsgFolderRoot)

    def get_default_folder(self, folder_cls):
        with suppress(MISSING_FOLDER_ERRORS):
            return super().get_default_folder(folder_cls)

        # Try to pick a suitable default folder. we do this by:
        #  1. Searching the full folder list for a folder with the distinguished folder name
        #  2. Searching TOIS for a direct child folder of the same type that is marked as distinguished
        #  3. Searching TOIS for a direct child folder of the same type that has a localized name
        #  4. Searching root for a direct child folder of the same type that is marked as distinguished
        #  5. Searching root for a direct child folder of the same type that has a localized name
        log.debug(&#34;Searching default %s folder in full folder list&#34;, folder_cls)

        for f in self._folders_map.values():
            # Require exact type, to avoid matching with subclasses (e.g. RecipientCache and Contacts)
            if f.__class__ == folder_cls and f.has_distinguished_name:
                log.debug(&#34;Found cached %s folder with default distinguished name&#34;, folder_cls)
                return f

        # Try direct children of TOIS first, unless we&#39;re trying to get the TOIS folder
        if folder_cls != MsgFolderRoot:
            with suppress(MISSING_FOLDER_ERRORS):
                return self._get_candidate(folder_cls=folder_cls, folder_coll=self.tois.children)
            # No candidates, or TOIS does not exist, or we don&#39;t have access to TOIS

        # Finally, try direct children of root
        return self._get_candidate(folder_cls=folder_cls, folder_coll=self.children)

    def _get_candidate(self, folder_cls, folder_coll):
        # Look for a single useful folder of type folder_cls in folder_coll
        same_type = [f for f in folder_coll if f.__class__ == folder_cls]
        are_distinguished = [f for f in same_type if f.is_distinguished]
        if are_distinguished:
            candidates = are_distinguished
        else:
            candidates = [f for f in same_type if f.name.lower() in folder_cls.localized_names(self.account.locale)]
        if not candidates:
            raise ErrorFolderNotFound(f&#34;No usable default {folder_cls} folders&#34;)
        if len(candidates) &gt; 1:
            raise ValueError(f&#34;Multiple possible default {folder_cls} folders: {[f.name for f in candidates]}&#34;)
        candidate = candidates[0]
        if candidate.is_distinguished:
            log.debug(&#34;Found distinguished %s folder&#34;, folder_cls)
        else:
            log.debug(&#34;Found %s folder with localized name %s&#34;, folder_cls, candidate.name)
        return candidate</code></pre>
</details>
<div class="desc"><p>The root of the standard folder hierarchy.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></li>
<li><a title="exchangelib.folders.base.BaseFolder" href="base.html#exchangelib.folders.base.BaseFolder">BaseFolder</a></li>
<li><a title="exchangelib.items.base.RegisterMixIn" href="../items/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>
<li><a title="exchangelib.queryset.SearchableMixIn" href="../queryset.html#exchangelib.queryset.SearchableMixIn">SearchableMixIn</a></li>
<li><a title="exchangelib.version.SupportedVersionClassMixIn" href="../version.html#exchangelib.version.SupportedVersionClassMixIn">SupportedVersionClassMixIn</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.folders.roots.Root.tois"><code class="name">prop <span class="ident">tois</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def tois(self):
    # &#39;Top of Information Store&#39; is a folder available in some Exchange accounts. It usually contains the
    # distinguished folders belonging to the account (inbox, calendar, trash etc.).
    return self.get_default_folder(MsgFolderRoot)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.CONTAINER_CLASS" href="base.html#exchangelib.folders.base.BaseFolder.CONTAINER_CLASS">CONTAINER_CLASS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DEFAULT_FOLDER_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_FOLDER_TRAVERSAL_DEPTH">DEFAULT_FOLDER_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DEFAULT_ITEM_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_ITEM_TRAVERSAL_DEPTH">DEFAULT_ITEM_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.DISTINGUISHED_FOLDER_ID" href="base.html#exchangelib.folders.base.BaseFolder.DISTINGUISHED_FOLDER_ID">DISTINGUISHED_FOLDER_ID</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ID_ELEMENT_CLS" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn.ID_ELEMENT_CLS">ID_ELEMENT_CLS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.INSERT_AFTER_FIELD" href="../items/base.html#exchangelib.items.base.RegisterMixIn.INSERT_AFTER_FIELD">INSERT_AFTER_FIELD</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.ITEM_MODEL_MAP" href="base.html#exchangelib.folders.base.BaseFolder.ITEM_MODEL_MAP">ITEM_MODEL_MAP</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.LOCALIZED_NAMES" href="base.html#exchangelib.folders.base.BaseFolder.LOCALIZED_NAMES">LOCALIZED_NAMES</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS" href="#exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS">WELLKNOWN_FOLDERS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.account" href="base.html#exchangelib.folders.base.BaseFolder.account">account</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.all" href="../queryset.html#exchangelib.queryset.SearchableMixIn.all">all</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.child_folder_count" href="base.html#exchangelib.folders.base.BaseFolder.child_folder_count">child_folder_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.deprecated_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.deprecated_from">deprecated_from</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.deregister" href="../items/base.html#exchangelib.items.base.RegisterMixIn.deregister">deregister</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.effective_rights" href="#exchangelib.folders.roots.RootOfHierarchy.effective_rights">effective_rights</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.exclude" href="../queryset.html#exchangelib.queryset.SearchableMixIn.exclude">exclude</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.filter" href="../queryset.html#exchangelib.queryset.SearchableMixIn.filter">filter</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_class">folder_class</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_container_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_cls_from_container_class">folder_cls_from_container_class</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name" href="#exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name">folder_cls_from_folder_name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get" href="../queryset.html#exchangelib.queryset.SearchableMixIn.get">get</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_default_folder" href="#exchangelib.folders.roots.RootOfHierarchy.get_default_folder">get_default_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_distinguished" href="#exchangelib.folders.roots.RootOfHierarchy.get_distinguished">get_distinguished</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_events" href="base.html#exchangelib.folders.base.BaseFolder.get_events">get_events</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_folder_allowed" href="base.html#exchangelib.folders.base.BaseFolder.get_folder_allowed">get_folder_allowed</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_streaming_events" href="base.html#exchangelib.folders.base.BaseFolder.get_streaming_events">get_streaming_events</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.name" href="base.html#exchangelib.folders.base.BaseFolder.name">name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.none" href="../queryset.html#exchangelib.queryset.SearchableMixIn.none">none</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.parent" href="base.html#exchangelib.folders.base.BaseFolder.parent">parent</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.parent_folder_id" href="base.html#exchangelib.folders.base.BaseFolder.parent_folder_id">parent_folder_id</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.people" href="../queryset.html#exchangelib.queryset.SearchableMixIn.people">people</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.register" href="../items/base.html#exchangelib.items.base.RegisterMixIn.register">register</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.root" href="base.html#exchangelib.folders.base.BaseFolder.root">root</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_pull" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_pull">subscribe_to_pull</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_push" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_push">subscribe_to_push</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.subscribe_to_streaming" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_streaming">subscribe_to_streaming</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.supported_from">supported_from</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.supported_item_models" href="base.html#exchangelib.folders.base.BaseFolder.supported_item_models">supported_item_models</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.sync_hierarchy" href="base.html#exchangelib.folders.base.BaseFolder.sync_hierarchy">sync_hierarchy</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.sync_items" href="base.html#exchangelib.folders.base.BaseFolder.sync_items">sync_items</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.test_access" href="base.html#exchangelib.folders.base.BaseFolder.test_access">test_access</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.total_count" href="base.html#exchangelib.folders.base.BaseFolder.total_count">total_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.tree" href="base.html#exchangelib.folders.base.BaseFolder.tree">tree</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.unread_count" href="base.html#exchangelib.folders.base.BaseFolder.unread_count">unread_count</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.unsubscribe" href="base.html#exchangelib.folders.base.BaseFolder.unsubscribe">unsubscribe</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.validate_field" href="../properties.html#exchangelib.properties.EWSElement.validate_field">validate_field</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy"><code class="flex name class">
<span>class <span class="ident">RootOfHierarchy</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 RootOfHierarchy(BaseFolder, metaclass=EWSMeta):
    &#34;&#34;&#34;Base class for folders that implement the root of a folder hierarchy.&#34;&#34;&#34;

    # A list of wellknown, or &#34;distinguished&#34;, folders that are belong in this folder hierarchy. See
    # https://docs.microsoft.com/en-us/dotnet/api/microsoft.exchange.webservices.data.wellknownfoldername
    # and https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/distinguishedfolderid
    # &#39;RootOfHierarchy&#39; subclasses must not be in this list.
    WELLKNOWN_FOLDERS = []

    # This folder type also has &#39;folder:PermissionSet&#39; on some server versions, but requesting it sometimes causes
    # &#39;ErrorAccessDenied&#39;, as reported by some users. Ignore it entirely for root folders - it&#39;s usefulness is
    # deemed minimal at best.
    effective_rights = EffectiveRightsField(
        field_uri=&#34;folder:EffectiveRights&#34;, is_read_only=True, supported_from=EXCHANGE_2007_SP1
    )

    __slots__ = &#34;_account&#34;, &#34;_subfolders&#34;, &#34;_subfolders_lock&#34;

    # A special folder that acts as the top of a folder hierarchy. Finds and caches sub-folders at arbitrary depth.
    def __init__(self, **kwargs):
        self._account = kwargs.pop(&#34;account&#34;, None)  # A pointer back to the account holding the folder hierarchy
        super().__init__(**kwargs)
        self._subfolders = None  # See self._folders_map()
        self._subfolders_lock = Lock()

    @property
    def account(self):
        return self._account

    @property
    def root(self):
        return self

    @property
    def parent(self):
        return None

    @classmethod
    def register(cls, *args, **kwargs):
        if cls is not RootOfHierarchy:
            raise TypeError(&#34;For folder roots, custom fields must be registered on the RootOfHierarchy class&#34;)
        return super().register(*args, **kwargs)

    @classmethod
    def deregister(cls, *args, **kwargs):
        if cls is not RootOfHierarchy:
            raise TypeError(&#34;For folder roots, custom fields must be registered on the RootOfHierarchy class&#34;)
        return super().deregister(*args, **kwargs)

    def get_folder(self, folder):
        if not folder.id:
            raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
        return self._folders_map.get(folder.id)

    def add_folder(self, folder):
        if not folder.id:
            raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
        self._folders_map[folder.id] = folder

    def update_folder(self, folder):
        if not folder.id:
            raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
        self._folders_map[folder.id] = folder

    def remove_folder(self, folder):
        if not folder.id:
            raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
        with suppress(KeyError):
            del self._folders_map[folder.id]

    def clear_cache(self):
        with self._subfolders_lock:
            self._subfolders = None

    def get_children(self, folder):
        for f in self._folders_map.values():
            if not f.parent:
                continue
            if f.parent.id == folder.id:
                yield f

    def get_default_folder(self, folder_cls):
        &#34;&#34;&#34;Return the distinguished folder instance of type folder_cls belonging to this account. If no distinguished
        folder was found, try as best we can to return the default folder of type &#39;folder_cls&#39;
        &#34;&#34;&#34;
        if not folder_cls.DISTINGUISHED_FOLDER_ID:
            raise ValueError(f&#34;&#39;folder_cls&#39; {folder_cls} must have a DISTINGUISHED_FOLDER_ID value&#34;)
        # Use cached distinguished folder instance, but only if cache has already been prepped. This is an optimization
        # for accessing e.g. &#39;account.contacts&#39; without fetching all folders of the account.
        if self._subfolders is not None:
            for f in self._folders_map.values():
                # Require exact class, to not match subclasses, e.g. RecipientCache instead of Contacts
                if f.__class__ == folder_cls and f.is_distinguished:
                    log.debug(&#34;Found cached distinguished %s folder&#34;, folder_cls)
                    return f
        try:
            log.debug(&#34;Requesting distinguished %s folder explicitly&#34;, folder_cls)
            return folder_cls.get_distinguished(root=self)
        except ErrorAccessDenied:
            # Maybe we just don&#39;t have GetFolder access? Try FindItem instead
            log.debug(&#34;Testing default %s folder with FindItem&#34;, folder_cls)
            fld = folder_cls(
                _distinguished_id=DistinguishedFolderId(
                    id=folder_cls.DISTINGUISHED_FOLDER_ID,
                    mailbox=Mailbox(email_address=self.account.primary_smtp_address),
                ),
                root=self,
            )
            fld.test_access()
            return self._folders_map.get(fld.id, fld)  # Use cached instance if available
        except MISSING_FOLDER_ERRORS:
            # The Exchange server does not return a distinguished folder of this type
            pass
        raise ErrorFolderNotFound(f&#34;No usable default {folder_cls} folders&#34;)

    @classmethod
    def get_distinguished(cls, account):
        &#34;&#34;&#34;Get the distinguished folder for this folder class.

        :param account:
        :return:
        &#34;&#34;&#34;
        return cls._get_distinguished(
            folder=cls(
                _distinguished_id=DistinguishedFolderId(
                    id=cls.DISTINGUISHED_FOLDER_ID,
                    mailbox=Mailbox(email_address=account.primary_smtp_address),
                ),
                account=account,
            )
        )

    @property
    def _folders_map(self):
        if self._subfolders is not None:
            return self._subfolders

        with self._subfolders_lock:
            # Map root, and all sub-folders of root, at arbitrary depth by folder ID. First get distinguished folders,
            # so we are sure to apply the correct Folder class, then fetch all sub-folders of this root.
            folders_map = {self.id: self}
            distinguished_folders = [
                cls(
                    _distinguished_id=DistinguishedFolderId(
                        id=cls.DISTINGUISHED_FOLDER_ID,
                        mailbox=Mailbox(email_address=self.account.primary_smtp_address),
                    ),
                    root=self,
                )
                for cls in self.WELLKNOWN_FOLDERS
                if cls.get_folder_allowed and cls.supports_version(self.account.version)
            ]
            for f in FolderCollection(account=self.account, folders=distinguished_folders).resolve():
                if isinstance(f, MISSING_FOLDER_ERRORS):
                    # This is just a distinguished folder the server does not have
                    continue
                if isinstance(f, ErrorInvalidOperation):
                    # This is probably a distinguished folder the server does not have. We previously tested the exact
                    # error message (f.value), but some Exchange servers return localized error messages, so that&#39;s not
                    # possible to do reliably.
                    continue
                if isinstance(f, ErrorAccessDenied):
                    # We may not have GetFolder access, either to this folder or at all
                    continue
                if isinstance(f, Exception):
                    raise f
                folders_map[f.id] = f
            for f in (
                SingleFolderQuerySet(account=self.account, folder=self).depth(self.DEFAULT_FOLDER_TRAVERSAL_DEPTH).all()
            ):
                if isinstance(f, ErrorAccessDenied):
                    # We may not have FindFolder access, or GetFolder access, either to this folder or at all
                    continue
                if isinstance(f, MISSING_FOLDER_ERRORS):
                    # We were unlucky. The folder disappeared between the FindFolder and the GetFolder calls
                    continue
                if isinstance(f, Exception):
                    raise f
                if f.id in folders_map:
                    # Already exists. Probably a distinguished folder
                    continue
                folders_map[f.id] = f
            self._subfolders = folders_map
            return folders_map

    @classmethod
    def from_xml(cls, elem, account):
        kwargs = cls._kwargs_from_elem(elem=elem, account=account)
        cls._clear(elem)
        return cls(account=account, **kwargs)

    @classmethod
    def folder_cls_from_folder_name(cls, folder_name, folder_class, locale):
        &#34;&#34;&#34;Return the folder class that matches a localized folder name. Take into account the &#39;folder_class&#39; of the
        folder, to not identify an &#39;IPF.Note&#39; folder as a &#39;Calendar&#39; class just because it&#39;s called e.g. &#39;Kalender&#39; and
        the locale is &#39;da_DK&#39;.

        Some folders, e.g. `System`, don&#39;t define a `folder_class`. For these folders, we match on localized folder name
        if the folder class does not have its &#39;CONTAINER_CLASS&#39; set.

        :param folder_name:
        :param folder_class:
        :param locale: a string, e.g. &#39;da_DK&#39;
        &#34;&#34;&#34;
        for folder_cls in cls.WELLKNOWN_FOLDERS + NON_DELETABLE_FOLDERS + MISC_FOLDERS:
            if folder_cls.CONTAINER_CLASS != folder_class:
                continue
            if folder_name.lower() not in folder_cls.localized_names(locale):
                continue
            return folder_cls
        raise KeyError()

    def __getstate__(self):
        # The lock cannot be pickled
        state = {k: getattr(self, k) for k in self._slots_keys}
        del state[&#34;_subfolders_lock&#34;]
        return state

    def __setstate__(self, state):
        # Restore the lock
        for k in self._slots_keys:
            setattr(self, k, state.get(k))
        self._subfolders_lock = Lock()

    def __repr__(self):
        # Let&#39;s not create an infinite loop when printing self.root
        return self.__class__.__name__ + repr(
            (
                self.account,
                &#34;[self]&#34;,
                self.name,
                self.total_count,
                self.unread_count,
                self.child_folder_count,
                self.folder_class,
                self.id,
                self.changekey,
            )
        )</code></pre>
</details>
<div class="desc"><p>Base class for folders that implement the root of a folder hierarchy.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="exchangelib.folders.base.BaseFolder" href="base.html#exchangelib.folders.base.BaseFolder">BaseFolder</a></li>
<li><a title="exchangelib.items.base.RegisterMixIn" href="../items/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>
<li><a title="exchangelib.queryset.SearchableMixIn" href="../queryset.html#exchangelib.queryset.SearchableMixIn">SearchableMixIn</a></li>
<li><a title="exchangelib.version.SupportedVersionClassMixIn" href="../version.html#exchangelib.version.SupportedVersionClassMixIn">SupportedVersionClassMixIn</a></li>
</ul>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="exchangelib.folders.roots.ArchiveRoot" href="#exchangelib.folders.roots.ArchiveRoot">ArchiveRoot</a></li>
<li><a title="exchangelib.folders.roots.PublicFoldersRoot" href="#exchangelib.folders.roots.PublicFoldersRoot">PublicFoldersRoot</a></li>
<li><a title="exchangelib.folders.roots.Root" href="#exchangelib.folders.roots.Root">Root</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS"><code class="name">var <span class="ident">WELLKNOWN_FOLDERS</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.folders.roots.RootOfHierarchy.folder_cls_from_folder_name"><code class="name flex">
<span>def <span class="ident">folder_cls_from_folder_name</span></span>(<span>folder_name, folder_class, locale)</span>
</code></dt>
<dd>
<div class="desc"><p>Return the folder class that matches a localized folder name. Take into account the 'folder_class' of the
folder, to not identify an 'IPF.Note' folder as a 'Calendar' class just because it's called e.g. 'Kalender' and
the locale is 'da_DK'.</p>
<p>Some folders, e.g. <code>System</code>, don't define a <code>folder_class</code>. For these folders, we match on localized folder name
if the folder class does not have its 'CONTAINER_CLASS' set.</p>
<p>:param folder_name:
:param folder_class:
:param locale: a string, e.g. 'da_DK'</p></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.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>
<dt id="exchangelib.folders.roots.RootOfHierarchy.get_distinguished"><code class="name flex">
<span>def <span class="ident">get_distinguished</span></span>(<span>account)</span>
</code></dt>
<dd>
<div class="desc"><p>Get the distinguished folder for this folder class.</p>
<p>:param account:
:return:</p></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="exchangelib.folders.roots.RootOfHierarchy.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>
</dl>
<h3>Methods</h3>
<dl>
<dt id="exchangelib.folders.roots.RootOfHierarchy.add_folder"><code class="name flex">
<span>def <span class="ident">add_folder</span></span>(<span>self, folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_folder(self, folder):
    if not folder.id:
        raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
    self._folders_map[folder.id] = folder</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.clear_cache"><code class="name flex">
<span>def <span class="ident">clear_cache</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def clear_cache(self):
    with self._subfolders_lock:
        self._subfolders = None</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.get_children"><code class="name flex">
<span>def <span class="ident">get_children</span></span>(<span>self, folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_children(self, folder):
    for f in self._folders_map.values():
        if not f.parent:
            continue
        if f.parent.id == folder.id:
            yield f</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.get_default_folder"><code class="name flex">
<span>def <span class="ident">get_default_folder</span></span>(<span>self, folder_cls)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_default_folder(self, folder_cls):
    &#34;&#34;&#34;Return the distinguished folder instance of type folder_cls belonging to this account. If no distinguished
    folder was found, try as best we can to return the default folder of type &#39;folder_cls&#39;
    &#34;&#34;&#34;
    if not folder_cls.DISTINGUISHED_FOLDER_ID:
        raise ValueError(f&#34;&#39;folder_cls&#39; {folder_cls} must have a DISTINGUISHED_FOLDER_ID value&#34;)
    # Use cached distinguished folder instance, but only if cache has already been prepped. This is an optimization
    # for accessing e.g. &#39;account.contacts&#39; without fetching all folders of the account.
    if self._subfolders is not None:
        for f in self._folders_map.values():
            # Require exact class, to not match subclasses, e.g. RecipientCache instead of Contacts
            if f.__class__ == folder_cls and f.is_distinguished:
                log.debug(&#34;Found cached distinguished %s folder&#34;, folder_cls)
                return f
    try:
        log.debug(&#34;Requesting distinguished %s folder explicitly&#34;, folder_cls)
        return folder_cls.get_distinguished(root=self)
    except ErrorAccessDenied:
        # Maybe we just don&#39;t have GetFolder access? Try FindItem instead
        log.debug(&#34;Testing default %s folder with FindItem&#34;, folder_cls)
        fld = folder_cls(
            _distinguished_id=DistinguishedFolderId(
                id=folder_cls.DISTINGUISHED_FOLDER_ID,
                mailbox=Mailbox(email_address=self.account.primary_smtp_address),
            ),
            root=self,
        )
        fld.test_access()
        return self._folders_map.get(fld.id, fld)  # Use cached instance if available
    except MISSING_FOLDER_ERRORS:
        # The Exchange server does not return a distinguished folder of this type
        pass
    raise ErrorFolderNotFound(f&#34;No usable default {folder_cls} folders&#34;)</code></pre>
</details>
<div class="desc"><p>Return the distinguished folder instance of type folder_cls belonging to this account. If no distinguished
folder was found, try as best we can to return the default folder of type 'folder_cls'</p></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.get_folder"><code class="name flex">
<span>def <span class="ident">get_folder</span></span>(<span>self, folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_folder(self, folder):
    if not folder.id:
        raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
    return self._folders_map.get(folder.id)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.remove_folder"><code class="name flex">
<span>def <span class="ident">remove_folder</span></span>(<span>self, folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def remove_folder(self, folder):
    if not folder.id:
        raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
    with suppress(KeyError):
        del self._folders_map[folder.id]</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="exchangelib.folders.roots.RootOfHierarchy.update_folder"><code class="name flex">
<span>def <span class="ident">update_folder</span></span>(<span>self, folder)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def update_folder(self, folder):
    if not folder.id:
        raise ValueError(&#34;&#39;folder&#39; must have an ID&#34;)
    self._folders_map[folder.id] = folder</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="exchangelib.folders.base.BaseFolder" href="base.html#exchangelib.folders.base.BaseFolder">BaseFolder</a></b></code>:
<ul class="hlist">
<li><code><a title="exchangelib.folders.base.BaseFolder.CONTAINER_CLASS" href="base.html#exchangelib.folders.base.BaseFolder.CONTAINER_CLASS">CONTAINER_CLASS</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.DEFAULT_FOLDER_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_FOLDER_TRAVERSAL_DEPTH">DEFAULT_FOLDER_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.DEFAULT_ITEM_TRAVERSAL_DEPTH" href="base.html#exchangelib.folders.base.BaseFolder.DEFAULT_ITEM_TRAVERSAL_DEPTH">DEFAULT_ITEM_TRAVERSAL_DEPTH</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.DISTINGUISHED_FOLDER_ID" href="base.html#exchangelib.folders.base.BaseFolder.DISTINGUISHED_FOLDER_ID">DISTINGUISHED_FOLDER_ID</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.ELEMENT_NAME" href="../properties.html#exchangelib.properties.EWSElement.ELEMENT_NAME">ELEMENT_NAME</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.FIELDS" href="../properties.html#exchangelib.properties.EWSElement.FIELDS">FIELDS</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.ID_ELEMENT_CLS" href="../properties.html#exchangelib.properties.IdChangeKeyMixIn.ID_ELEMENT_CLS">ID_ELEMENT_CLS</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.INSERT_AFTER_FIELD" href="../items/base.html#exchangelib.items.base.RegisterMixIn.INSERT_AFTER_FIELD">INSERT_AFTER_FIELD</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.ITEM_MODEL_MAP" href="base.html#exchangelib.folders.base.BaseFolder.ITEM_MODEL_MAP">ITEM_MODEL_MAP</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.LOCALIZED_NAMES" href="base.html#exchangelib.folders.base.BaseFolder.LOCALIZED_NAMES">LOCALIZED_NAMES</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.NAMESPACE" href="../properties.html#exchangelib.properties.EWSElement.NAMESPACE">NAMESPACE</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.account" href="base.html#exchangelib.folders.base.BaseFolder.account">account</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.add_field" href="../properties.html#exchangelib.properties.EWSElement.add_field">add_field</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.all" href="../queryset.html#exchangelib.queryset.SearchableMixIn.all">all</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.child_folder_count" href="base.html#exchangelib.folders.base.BaseFolder.child_folder_count">child_folder_count</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.deprecated_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.deprecated_from">deprecated_from</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.deregister" href="../items/base.html#exchangelib.items.base.RegisterMixIn.deregister">deregister</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.exclude" href="../queryset.html#exchangelib.queryset.SearchableMixIn.exclude">exclude</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.filter" href="../queryset.html#exchangelib.queryset.SearchableMixIn.filter">filter</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.folder_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_class">folder_class</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.folder_cls_from_container_class" href="base.html#exchangelib.folders.base.BaseFolder.folder_cls_from_container_class">folder_cls_from_container_class</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.get" href="../queryset.html#exchangelib.queryset.SearchableMixIn.get">get</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.get_events" href="base.html#exchangelib.folders.base.BaseFolder.get_events">get_events</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.get_folder_allowed" href="base.html#exchangelib.folders.base.BaseFolder.get_folder_allowed">get_folder_allowed</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.get_streaming_events" href="base.html#exchangelib.folders.base.BaseFolder.get_streaming_events">get_streaming_events</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.name" href="base.html#exchangelib.folders.base.BaseFolder.name">name</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.none" href="../queryset.html#exchangelib.queryset.SearchableMixIn.none">none</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.parent" href="base.html#exchangelib.folders.base.BaseFolder.parent">parent</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.parent_folder_id" href="base.html#exchangelib.folders.base.BaseFolder.parent_folder_id">parent_folder_id</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.people" href="../queryset.html#exchangelib.queryset.SearchableMixIn.people">people</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.register" href="../items/base.html#exchangelib.items.base.RegisterMixIn.register">register</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.remove_field" href="../properties.html#exchangelib.properties.EWSElement.remove_field">remove_field</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.root" href="base.html#exchangelib.folders.base.BaseFolder.root">root</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.subscribe_to_pull" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_pull">subscribe_to_pull</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.subscribe_to_push" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_push">subscribe_to_push</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.subscribe_to_streaming" href="base.html#exchangelib.folders.base.BaseFolder.subscribe_to_streaming">subscribe_to_streaming</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.supported_fields" href="../properties.html#exchangelib.properties.EWSElement.supported_fields">supported_fields</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.supported_from" href="../version.html#exchangelib.version.SupportedVersionClassMixIn.supported_from">supported_from</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.supported_item_models" href="base.html#exchangelib.folders.base.BaseFolder.supported_item_models">supported_item_models</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.sync_hierarchy" href="base.html#exchangelib.folders.base.BaseFolder.sync_hierarchy">sync_hierarchy</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.sync_items" href="base.html#exchangelib.folders.base.BaseFolder.sync_items">sync_items</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.test_access" href="base.html#exchangelib.folders.base.BaseFolder.test_access">test_access</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.total_count" href="base.html#exchangelib.folders.base.BaseFolder.total_count">total_count</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.tree" href="base.html#exchangelib.folders.base.BaseFolder.tree">tree</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.unread_count" href="base.html#exchangelib.folders.base.BaseFolder.unread_count">unread_count</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.unsubscribe" href="base.html#exchangelib.folders.base.BaseFolder.unsubscribe">unsubscribe</a></code></li>
<li><code><a title="exchangelib.folders.base.BaseFolder.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.folders" href="index.html">exchangelib.folders</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="exchangelib.folders.roots.ArchiveRoot" href="#exchangelib.folders.roots.ArchiveRoot">ArchiveRoot</a></code></h4>
</li>
<li>
<h4><code><a title="exchangelib.folders.roots.PublicFoldersRoot" href="#exchangelib.folders.roots.PublicFoldersRoot">PublicFoldersRoot</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.folders.roots.PublicFoldersRoot.get_children" href="#exchangelib.folders.roots.PublicFoldersRoot.get_children">get_children</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="exchangelib.folders.roots.Root" href="#exchangelib.folders.roots.Root">Root</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.folders.roots.Root.tois" href="#exchangelib.folders.roots.Root.tois">tois</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="exchangelib.folders.roots.RootOfHierarchy" href="#exchangelib.folders.roots.RootOfHierarchy">RootOfHierarchy</a></code></h4>
<ul class="">
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS" href="#exchangelib.folders.roots.RootOfHierarchy.WELLKNOWN_FOLDERS">WELLKNOWN_FOLDERS</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.add_folder" href="#exchangelib.folders.roots.RootOfHierarchy.add_folder">add_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.clear_cache" href="#exchangelib.folders.roots.RootOfHierarchy.clear_cache">clear_cache</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.effective_rights" href="#exchangelib.folders.roots.RootOfHierarchy.effective_rights">effective_rights</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name" href="#exchangelib.folders.roots.RootOfHierarchy.folder_cls_from_folder_name">folder_cls_from_folder_name</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.from_xml" href="#exchangelib.folders.roots.RootOfHierarchy.from_xml">from_xml</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_children" href="#exchangelib.folders.roots.RootOfHierarchy.get_children">get_children</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_default_folder" href="#exchangelib.folders.roots.RootOfHierarchy.get_default_folder">get_default_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_distinguished" href="#exchangelib.folders.roots.RootOfHierarchy.get_distinguished">get_distinguished</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.get_folder" href="#exchangelib.folders.roots.RootOfHierarchy.get_folder">get_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.remove_folder" href="#exchangelib.folders.roots.RootOfHierarchy.remove_folder">remove_folder</a></code></li>
<li><code><a title="exchangelib.folders.roots.RootOfHierarchy.update_folder" href="#exchangelib.folders.roots.RootOfHierarchy.update_folder">update_folder</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>