Server : Apache/2.4.62 (Unix) OpenSSL/1.0.2k-fips System : Linux server1.richineiserver.com 3.10.0-1160.119.1.el7.x86_64 #1 SMP Tue Jun 4 14:43:51 UTC 2024 x86_64 User : fdshops ( 1003) PHP Version : 8.2.21 Disable Function : NONE Directory : /usr/share/doc/offlineimap-6.7.0/ |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>offlineimap.repository – Email repositories — OfflineIMAP 6.7.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '6.7.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="OfflineIMAP 6.7.0 documentation" href="index.html" />
<link rel="next" title="offlineimap.ui – A flexible logging system" href="ui.html" />
<link rel="prev" title="offlineimap's API documentation" href="API.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="ui.html" title="offlineimap.ui – A flexible logging system"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="API.html" title="offlineimap's API documentation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">OfflineIMAP 6.7.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="offlineimap-repository-email-repositories">
<h1><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.repository</span></tt> – Email repositories<a class="headerlink" href="#offlineimap-repository-email-repositories" title="Permalink to this headline">¶</a></h1>
<p>A derivative of class
<a class="reference internal" href="#offlineimap.repository.Base.BaseRepository" title="offlineimap.repository.Base.BaseRepository"><tt class="xref py py-class docutils literal"><span class="pre">Base.BaseRepository</span></tt></a> represents an email
repository depending on the type of storage, possible options are:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="#offlineimap.repository.IMAPRepository" title="offlineimap.repository.IMAPRepository"><tt class="xref py py-class docutils literal"><span class="pre">IMAPRepository</span></tt></a>,</li>
<li><a class="reference internal" href="#offlineimap.repository.MappedIMAPRepository" title="offlineimap.repository.MappedIMAPRepository"><tt class="xref py py-class docutils literal"><span class="pre">MappedIMAPRepository</span></tt></a></li>
<li><a class="reference internal" href="#offlineimap.repository.GmailRepository" title="offlineimap.repository.GmailRepository"><tt class="xref py py-class docutils literal"><span class="pre">GmailRepository</span></tt></a>,</li>
<li><a class="reference internal" href="#offlineimap.repository.MaildirRepository" title="offlineimap.repository.MaildirRepository"><tt class="xref py py-class docutils literal"><span class="pre">MaildirRepository</span></tt></a>, or</li>
<li><a class="reference internal" href="#offlineimap.repository.LocalStatusRepository" title="offlineimap.repository.LocalStatusRepository"><tt class="xref py py-class docutils literal"><span class="pre">LocalStatusRepository</span></tt></a>.</li>
</ul>
</div></blockquote>
<p>Which class you need depends on your account
configuration. The helper class <a class="reference internal" href="#offlineimap.repository.Repository" title="offlineimap.repository.Repository"><tt class="xref py py-class docutils literal"><span class="pre">offlineimap.repository.Repository</span></tt></a> is
an <em>autoloader</em>, that returns the correct class depending
on your configuration. So when you want to instanciate a new
<tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.repository</span></tt>, you will mostly do it through this class.</p>
<dl class="class">
<dt id="offlineimap.repository.Repository">
<em class="property">class </em><tt class="descname">Repository</tt><big>(</big><em>account</em>, <em>reqtype</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository.html#Repository"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract class that returns the correct Repository type
instance based on ‘account’ and ‘reqtype’, e.g. a
class:<cite>ImapRepository</cite> instance.</p>
<p>Load the correct Repository type and return that. The
__init__ of the corresponding Repository class will be
executed instead of this stub</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>account</strong> – <tt class="xref py py-class docutils literal"><span class="pre">Account</span></tt></li>
<li><strong>regtype</strong> – ‘remote’, ‘local’, or ‘status’</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="offlineimap-repository-base-baserepository-representation-of-a-mail-repository">
<h1><a class="reference internal" href="#offlineimap.repository.Base.BaseRepository" title="offlineimap.repository.Base.BaseRepository"><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.repository.Base.BaseRepository</span></tt></a> – Representation of a mail repository<a class="headerlink" href="#offlineimap-repository-base-baserepository-representation-of-a-mail-repository" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="offlineimap.repository.Base.BaseRepository">
<em class="property">class </em><tt class="descname">BaseRepository</tt><big>(</big><em>reposname</em>, <em>account</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="offlineimap.repository.Base.BaseRepository.accountname">
<tt class="descname">accountname</tt><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.accountname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.accountname" title="Permalink to this definition">¶</a></dt>
<dd><p>Account name as string</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.connect">
<tt class="descname">connect</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Establish a connection to the remote, if necessary. This exists
so that IMAP connections can all be established up front, gathering
passwords as needed. It was added in order to support the
error recovery – we need to connect first outside of the error
trap in order to validate the password, and that’s the point of
this function.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.deletefolder">
<tt class="descname">deletefolder</tt><big>(</big><em>foldername</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.deletefolder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.deletefolder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.dropconnections">
<tt class="descname">dropconnections</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.dropconnections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.dropconnections" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.forgetfolders">
<tt class="descname">forgetfolders</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.forgetfolders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.forgetfolders" title="Permalink to this definition">¶</a></dt>
<dd><p>Forgets the cached list of folders, if any. Useful to run
after a sync run.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.get_create_folders">
<tt class="descname">get_create_folders</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.get_create_folders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.get_create_folders" title="Permalink to this definition">¶</a></dt>
<dd><p>Is folder creation enabled on this repository?</p>
<p>It is disabled by either setting the whole repository
‘readonly’ or by using the ‘createfolders’ setting.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getaccount">
<tt class="descname">getaccount</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getaccount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getaccount" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconf">
<tt class="descname">getconf</tt><big>(</big><em>option</em>, <em>default=<function CustomConfigDefault at 0x1b28c08></em><big>)</big><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconf" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves string from the configuration.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd><ul class="first last simple">
<li>option: option name whose value is to be retrieved;</li>
<li>default: default return value if no such option
exists.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconf_xform">
<tt class="descname">getconf_xform</tt><big>(</big><em>option</em>, <em>xforms</em>, <em>default=<function CustomConfigDefault at 0x1b28c08></em><big>)</big><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconf_xform" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves string from the configuration transforming the result.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd><ul class="first last simple">
<li>option: option name whose value is to be retrieved;</li>
<li>xforms: iterable that returns transform functions
to be applied to the value of the option,
both retrieved and default one;</li>
<li>default: default value for string if no such option
exists.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconfboolean">
<tt class="descname">getconfboolean</tt><big>(</big><em>option</em>, <em>default=<function CustomConfigDefault at 0x1b28c08></em><big>)</big><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconfboolean" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves boolean value from the configuration.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd><ul class="first last simple">
<li>option: option name whose value is to be retrieved;</li>
<li>default: default return value if no such option
exists.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconffloat">
<tt class="descname">getconffloat</tt><big>(</big><em>option</em>, <em>default=<function CustomConfigDefault at 0x1b28c08></em><big>)</big><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconffloat" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves floating-point value from the configuration.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd><ul class="first last simple">
<li>option: option name whose value is to be retrieved;</li>
<li>default: default return value if no such option
exists.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconfig">
<tt class="descname">getconfig</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getconfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconfig" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconfint">
<tt class="descname">getconfint</tt><big>(</big><em>option</em>, <em>default=<function CustomConfigDefault at 0x1b28c08></em><big>)</big><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconfint" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves integer value from the configuration.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd><ul class="first last simple">
<li>option: option name whose value is to be retrieved;</li>
<li>default: default return value if no such option
exists.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getconflist">
<tt class="descname">getconflist</tt><big>(</big><em>option</em>, <em>separator_re</em>, <em>default=<function CustomConfigDefault at 0x1b28c08></em><big>)</big><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getconflist" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves strings from the configuration and splits it
into the list of strings.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd><ul class="first last simple">
<li>option: option name whose value is to be retrieved;</li>
<li>separator_re: regular expression for separator
to be used for split operation;</li>
<li>default: default return value if no such option
exists.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getfolder">
<tt class="descname">getfolder</tt><big>(</big><em>foldername</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getfolder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getfolder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getfolders">
<tt class="descname">getfolders</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getfolders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getfolders" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of ALL folders on this server.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getkeywordmap">
<tt class="descname">getkeywordmap</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getkeywordmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getkeywordmap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getlocaleval">
<tt class="descname">getlocaleval</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getlocaleval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getlocaleval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getlocalroot">
<tt class="descname">getlocalroot</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getlocalroot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getlocalroot" title="Permalink to this definition">¶</a></dt>
<dd><p>Local root folder for storing messages.
Will not be set for remote repositories.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getmapdir">
<tt class="descname">getmapdir</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getmapdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getmapdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getname">
<tt class="descname">getname</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getsection">
<tt class="descname">getsection</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getsection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getsection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getsep">
<tt class="descname">getsep</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getsep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getsep" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.getuiddir">
<tt class="descname">getuiddir</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.getuiddir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.getuiddir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.holdordropconnections">
<tt class="descname">holdordropconnections</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.holdordropconnections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.holdordropconnections" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.makefolder">
<tt class="descname">makefolder</tt><big>(</big><em>foldername</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.makefolder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.makefolder" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new folder.</p>
</dd></dl>
<dl class="attribute">
<dt id="offlineimap.repository.Base.BaseRepository.readonly">
<tt class="descname">readonly</tt><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.readonly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.readonly" title="Permalink to this definition">¶</a></dt>
<dd><p>Is the repository readonly?</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.restore_atime">
<tt class="descname">restore_atime</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.restore_atime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.restore_atime" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets folders’ atime back to their values after a sync</p>
<p>Controlled by the ‘restoreatime’ config parameter (default
False), applies only to local Maildir mailboxes and does nothing
on all other repository types.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.should_sync_folder">
<tt class="descname">should_sync_folder</tt><big>(</big><em>fname</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.should_sync_folder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.should_sync_folder" title="Permalink to this definition">¶</a></dt>
<dd><p>Should this folder be synced?</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.startkeepalive">
<tt class="descname">startkeepalive</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.startkeepalive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.startkeepalive" title="Permalink to this definition">¶</a></dt>
<dd><p>The default implementation will do nothing.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.stopkeepalive">
<tt class="descname">stopkeepalive</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.stopkeepalive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.stopkeepalive" title="Permalink to this definition">¶</a></dt>
<dd><p>Stop keep alive, but don’t bother waiting
for the threads to terminate.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.repository.Base.BaseRepository.sync_folder_structure">
<tt class="descname">sync_folder_structure</tt><big>(</big><em>dst_repo</em>, <em>status_repo</em><big>)</big><a class="reference internal" href="_modules/offlineimap/repository/Base.html#BaseRepository.sync_folder_structure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.repository.Base.BaseRepository.sync_folder_structure" title="Permalink to this definition">¶</a></dt>
<dd><p>Syncs the folders in this repository to those in dest.</p>
<p>It does NOT sync the contents of those folders. nametrans rules
in both directions will be honored, but there are NO checks yet
that forward and backward nametrans actually match up!
Configuring nametrans on BOTH repositories therefore could lead
to infinite folder creation cycles.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="offlineimap.repository.IMAPRepository">
<em class="property">class </em><tt class="descname">IMAPRepository</tt><big>(</big><em>reposname</em>, <em>account</em><big>)</big><a class="headerlink" href="#offlineimap.repository.IMAPRepository" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize an IMAPRepository object.</p>
</dd></dl>
<dl class="class">
<dt id="offlineimap.repository.MappedIMAPRepository">
<em class="property">class </em><tt class="descname">MappedIMAPRepository</tt><big>(</big><em>reposname</em>, <em>account</em><big>)</big><a class="headerlink" href="#offlineimap.repository.MappedIMAPRepository" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize an IMAPRepository object.</p>
</dd></dl>
<dl class="class">
<dt id="offlineimap.repository.GmailRepository">
<em class="property">class </em><tt class="descname">GmailRepository</tt><big>(</big><em>reposname</em>, <em>account</em><big>)</big><a class="headerlink" href="#offlineimap.repository.GmailRepository" title="Permalink to this definition">¶</a></dt>
<dd><p>Gmail IMAP repository.</p>
<p>Falls back to hard-coded gmail host name and port, if none were specified:
<a class="reference external" href="http://mail.google.com/support/bin/answer.py?answer=78799&topic=12814">http://mail.google.com/support/bin/answer.py?answer=78799&topic=12814</a></p>
<p>Initialize a GmailRepository object.</p>
</dd></dl>
<dl class="class">
<dt id="offlineimap.repository.MaildirRepository">
<em class="property">class </em><tt class="descname">MaildirRepository</tt><big>(</big><em>reposname</em>, <em>account</em><big>)</big><a class="headerlink" href="#offlineimap.repository.MaildirRepository" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize a MaildirRepository object. Takes a path name
to the directory holding all the Maildir directories.</p>
</dd></dl>
<dl class="class">
<dt id="offlineimap.repository.LocalStatusRepository">
<em class="property">class </em><tt class="descname">LocalStatusRepository</tt><big>(</big><em>reposname</em>, <em>account</em><big>)</big><a class="headerlink" href="#offlineimap.repository.LocalStatusRepository" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="offlineimap-folder-basic-representation-of-a-local-or-remote-mail-folder">
<h1><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.folder</span></tt> – Basic representation of a local or remote Mail folder<a class="headerlink" href="#offlineimap-folder-basic-representation-of-a-local-or-remote-mail-folder" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="offlineimap.folder.Base.BaseFolder">
<em class="property">class </em><tt class="descname">BaseFolder</tt><big>(</big><em>name</em>, <em>repository</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Path & name of folder minus root or reference</li>
<li><strong>repository</strong> – Repository() in which the folder is.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="offlineimap.folder.Base.BaseFolder.accountname">
<tt class="descname">accountname</tt><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.accountname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.accountname" title="Permalink to this definition">¶</a></dt>
<dd><p>Account name as string</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.addmessageflags">
<tt class="descname">addmessageflags</tt><big>(</big><em>uid</em>, <em>flags</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.addmessageflags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.addmessageflags" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds the specified flags to the message’s flag set. If a given
flag is already present, it will not be duplicated.</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flags</strong> – A set() of flags</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.addmessageheader">
<tt class="descname">addmessageheader</tt><big>(</big><em>content</em>, <em>linebreak</em>, <em>headername</em>, <em>headervalue</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.addmessageheader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.addmessageheader" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds new header to the provided message.</p>
<blockquote>
<div><p>WARNING: This function is a bit tricky, and modifying it in the wrong way,
may easily lead to data-loss.</p>
<p>Arguments:
- content: message content, headers and body as a single string
- linebreak: string that carries line ending
- headername: name of the header to add
- headervalue: value of the header to add</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The following documentation will not get displayed correctly after being
processed by Sphinx. View the source of this method to read it.</p>
</div>
<p>This has to deal with strange corner cases where the header is
missing or empty. Here are illustrations for all the cases,
showing where the header gets inserted and what the end result
is. In each illustration, ‘+’ means the added contents. Note
that these examples assume LF for linebreak, not CRLF, so ‘</p>
</div></blockquote>
<dl class="docutils">
<dt>‘</dt>
<dd>denotes a linebreak and ‘</dd>
<dt>‘ corresponds to the transition</dt>
<dd>between header and body. However if the linebreak parameter
is set to ‘</dd>
</dl>
<p>‘ then you would have to substitute ‘
‘ for</p>
<blockquote>
<div>‘</div></blockquote>
<p>‘ in the below examples.</p>
<blockquote>
<div><ul class="simple">
<li>Case 1: No ‘</li>
</ul>
</div></blockquote>
<p>‘, leading ‘
‘</p>
<blockquote>
<div><blockquote>
<div><p>+X-Flying-Pig-Header: i am here</p>
<p>This is the body</p>
<p>next line</p>
</div></blockquote>
<ul class="simple">
<li>Case 2: ‘</li>
</ul>
</div></blockquote>
<p>‘ at position 0</p>
<blockquote>
<div><blockquote>
<div><p>+X-Flying-Pig-Header: i am here</p>
<p>This is the body</p>
<p>next line</p>
</div></blockquote>
<ul class="simple">
<li>Case 3: No ‘</li>
</ul>
</div></blockquote>
<p>‘, no leading ‘
‘</p>
<blockquote>
<div><blockquote>
<div><p>+X-Flying-Pig-Header: i am here</p>
<ul class="simple">
<li></li>
</ul>
<p>This is the body</p>
<p>next line</p>
</div></blockquote>
<ul class="simple">
<li>Case 4: ‘</li>
</ul>
</div></blockquote>
<p>‘ at non-zero position</p>
<blockquote>
<div><p>Subject: Something wrong with OI</p>
<p>From: <a class="reference external" href="mailto:some%40person.at">some<span>@</span>person<span>.</span>at</a>
+</p>
</div></blockquote>
<p>X-Flying-Pig-Header: i am here</p>
<blockquote>
<div><p>This is the body</p>
<p>next line</p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.addmessagelabels">
<tt class="descname">addmessagelabels</tt><big>(</big><em>uid</em>, <em>labels</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.addmessagelabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.addmessagelabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds the specified labels to the message’s labels set. If a given
label is already present, it will not be duplicated.</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>labels</strong> – A set() of labels</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.addmessagesflags">
<tt class="descname">addmessagesflags</tt><big>(</big><em>uidlist</em>, <em>flags</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.addmessagesflags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.addmessagesflags" title="Permalink to this definition">¶</a></dt>
<dd><p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.addmessageslabels">
<tt class="descname">addmessageslabels</tt><big>(</big><em>uidlist</em>, <em>labels</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.addmessageslabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.addmessageslabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.cachemessagelist">
<tt class="descname">cachemessagelist</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.cachemessagelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.cachemessagelist" title="Permalink to this definition">¶</a></dt>
<dd><p>Reads the message list from disk or network and stores it in
memory for later use. This list will not be re-read from disk or
memory unless this function is called again.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.change_message_uid">
<tt class="descname">change_message_uid</tt><big>(</big><em>uid</em>, <em>new_uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.change_message_uid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.change_message_uid" title="Permalink to this definition">¶</a></dt>
<dd><p>Change the message from existing uid to new_uid</p>
<p>If the backend supports it (IMAP does not).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>new_uid</strong> – (optional) If given, the old UID will be changed
to a new UID. This allows backends efficient renaming of
messages if the UID has changed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.check_uidvalidity">
<tt class="descname">check_uidvalidity</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.check_uidvalidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.check_uidvalidity" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests if the cached UIDVALIDITY match the real current one</p>
<p>If required it saves the UIDVALIDITY value. In this case the
function is not threadsafe. So don’t attempt to call it from
concurrent threads.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Boolean indicating the match. Returns True in case it
implicitely saved the UIDVALIDITY.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.combine_flags_and_keywords">
<tt class="descname">combine_flags_and_keywords</tt><big>(</big><em>uid</em>, <em>dstfolder</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.combine_flags_and_keywords"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.combine_flags_and_keywords" title="Permalink to this definition">¶</a></dt>
<dd><p>Combine the message’s flags and keywords using the mapping for the
destination folder.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.copymessageto">
<tt class="descname">copymessageto</tt><big>(</big><em>uid</em>, <em>dstfolder</em>, <em>statusfolder</em>, <em>register=1</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.copymessageto"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.copymessageto" title="Permalink to this definition">¶</a></dt>
<dd><p>Copies a message from self to dst if needed, updating the status</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>uid</strong> – uid of the message to be copied.</li>
<li><strong>dstfolder</strong> – A BaseFolder-derived instance</li>
<li><strong>statusfolder</strong> – A LocalStatusFolder instance</li>
<li><strong>register</strong> – whether we should register a new thread.”</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Nothing on success, or raises an Exception.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessage">
<tt class="descname">deletemessage</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessage" title="Permalink to this definition">¶</a></dt>
<dd><p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessageflags">
<tt class="descname">deletemessageflags</tt><big>(</big><em>uid</em>, <em>flags</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessageflags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessageflags" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes each flag given from the message’s flag set. If a given
flag is already removed, no action will be taken for that flag.</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessageheaders">
<tt class="descname">deletemessageheaders</tt><big>(</big><em>content</em>, <em>header_list</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessageheaders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessageheaders" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes headers in the given list from the message content.</p>
<blockquote>
<div><p>Arguments:
- content: message itself
- header_list: list of headers to be deleted or just the header name</p>
<p>We expect our message to have ‘</p>
</div></blockquote>
<p>‘ as line endings.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessagelabels">
<tt class="descname">deletemessagelabels</tt><big>(</big><em>uid</em>, <em>labels</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessagelabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessagelabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes each label given from the message’s label set. If a given
label is already removed, no action will be taken for that label.</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessages">
<tt class="descname">deletemessages</tt><big>(</big><em>uidlist</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessages" title="Permalink to this definition">¶</a></dt>
<dd><p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessagesflags">
<tt class="descname">deletemessagesflags</tt><big>(</big><em>uidlist</em>, <em>flags</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessagesflags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessagesflags" title="Permalink to this definition">¶</a></dt>
<dd><p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.deletemessageslabels">
<tt class="descname">deletemessageslabels</tt><big>(</big><em>uidlist</em>, <em>labels</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.deletemessageslabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.deletemessageslabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.dropmessagelistcache">
<tt class="descname">dropmessagelistcache</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.dropmessagelistcache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.dropmessagelistcache" title="Permalink to this definition">¶</a></dt>
<dd><p>Empty everythings we know about messages.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.get_min_uid_file">
<tt class="descname">get_min_uid_file</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.get_min_uid_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.get_min_uid_file" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.get_saveduidvalidity">
<tt class="descname">get_saveduidvalidity</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.get_saveduidvalidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.get_saveduidvalidity" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the previously cached UIDVALIDITY value</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">UIDVALIDITY as (long) number or None, if None had been
saved yet.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.get_uidvalidity">
<tt class="descname">get_uidvalidity</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.get_uidvalidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.get_uidvalidity" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the current connections UIDVALIDITY value</p>
<p>This function needs to be implemented by each Backend
:returns: UIDVALIDITY as a (long) number</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getcopyinstancelimit">
<tt class="descname">getcopyinstancelimit</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getcopyinstancelimit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getcopyinstancelimit" title="Permalink to this definition">¶</a></dt>
<dd><p>For threading folders, returns the instancelimitname for
InstanceLimitedThreads.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getexplainedname">
<tt class="descname">getexplainedname</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getexplainedname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getexplainedname" title="Permalink to this definition">¶</a></dt>
<dd><p>Name that shows both real and nametrans-mangled values.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getfolderbasename">
<tt class="descname">getfolderbasename</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getfolderbasename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getfolderbasename" title="Permalink to this definition">¶</a></dt>
<dd><p>Return base file name of file to store Status/UID info in.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getfullname">
<tt class="descname">getfullname</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getfullname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getfullname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmaxage">
<tt class="descname">getmaxage</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmaxage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmaxage" title="Permalink to this definition">¶</a></dt>
<dd><p>maxage is allowed to be either an integer or a date of the
form YYYY-mm-dd. This returns a time_struct.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmaxsize">
<tt class="descname">getmaxsize</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmaxsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmaxsize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessage">
<tt class="descname">getmessage</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessage" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the content of the specified message.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessagecount">
<tt class="descname">getmessagecount</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessagecount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessagecount" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the number of messages.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessageflags">
<tt class="descname">getmessageflags</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessageflags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessageflags" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the flags for the specified message.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessageheader">
<tt class="descname">getmessageheader</tt><big>(</big><em>content</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessageheader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessageheader" title="Permalink to this definition">¶</a></dt>
<dd><p>Searches for the first occurence of the given header and returns
its value. Header name is case-insensitive.</p>
<p>Arguments:
- contents: message itself
- name: name of the header to be searched</p>
<p>Returns: header value or None if no such header was found</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessageheaderlist">
<tt class="descname">getmessageheaderlist</tt><big>(</big><em>content</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessageheaderlist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessageheaderlist" title="Permalink to this definition">¶</a></dt>
<dd><p>Searches for the given header and returns a list of values for
that header.</p>
<p>Arguments:
- contents: message itself
- name: name of the header to be searched</p>
<p>Returns: list of header values or emptylist if no such header was found</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessagekeywords">
<tt class="descname">getmessagekeywords</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessagekeywords"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessagekeywords" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the keywords for the specified message.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessagelabels">
<tt class="descname">getmessagelabels</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessagelabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessagelabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the labels for the specified message.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessagelist">
<tt class="descname">getmessagelist</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessagelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessagelist" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the current message list.</p>
<p>You must call cachemessagelist() before calling this function!</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessagemtime">
<tt class="descname">getmessagemtime</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessagemtime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessagemtime" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the message modification time of the specified message.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessagetime">
<tt class="descname">getmessagetime</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessagetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessagetime" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the received time for the specified message.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getmessageuidlist">
<tt class="descname">getmessageuidlist</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getmessageuidlist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getmessageuidlist" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a list of UIDs.</p>
<p>You may have to call cachemessagelist() before calling this function!</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getname">
<tt class="descname">getname</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getname" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns name</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getrepository">
<tt class="descname">getrepository</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getrepository"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getrepository" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the repository object that this folder is within.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getroot">
<tt class="descname">getroot</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getroot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getroot" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the root of the folder, in a folder-specific fashion.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getsep">
<tt class="descname">getsep</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getsep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getsep" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the separator for this folder type.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getstartdate">
<tt class="descname">getstartdate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getstartdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getstartdate" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the value of the configuration option startdate</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.getvisiblename">
<tt class="descname">getvisiblename</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.getvisiblename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.getvisiblename" title="Permalink to this definition">¶</a></dt>
<dd><p>The nametrans-transposed name of the folder’s name.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.ismessagelistempty">
<tt class="descname">ismessagelistempty</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.ismessagelistempty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.ismessagelistempty" title="Permalink to this definition">¶</a></dt>
<dd><p>Empty everythings we know about messages.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.msglist_item_initializer">
<tt class="descname">msglist_item_initializer</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.msglist_item_initializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.msglist_item_initializer" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns value for empty messagelist element with given UID.</p>
<p>This function must initialize all fields of messagelist item
and must be called every time when one creates new messagelist
entry to ensure that all fields that must be present are present.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.quickchanged">
<tt class="descname">quickchanged</tt><big>(</big><em>statusfolder</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.quickchanged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.quickchanged" title="Permalink to this definition">¶</a></dt>
<dd><p>Runs quick check for folder changes and returns changed
status: True – changed, False – not changed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>statusfolder</strong> – keeps track of the last known folder state.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.retrieve_min_uid">
<tt class="descname">retrieve_min_uid</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.retrieve_min_uid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.retrieve_min_uid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.save_uidvalidity">
<tt class="descname">save_uidvalidity</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.save_uidvalidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.save_uidvalidity" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the UIDVALIDITY value of the folder to the cache</p>
<p>This function is not threadsafe, so don’t attempt to call it
from concurrent threads.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.savemessage">
<tt class="descname">savemessage</tt><big>(</big><em>uid</em>, <em>content</em>, <em>flags</em>, <em>rtime</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.savemessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.savemessage" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes a new message, with the specified uid.</p>
<dl class="docutils">
<dt>If the uid is < 0: The backend should assign a new uid and</dt>
<dd><p class="first">return it. In case it cannot assign a new uid, it returns
the negative uid passed in WITHOUT saving the message.</p>
<p>If the backend CAN assign a new uid, but cannot find out what
this UID is (as is the case with some IMAP servers), it
returns 0 but DOES save the message.</p>
<p class="last">IMAP backend should be the only one that can assign a new
uid.</p>
</dd>
<dt>If the uid is > 0, the backend should set the uid to this, if it can.</dt>
<dd>If it cannot set the uid to that, it will save it anyway.
It will return the uid assigned in any case.</dd>
</dl>
<p>Note that savemessage() does not check against dryrun settings,
so you need to ensure that savemessage is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.savemessageflags">
<tt class="descname">savemessageflags</tt><big>(</big><em>uid</em>, <em>flags</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.savemessageflags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.savemessageflags" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the specified message’s flags to the given set.</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.savemessagelabels">
<tt class="descname">savemessagelabels</tt><big>(</big><em>uid</em>, <em>labels</em>, <em>ignorelabels=set([])</em>, <em>mtime=0</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.savemessagelabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.savemessagelabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the specified message’s labels to the given set.</p>
<p>Note that this function does not check against dryrun settings,
so you need to ensure that it is never called in a
dryrun mode.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.storesmessages">
<tt class="descname">storesmessages</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.storesmessages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.storesmessages" title="Permalink to this definition">¶</a></dt>
<dd><p>Should be true for any backend that actually saves message bodies.
(Almost all of them). False for the LocalStatus backend. Saves
us from having to slurp up messages just for localstatus purposes.</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.suggeststhreads">
<tt class="descname">suggeststhreads</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.suggeststhreads"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.suggeststhreads" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if this folder suggests using threads for actions;
false otherwise. Probably only IMAP will return true.</p>
</dd></dl>
<dl class="attribute">
<dt id="offlineimap.folder.Base.BaseFolder.sync_this">
<tt class="descname">sync_this</tt><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.sync_this"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.sync_this" title="Permalink to this definition">¶</a></dt>
<dd><p>Should this folder be synced or is it e.g. filtered out?</p>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.syncmessagesto">
<tt class="descname">syncmessagesto</tt><big>(</big><em>dstfolder</em>, <em>statusfolder</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.syncmessagesto"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.syncmessagesto" title="Permalink to this definition">¶</a></dt>
<dd><p>Syncs messages in this folder to the destination dstfolder.</p>
<p>This is the high level entry for syncing messages in one direction.
Syncsteps are:</p>
<dl class="docutils">
<dt>Pass1: Copy locally existing messages</dt>
<dd>Copy messages in self, but not statusfolder to dstfolder if not
already in dstfolder. dstfolder might assign a new UID (e.g. if
uploading to IMAP). Update statusfolder.</dd>
<dt>Pass2: Remove locally deleted messages</dt>
<dd><p class="first">Get all UIDS in statusfolder but not self. These are messages
that were deleted in ‘self’. Delete those from dstfolder and
statusfolder.</p>
<p class="last">After this pass, the message lists should be identical wrt the
uids present (except for potential negative uids that couldn’t
be placed anywhere).</p>
</dd>
<dt>Pass3: Synchronize flag changes</dt>
<dd>Compare flag mismatches in self with those in statusfolder. If
msg has a valid UID and exists on dstfolder (has not e.g. been
deleted there), sync the flag change to both dstfolder and
statusfolder.</dd>
<dt>Pass4: Synchronize label changes (Gmail only)</dt>
<dd>Compares label mismatches in self with those in statusfolder.
If msg has a valid UID and exists on dstfolder, syncs the labels
to both dstfolder and statusfolder.</dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>dstfolder</strong> – Folderinstance to sync the msgs to.</li>
<li><strong>statusfolder</strong> – LocalStatus instance to sync against.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.uidexists">
<tt class="descname">uidexists</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.uidexists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.uidexists" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if uid exists</p>
</dd></dl>
<dl class="attribute">
<dt id="offlineimap.folder.Base.BaseFolder.utime_from_header">
<tt class="descname">utime_from_header</tt><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.utime_from_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.utime_from_header" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="offlineimap.folder.Base.BaseFolder.waitforthread">
<tt class="descname">waitforthread</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/offlineimap/folder/Base.html#BaseFolder.waitforthread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.folder.Base.BaseFolder.waitforthread" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements method that waits for thread to be usable.
Should be implemented only for folders that suggest threads.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><tt class="docutils literal"><span class="pre">offlineimap.repository</span></tt> – Email repositories</a></li>
<li><a class="reference internal" href="#offlineimap-repository-base-baserepository-representation-of-a-mail-repository"><tt class="docutils literal"><span class="pre">offlineimap.repository.Base.BaseRepository</span></tt> – Representation of a mail repository</a></li>
<li><a class="reference internal" href="#offlineimap-folder-basic-representation-of-a-local-or-remote-mail-folder"><tt class="docutils literal"><span class="pre">offlineimap.folder</span></tt> – Basic representation of a local or remote Mail folder</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="API.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">offlineimap's</span></tt> API documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ui.html"
title="next chapter"><tt class="docutils literal"><span class="pre">offlineimap.ui</span></tt> – A flexible logging system</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/repository.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="ui.html" title="offlineimap.ui – A flexible logging system"
>next</a> |</li>
<li class="right" >
<a href="API.html" title="offlineimap's API documentation"
>previous</a> |</li>
<li><a href="index.html">OfflineIMAP 6.7.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Copyright 2002-2016 John Goerzen & contributors.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>