migrate therinaldos.com data
Build & Deploy to DigitalOcean Space / build (push) Failing after 2m38s

This commit is contained in:
2024-05-05 15:50:45 -04:00
commit ef1ff240d4
23182 changed files with 3801898 additions and 0 deletions
@@ -0,0 +1,347 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Calendar / CalDAV &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Contacts / CardDAV" href="contacts.html" />
<link rel="prev" title="Groupware" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Groupware</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Calendar / CalDAV</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#events">Events</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#hide-export-buttons">Hide export buttons</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#invitations">Invitations</a></li>
<li class="toctree-l3"><a class="reference internal" href="#birthday-calendar">Birthday calendar</a></li>
<li class="toctree-l3"><a class="reference internal" href="#reminder-notifications">Reminder notifications</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#background-jobs">Background jobs</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#event-alarm-types">Event alarm types</a></li>
<li class="toctree-l3"><a class="reference internal" href="#freebusy">FreeBusy</a></li>
<li class="toctree-l3"><a class="reference internal" href="#subscriptions">Subscriptions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#custom-public-calendars">Custom public calendars</a></li>
<li class="toctree-l4"><a class="reference internal" href="#refresh-rate">Refresh rate</a></li>
<li class="toctree-l4"><a class="reference internal" href="#allow-subscriptions-on-local-network">Allow subscriptions on local network</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#trash-bin">Trash bin</a></li>
<li class="toctree-l3"><a class="reference internal" href="#resources-and-rooms">Resources and rooms</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#known-backends">Known backends</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#rate-limits">Rate limits</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="contacts.html">Contacts / CardDAV</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
<li class="toctree-l2"><a class="reference internal" href="out_of_office.html">Out-of-office feature</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">Nextcloud latest Administration Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Groupware</a></li>
<li class="breadcrumb-item active">Calendar / CalDAV</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/groupware/calendar.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="calendar-caldav">
<h1>Calendar / CalDAV<a class="headerlink" href="#calendar-caldav" title="Link to this heading"></a></h1>
<section id="events">
<h2>Events<a class="headerlink" href="#events" title="Link to this heading"></a></h2>
<p>You can customize the events user interface.</p>
<section id="hide-export-buttons">
<h3>Hide export buttons<a class="headerlink" href="#hide-export-buttons" title="Link to this heading"></a></h3>
<p>By default users can export their calendar data from the editor and the sidebar. Admins can disable this feature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">hideEventExport</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="n">yes</span>
</pre></div>
</div>
</section>
</section>
<section id="invitations">
<h2>Invitations<a class="headerlink" href="#invitations" title="Link to this heading"></a></h2>
<p>Nextcloud can send invitations for event attendees if this option is activated.
Be sure to have configured the email server first so that the invitations go through.
See <a class="reference internal" href="../configuration_server/email_configuration.html"><span class="doc">Email</span></a>.</p>
<p>You must also make sure the “Send invitations to attendees” setting is activated in the admin setting groupware section for the emails to be sent.</p>
</section>
<section id="birthday-calendar">
<h2>Birthday calendar<a class="headerlink" href="#birthday-calendar" title="Link to this heading"></a></h2>
<p>Contacts that have a birthday date filled are automatically added as events to a special Birthday calendar.
If you deactivate this option, all users will no longer have this calendar.</p>
<p>When activating this option, users birthday calendars won’t be available right away because they need to be generated
by a background task. See <a class="reference internal" href="../configuration_server/occ_command.html"><span class="doc">Using the occ command</span></a> section DAV commands.</p>
</section>
<section id="reminder-notifications">
<h2>Reminder notifications<a class="headerlink" href="#reminder-notifications" title="Link to this heading"></a></h2>
<p>Nextcloud handles sending notifications for events.</p>
<p>Nextcloud currently handles two types of reminder notifications: Build-in Nextcloud notifications and
email notifications. For the emails to be send, you’ll need a configured email server.
See <a class="reference internal" href="../configuration_server/email_configuration.html"><span class="doc">Email</span></a>.</p>
<p>Make sure the “Send notifications for events” and the “Enable notifications for events via push” are activated in the admin setting groupware section for this feature to work.</p>
<section id="background-jobs">
<h3>Background jobs<a class="headerlink" href="#background-jobs" title="Link to this heading"></a></h3>
<p>Running background jobs can be an expensive task when there are a large number of events, reminders, event sharees and attendees. However, this needs to happen
often enough so that the notifications are sent on time. To accomplish this you should use a dedicated <code class="docutils literal notranslate"><span class="pre">occ</span></code> command that runs
more often than the standard <code class="docutils literal notranslate"><span class="pre">cron</span></code> system:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># crontab -u www-data -e</span>
<span class="o">*/</span><span class="mi">5</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">php</span> <span class="o">-</span><span class="n">f</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">www</span><span class="o">/</span><span class="n">nextcloud</span><span class="o">/</span><span class="n">occ</span> <span class="n">dav</span><span class="p">:</span><span class="n">send</span><span class="o">-</span><span class="n">event</span><span class="o">-</span><span class="n">reminders</span>
</pre></div>
</div>
<p>See <a class="reference internal" href="../configuration_server/occ_command.html"><span class="doc">Using the occ command</span></a> section Dav commands.</p>
<p>You’ll also need to change the sending mode from <code class="docutils literal notranslate"><span class="pre">background-job</span></code> to <code class="docutils literal notranslate"><span class="pre">occ</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">dav</span> <span class="n">sendEventRemindersMode</span> <span class="o">--</span><span class="n">value</span> <span class="n">occ</span>
</pre></div>
</div>
<p>If you don’t use this dedicated command, the reminders will just be sent as soon as possible when the background jobs run.</p>
</section>
</section>
<section id="event-alarm-types">
<h2>Event alarm types<a class="headerlink" href="#event-alarm-types" title="Link to this heading"></a></h2>
<p>Nextcloud allows users to set notification and email reminders for events. Admins can enforce one of the two options:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">forceEventAlarmType</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="n">EMAIL</span>
</pre></div>
</div>
<p>Allowed values are <code class="docutils literal notranslate"><span class="pre">EMAIL</span></code> (email) and <code class="docutils literal notranslate"><span class="pre">DISPLAY</span></code> (notification).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This only enforces alarm types for events created with the Nextcloud Calendar. This setting has no influence for other connected applications.</p>
</div>
</section>
<section id="freebusy">
<h2>FreeBusy<a class="headerlink" href="#freebusy" title="Link to this heading"></a></h2>
<p>When logged-in, Nextcloud can return FreeBusy information for all users of the instance, to know when they are available so that you can schedule an event at the right time.
If you don’t wish for users to have this capability, you can disable FreeBusy for the whole instance with the following setting:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">dav</span> <span class="n">disableFreeBusy</span> <span class="o">--</span><span class="n">value</span> <span class="n">yes</span>
</pre></div>
</div>
</section>
<section id="subscriptions">
<h2>Subscriptions<a class="headerlink" href="#subscriptions" title="Link to this heading"></a></h2>
<section id="custom-public-calendars">
<h3>Custom public calendars<a class="headerlink" href="#custom-public-calendars" title="Link to this heading"></a></h3>
<p>In addition to the public holiday calendars, it is possible to define your own calendar.
They act in the same way as the holiday calendars and can be configured with the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">publicCalendars</span> <span class="o">--</span><span class="n">value</span> <span class="s1">&#39;[{&quot;name&quot;:&quot;My custom calendar&quot;,&quot;source&quot;:&quot;http://example.com/example.ics&quot;}]&#39;</span>
</pre></div>
</div>
<p>The setting is specified as a JSON array of objects with the following options:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> - name of the calendar in the listing</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">source</span></code> - URL of the calendar’s ICS file</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">displayName</span></code> - optional, to overwrite the name of the subscribed calendar</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> - optional, description in the listing</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">authors</span></code> - optional, copyrights and so on</p></li>
</ul>
</section>
<section id="refresh-rate">
<h3>Refresh rate<a class="headerlink" href="#refresh-rate" title="Link to this heading"></a></h3>
<p>Calendar subscriptions are cached on server and refreshed periodically.
The default refresh rate is one week, unless the subscription itself tells otherwise.</p>
<p>To set up a different default refresh rate, change the <code class="docutils literal notranslate"><span class="pre">calendarSubscriptionRefreshRate</span></code> option:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">dav</span> <span class="n">calendarSubscriptionRefreshRate</span> <span class="o">--</span><span class="n">value</span> <span class="s2">&quot;P1D&quot;</span>
</pre></div>
</div>
<p>Where the value is a <a class="reference external" href="https://www.php.net/manual/dateinterval.construct.php">DateInterval</a>, for instance with the above command all of the Nextcloud instance’s calendars would be refreshed every day.</p>
</section>
<section id="allow-subscriptions-on-local-network">
<h3>Allow subscriptions on local network<a class="headerlink" href="#allow-subscriptions-on-local-network" title="Link to this heading"></a></h3>
<p>Because of security issues, Nextcloud forbids subscriptions from local network hosts.
If you need to allow this, change the following parameter to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">dav</span> <span class="n">webcalAllowLocalAccess</span> <span class="o">--</span><span class="n">value</span> <span class="n">yes</span>
</pre></div>
</div>
</section>
</section>
<section id="trash-bin">
<h2>Trash bin<a class="headerlink" href="#trash-bin" title="Link to this heading"></a></h2>
<p>Nextcloud supports a calendar, events and tasks trash bin.</p>
<p>The default delay before objects are purged from the trash bin is 30 days. A background job runs every 6 hours to clean up expired objects.</p>
<p>To set up a different retention period, change the <code class="docutils literal notranslate"><span class="pre">calendarRetentionObligation</span></code> option:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">dav</span> <span class="n">calendarRetentionObligation</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="mi">2592000</span>
</pre></div>
</div>
<p>Where the value is the number of seconds for the period. Setting the value to <code class="docutils literal notranslate"><span class="pre">0</span></code> disables the trash bin.</p>
</section>
<section id="resources-and-rooms">
<h2>Resources and rooms<a class="headerlink" href="#resources-and-rooms" title="Link to this heading"></a></h2>
<p>The Nextcloud CalDAV backend supports resources and rooms. Resources and rooms can be booked for appointments, and the system will schedule them so they can only be used once at a time. Those resources and rooms have to be provided by an app that provides a backend for this.</p>
<p>Once a backend app is installed, the app typically allows admins, or even users, to define the resources, but this is subject of the specific implementation.</p>
<p>Nextcloud periodically queries all registered backends, therefore new/updated resources and rooms will show with a delay.</p>
<section id="known-backends">
<h3>Known backends<a class="headerlink" href="#known-backends" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/nextcloud/calendar_resource_management">Calendar Resource Management</a>: database backend with CLI configuration for admins</p></li>
</ul>
</section>
</section>
<section id="rate-limits">
<h2>Rate limits<a class="headerlink" href="#rate-limits" title="Link to this heading"></a></h2>
<p>Nextcloud rate limits the creation of calendars and subscriptions if too many items are created within a short time frame. The default is 10 calendars or subscriptions per hour. This can be customized as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Set limit to 15 items per 30 minutes</span>
<span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">rateLimitCalendarCreation</span> <span class="o">--</span><span class="nb">type</span><span class="o">=</span><span class="n">integer</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="mi">15</span>
<span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">rateLimitPeriodCalendarCreation</span> <span class="o">--</span><span class="nb">type</span><span class="o">=</span><span class="n">integer</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="mi">1800</span>
</pre></div>
</div>
<p>Additionally, the maximum number of calendars and subscriptions a user may create is limited to 30 items. This can be customized too:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Allow users to create 50 calendars/subscriptions</span>
<span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">maximumCalendarsSubscriptions</span> <span class="o">--</span><span class="nb">type</span><span class="o">=</span><span class="n">integer</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="mi">50</span>
</pre></div>
</div>
<p>or:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Allow users to create calendars/subscriptions without restriction</span>
<span class="n">php</span> <span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">calendar</span> <span class="n">maximumCalendarsSubscriptions</span> <span class="o">--</span><span class="nb">type</span><span class="o">=</span><span class="n">integer</span> <span class="o">--</span><span class="n">value</span><span class="o">=-</span><span class="mi">1</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Groupware" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="contacts.html" class="btn btn-neutral float-right" title="Contacts / CardDAV" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
@@ -0,0 +1,216 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contacts / CardDAV &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Mail" href="mail.html" />
<link rel="prev" title="Calendar / CalDAV" href="calendar.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Groupware</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar / CalDAV</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Contacts / CardDAV</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#system-address-book">System Address Book</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#privacy-and-user-property-scopes">Privacy and User Property Scopes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#address-book-sync">Address Book Sync</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
<li class="toctree-l2"><a class="reference internal" href="out_of_office.html">Out-of-office feature</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">Nextcloud latest Administration Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Groupware</a></li>
<li class="breadcrumb-item active">Contacts / CardDAV</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/groupware/contacts.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="contacts-carddav">
<h1>Contacts / CardDAV<a class="headerlink" href="#contacts-carddav" title="Link to this heading"></a></h1>
<p>Nextcloud ships a CardDAV backend for users to store and share their address books and contacts.</p>
<section id="system-address-book">
<span id="id1"></span><h2>System Address Book<a class="headerlink" href="#system-address-book" title="Link to this heading"></a></h2>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 27: </span>The system address book is now accessible to all Nextcloud users</p>
</div>
<p>Nextcloud maintains a read-only address book containing contact information of all users of the instance.</p>
<p>Disabled users are removed from this address book.</p>
<p>You can disable access to the system address book by using the app config value <code class="docutils literal notranslate"><span class="pre">system_addressbook_exposed</span></code>.</p>
<p>Run <code class="docutils literal notranslate"><span class="pre">occ</span> <span class="pre">config:app:set</span> <span class="pre">dav</span> <span class="pre">system_addressbook_exposed</span> <span class="pre">--value=&quot;no&quot;</span></code> to disable access to the system address book for all users. Please note that this does not influence <a class="reference internal" href="../configuration_files/federated_cloud_sharing_configuration.html#label-direct-share-link"><span class="std std-ref">Federated sharing</span></a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If clients have already connected to the CalDAV endpoint, the clients might experience sync issues after system address book access was disabled. This can often be remedied by chosing a different default address book on the client and forcing a resync.</p>
</div>
<section id="privacy-and-user-property-scopes">
<h3>Privacy and User Property Scopes<a class="headerlink" href="#privacy-and-user-property-scopes" title="Link to this heading"></a></h3>
<p>Contact information in the system address book is taken from users’ <a class="reference internal" href="../configuration_user/profile_configuration.html#profile"><span class="std std-ref">profile information</span></a>. Profile properties are only written to the system contact if the <a class="reference internal" href="../configuration_user/profile_configuration.html#profile-property-scopes"><span class="std std-ref">scope</span></a> is set to <em>Local</em> or higher.</p>
<p>Users who set all their property scopes to <em>Private</em> are removed from the system address book and therefore not seen by other users.</p>
<p><a class="reference internal" href="../configuration_files/file_sharing_configuration.html#file-sharing-configuration"><span class="std std-ref">File sharing settings</span></a> controls the enumeration of other users.</p>
<ul class="simple">
<li><p>If username autocompletion is not allowed, the system address book will only show user’s own system contact but no other contacts.</p></li>
<li><p>If username autocompletion is allowed, users will see contact cards for all other users.</p>
<ul>
<li><p>If autocompletion is limited to users within the same groups, users will see contact cards for other users in shared groups.</p></li>
<li><p>If autocompletion is limited to matching phone numbers, the system address book will only show user’s own system contact but no other contacts.</p></li>
<li><p>If autocompletion is limited to users within the same groups <strong>and</strong> matching phone numbers, users will see contact cards for other users in shared groups.</p></li>
</ul>
</li>
</ul>
</section>
<section id="address-book-sync">
<h3>Address Book Sync<a class="headerlink" href="#address-book-sync" title="Link to this heading"></a></h3>
<p>The address book is updated automatically with every added, modified, disabled or removed user. Admins can also trigger a full rewrite of the address book <a class="reference internal" href="../configuration_server/occ_command.html#occ-dav-sync-system-address-book"><span class="std std-ref">with occ</span></a>.</p>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="calendar.html" class="btn btn-neutral float-left" title="Calendar / CalDAV" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="mail.html" class="btn btn-neutral float-right" title="Mail" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
@@ -0,0 +1,204 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Groupware &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Calendar / CalDAV" href="calendar.html" />
<link rel="prev" title="Retention of files" href="../file_workflows/retention.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Groupware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar / CalDAV</a></li>
<li class="toctree-l2"><a class="reference internal" href="contacts.html">Contacts / CardDAV</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
<li class="toctree-l2"><a class="reference internal" href="out_of_office.html">Out-of-office feature</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">Nextcloud latest Administration Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Groupware</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/groupware/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="groupware">
<h1>Groupware<a class="headerlink" href="#groupware" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="calendar.html">Calendar / CalDAV</a><ul>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#events">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#invitations">Invitations</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#birthday-calendar">Birthday calendar</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#reminder-notifications">Reminder notifications</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#event-alarm-types">Event alarm types</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#freebusy">FreeBusy</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#subscriptions">Subscriptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#trash-bin">Trash bin</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#resources-and-rooms">Resources and rooms</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html#rate-limits">Rate limits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contacts.html">Contacts / CardDAV</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contacts.html#system-address-book">System Address Book</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mail.html">Mail</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mail.html#account-delegation">Account delegation</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html#snooze-and-scheduled-sending">Snooze and scheduled sending</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html#xoauth2-authentication-with-microsoft-azure-ad">XOAUTH2 Authentication with Microsoft Azure AD</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html#mailbox-share">Mailbox Share</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html#thread-summary">Thread Summary</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html#smart-replies">Smart Replies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="out_of_office.html">Out-of-office feature</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../file_workflows/retention.html" class="btn btn-neutral float-left" title="Retention of files" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="calendar.html" class="btn btn-neutral float-right" title="Calendar / CalDAV" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
@@ -0,0 +1,303 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Mail &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Out-of-office feature" href="out_of_office.html" />
<link rel="prev" title="Contacts / CardDAV" href="contacts.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Groupware</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar / CalDAV</a></li>
<li class="toctree-l2"><a class="reference internal" href="contacts.html">Contacts / CardDAV</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Mail</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#account-delegation">Account delegation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#snooze-and-scheduled-sending">Snooze and scheduled sending</a></li>
<li class="toctree-l3"><a class="reference internal" href="#xoauth2-authentication-with-microsoft-azure-ad">XOAUTH2 Authentication with Microsoft Azure AD</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#step-1-open-the-azure-ad-dashboard">Step 1: Open the Azure AD Dashboard</a></li>
<li class="toctree-l4"><a class="reference internal" href="#step-2-create-a-new-app-registration">Step 2: Create a new app registration</a></li>
<li class="toctree-l4"><a class="reference internal" href="#step-3-copy-the-client-id">Step 3: Copy the client ID</a></li>
<li class="toctree-l4"><a class="reference internal" href="#step-4-create-a-new-client-secret">Step 4: Create a new client secret</a></li>
<li class="toctree-l4"><a class="reference internal" href="#step-5-copy-the-client-secret">Step 5: Copy the client secret</a></li>
<li class="toctree-l4"><a class="reference internal" href="#step-6-configure-nextcloud">Step 6: Configure Nextcloud</a></li>
<li class="toctree-l4"><a class="reference internal" href="#step-7-connect-microsoft-outlook-accounts">Step 7: Connect Microsoft Outlook accounts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mailbox-share">Mailbox Share</a></li>
<li class="toctree-l3"><a class="reference internal" href="#thread-summary">Thread Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#smart-replies">Smart Replies</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="out_of_office.html">Out-of-office feature</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">Nextcloud latest Administration Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Groupware</a></li>
<li class="breadcrumb-item active">Mail</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/groupware/mail.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="mail">
<h1>Mail<a class="headerlink" href="#mail" title="Link to this heading"></a></h1>
<section id="account-delegation">
<h2>Account delegation<a class="headerlink" href="#account-delegation" title="Link to this heading"></a></h2>
<p>The Mail app supports account delegation if the delegation is handled by the mail server. That means the mail server has to accept emails sent from an alias address.</p>
<p>In mailcow, for example, the setting is called <em>Also allowed to send as user</em>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Unless paired with shared <em>Sent</em> mailboxes or handled otherwise by the mail server, sent messages will be stored in the sender’s personal <em>Sent</em> mailbox.</p>
</div>
</section>
<section id="snooze-and-scheduled-sending">
<h2>Snooze and scheduled sending<a class="headerlink" href="#snooze-and-scheduled-sending" title="Link to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If AJAX is selected for cron job execution in the admin settings, the snooze feature and scheduled sending are deactivated because of unreliable execution.</p>
</div>
</section>
<section id="xoauth2-authentication-with-microsoft-azure-ad">
<h2>XOAUTH2 Authentication with Microsoft Azure AD<a class="headerlink" href="#xoauth2-authentication-with-microsoft-azure-ad" title="Link to this heading"></a></h2>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
<p>The Mail app supports XOAUTH2 authentication with hosted Microsoft Outlook accounts. An app has to be registered in the Microsoft Azure web interface and its credentials have to be supplied to the Nextcloud instance. You can find relevant settings in the Groupware section of the admin settings.</p>
<section id="step-1-open-the-azure-ad-dashboard">
<h3>Step 1: Open the Azure AD Dashboard<a class="headerlink" href="#step-1-open-the-azure-ad-dashboard" title="Link to this heading"></a></h3>
<p>Visit the <a class="reference external" href="https://portal.azure.com">Azure portal</a> and navigate to the Azure AD dashboard.</p>
<figure class="align-default">
<img alt="../_images/1.png" src="../_images/1.png" />
</figure>
</section>
<section id="step-2-create-a-new-app-registration">
<h3>Step 2: Create a new app registration<a class="headerlink" href="#step-2-create-a-new-app-registration" title="Link to this heading"></a></h3>
<figure class="align-default">
<img alt="../_images/2.png" src="../_images/2.png" />
</figure>
<p>Chose a name, allow organizational and personal Microsoft accounts. Configure a web app and copy the redirect URI from the groupware settings of your Nextcloud instance. Have a look at step 8 on where to find the redirect URI. Finally, click on register to proceed.</p>
<figure class="align-default">
<img alt="../_images/3.png" src="../_images/3.png" />
</figure>
</section>
<section id="step-3-copy-the-client-id">
<h3>Step 3: Copy the client ID<a class="headerlink" href="#step-3-copy-the-client-id" title="Link to this heading"></a></h3>
<p>This ID will be needed later for the Nextcloud settings.</p>
<figure class="align-default">
<img alt="../_images/4.png" src="../_images/4.png" />
</figure>
</section>
<section id="step-4-create-a-new-client-secret">
<h3>Step 4: Create a new client secret<a class="headerlink" href="#step-4-create-a-new-client-secret" title="Link to this heading"></a></h3>
<figure class="align-default">
<img alt="../_images/5.png" src="../_images/5.png" />
</figure>
<p>Chose a descriptive name for the secret and set the an appropriate expiration date. Click on add to create the secret.</p>
<figure class="align-default">
<img alt="../_images/6.png" src="../_images/6.png" />
</figure>
</section>
<section id="step-5-copy-the-client-secret">
<h3>Step 5: Copy the client secret<a class="headerlink" href="#step-5-copy-the-client-secret" title="Link to this heading"></a></h3>
<p>Copy the client secret manually or by clicking on the copy button. You can find it in the value column. The secret will also be needed later for the Nextcloud settings.</p>
<figure class="align-default">
<img alt="../_images/7.png" src="../_images/7.png" />
</figure>
</section>
<section id="step-6-configure-nextcloud">
<h3>Step 6: Configure Nextcloud<a class="headerlink" href="#step-6-configure-nextcloud" title="Link to this heading"></a></h3>
<p>Open the groupware settings in the Nextcloud admin settings and fill in the client ID and client secret. Leave the tenant ID as is (common). You can also find the redirect URI here. Click on save to proceed.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Using a custom tenant ID is not covered by this guide. Only configure it if you are an expert and changed the supported account types in step 2.</p>
</div>
<figure class="align-default">
<img alt="../_images/8.png" src="../_images/8.png" />
</figure>
</section>
<section id="step-7-connect-microsoft-outlook-accounts">
<h3>Step 7: Connect Microsoft Outlook accounts<a class="headerlink" href="#step-7-connect-microsoft-outlook-accounts" title="Link to this heading"></a></h3>
<p>Congratulations! You are now able to use hosted Microsoft Outlook accounts in the Mail app. Use your Microsoft account email and any password when adding your account. The password will be discarded and you will be prompted with a Microsoft consent popup to log in to your account.</p>
<figure class="align-default">
<img alt="../_images/9.png" src="../_images/9.png" />
</figure>
<figure class="align-default">
<img alt="../_images/10.png" src="../_images/10.png" />
</figure>
</section>
</section>
<section id="mailbox-share">
<h2>Mailbox Share<a class="headerlink" href="#mailbox-share" title="Link to this heading"></a></h2>
<p>Users can share mailboxes with each other. So far, there is no UI for users to change the ACL in the Mail app, but if you want to use it, you need to enable it on the IMAP sever and configure the shares there.</p>
</section>
<section id="thread-summary">
<h2>Thread Summary<a class="headerlink" href="#thread-summary" title="Link to this heading"></a></h2>
<p id="mail-thread-summary">The mail app supports summarizing message threads that contain 3 or more messages.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><a class="reference external" href="https://apps.nextcloud.com/apps/integration_openai">A text generation AI integration</a> should be already in place to enable this feature.</p>
</div>
<p>The feature is opt-in, it is disabled by default and can be enabled in mail adminstration settings.</p>
<p>Administration settings &gt; Groupware &gt; Mail app &gt; Enable thread summary</p>
</section>
<section id="smart-replies">
<h2>Smart Replies<a class="headerlink" href="#smart-replies" title="Link to this heading"></a></h2>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.6.0.</span></p>
</div>
<p>The Mail app supports smart replies, based on processing emails with AI.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><a class="reference external" href="https://apps.nextcloud.com/apps/integration_openai">A text generation AI integration</a> has to be available to enable this feature.</p>
</div>
<p>The feature is opt-in, it is disabled by default and can be enabled in Mail adminstration settings.</p>
<p>Administration settings &gt; Groupware &gt; Mail app &gt; Enable smart replies</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contacts.html" class="btn btn-neutral float-left" title="Contacts / CardDAV" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="out_of_office.html" class="btn btn-neutral float-right" title="Out-of-office feature" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Out-of-office feature &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Office" href="../office/index.html" />
<link rel="prev" title="Mail" href="mail.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Groupware</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar / CalDAV</a></li>
<li class="toctree-l2"><a class="reference internal" href="contacts.html">Contacts / CardDAV</a></li>
<li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Out-of-office feature</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">Nextcloud latest Administration Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Groupware</a></li>
<li class="breadcrumb-item active">Out-of-office feature</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/groupware/out_of_office.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="out-of-office-feature">
<h1>Out-of-office feature<a class="headerlink" href="#out-of-office-feature" title="Link to this heading"></a></h1>
<div class="versionadded">
<p><span class="versionmodified added">New in version 28.0.0.</span></p>
</div>
<p>The out-of-office feature allows users to schedule an out-of-office period including a status and
message that is integrated with other apps such as Nextcloud Mail. Please refer to the user
documentation for more information about the feature itself. It may be disabled globally by admins.</p>
<p>The feature relies on users to configure their preferred calendar time zones correctly. However, if
a user does not configure their time zone, the default time zone of the server is used. It can be
configured by setting <code class="docutils literal notranslate"><span class="pre">default_timezone</span></code> in the <cite>config.php</cite> file of your Nextcloud server. The
configuration value accepts IANA identifiers like <code class="docutils literal notranslate"><span class="pre">Europe/Berlin</span></code> and defaults to <code class="docutils literal notranslate"><span class="pre">UTC</span></code>. Please
refer to the <cite>Nextcloud configuration</cite> section for more information about the value.</p>
<p>To disable the out-of-office feature for all users the <code class="docutils literal notranslate"><span class="pre">hide_absence_settings</span></code> app configuration
value of the <cite>dav</cite> app has to be set to <cite>yes</cite>. This can be achieved by running the following
command on your server:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="n">yes</span> <span class="n">dav</span> <span class="n">hide_absence_settings</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Out-of-office periods that were scheduled before the feature was disabled will not be deleted.
Disabling it will only hide the feature from the user interface. If the feature is enabled
again, the periods will be visible again.</p>
</div>
<p>Set the value for <cite>hide_absence_settings</cite> to <cite>no</cite> or delete the configuration option entirely to enable the feature again. The following
command can be used to do so:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="n">no</span> <span class="n">dav</span> <span class="n">hide_absence_settings</span>
</pre></div>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="mail.html" class="btn btn-neutral float-left" title="Mail" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../office/index.html" class="btn btn-neutral float-right" title="Office" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>