MINI MINI MANI MO

Path : /usr/share/doc/offlineimap-6.7.0/
File Upload :
Current File : //usr/share/doc/offlineimap-6.7.0/API.html


<!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&#39;s API documentation &mdash; 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.repository – Email repositories" href="repository.html" />
    <link rel="prev" title="Welcome to OfflineIMAP’s developer documentation" href="index.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="repository.html" title="offlineimap.repository – Email repositories"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to OfflineIMAP’s developer documentation"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">OfflineIMAP 6.7.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="offlineimap-s-api-documentation">
<span id="api-docs"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap's</span></tt> API documentation<a class="headerlink" href="#offlineimap-s-api-documentation" title="Permalink to this headline">¶</a></h1>
<p>Within <a class="reference internal" href="#module-offlineimap" title="offlineimap"><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap</span></tt></a>, the classes <a class="reference internal" href="#offlineimap.OfflineImap" title="offlineimap.OfflineImap"><tt class="xref py py-class docutils literal"><span class="pre">OfflineImap</span></tt></a> provides the
high-level functionality. The rest of the classes should usually not needed to
be touched by the user. Email repositories are represented by a
<a class="reference internal" href="repository.html#offlineimap.repository.Base.BaseRepository" title="offlineimap.repository.Base.BaseRepository"><tt class="xref py py-class docutils literal"><span class="pre">offlineimap.repository.Base.BaseRepository</span></tt></a> or derivatives (see
<tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.repository</span></tt> for details). A folder within a repository is
represented by a <a class="reference internal" href="repository.html#offlineimap.folder.Base.BaseFolder" title="offlineimap.folder.Base.BaseFolder"><tt class="xref py py-class docutils literal"><span class="pre">offlineimap.folder.Base.BaseFolder</span></tt></a> or any derivative
from <tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.folder</span></tt>.</p>
<p>This page contains the main API overview of OfflineImap 6.7.0.</p>
<p>OfflineImap can be imported as:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">offlineimap</span> <span class="kn">import</span> <span class="n">OfflineImap</span>
</pre></div>
</div>
</div>
<div class="section" id="module-offlineimap">
<span id="offlineimap-the-offlineimap-module"></span><h1><a class="reference internal" href="#module-offlineimap" title="offlineimap"><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap</span></tt></a> &#8211; The OfflineImap module<a class="headerlink" href="#module-offlineimap" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="offlineimap.OfflineImap">
<em class="property">class </em><tt class="descname">OfflineImap</tt><big>(</big><em>cmdline_opts = None</em><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap" title="Permalink to this definition">¶</a></dt>
<dd><p>The main class that encapsulates the high level use of OfflineImap.</p>
<p>To invoke OfflineImap you would call it with:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">oi</span> <span class="o">=</span> <span class="n">OfflineImap</span><span class="p">()</span>
<span class="n">oi</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
</pre></div>
</div>
<dl class="method">
<dt id="offlineimap.OfflineImap._OfflineImap__dumpstacks">
<tt class="descname">_OfflineImap__dumpstacks</tt><big>(</big><em>context=1</em>, <em>sighandler_deep=2</em><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap._OfflineImap__dumpstacks" title="Permalink to this definition">¶</a></dt>
<dd><p>Signal handler: dump a stack trace for each existing thread.</p>
</dd></dl>

<dl class="method">
<dt id="offlineimap.OfflineImap._OfflineImap__migratefmd5">
<tt class="descname">_OfflineImap__migratefmd5</tt><big>(</big><em>options</em><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap._OfflineImap__migratefmd5" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="offlineimap.OfflineImap._OfflineImap__parse_cmd_options">
<tt class="descname">_OfflineImap__parse_cmd_options</tt><big>(</big><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap._OfflineImap__parse_cmd_options" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="offlineimap.OfflineImap._OfflineImap__serverdiagnostics">
<tt class="descname">_OfflineImap__serverdiagnostics</tt><big>(</big><em>options</em><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap._OfflineImap__serverdiagnostics" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="offlineimap.OfflineImap._OfflineImap__sync">
<tt class="descname">_OfflineImap__sync</tt><big>(</big><em>options</em><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap._OfflineImap__sync" title="Permalink to this definition">¶</a></dt>
<dd><p>Invoke the correct single/multithread syncing</p>
<p>self.config is supposed to have been correctly initialized
already.</p>
</dd></dl>

<dl class="method">
<dt id="offlineimap.OfflineImap._OfflineImap__sync_singlethreaded">
<tt class="descname">_OfflineImap__sync_singlethreaded</tt><big>(</big><em>accs</em><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap._OfflineImap__sync_singlethreaded" title="Permalink to this definition">¶</a></dt>
<dd><p>Executed if we do not want a separate syncmaster thread</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>accs</strong> &#8211; A list of accounts that should be synced</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="offlineimap.OfflineImap.run">
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#offlineimap.OfflineImap.run" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the commandline and invoke everything</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="offlineimap-account">
<h1><tt class="xref py py-class docutils literal"><span class="pre">offlineimap.account</span></tt><a class="headerlink" href="#offlineimap-account" title="Permalink to this headline">¶</a></h1>
<p>An <a class="reference internal" href="#offlineimap.accounts.Account" title="offlineimap.accounts.Account"><tt class="xref py py-class docutils literal"><span class="pre">accounts.Account</span></tt></a> connects two email repositories that are to be
synced. It comes in two flavors, normal and syncable.</p>
<dl class="class">
<dt id="offlineimap.accounts.Account">
<em class="property">class </em><tt class="descname">Account</tt><big>(</big><em>config</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/offlineimap/accounts.html#Account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.accounts.Account" title="Permalink to this definition">¶</a></dt>
<dd><p>Represents an account (ie. 2 repositories) to sync.</p>
<p>Most of the time you will actually want to use the derived
<a class="reference internal" href="#offlineimap.accounts.SyncableAccount" title="offlineimap.accounts.SyncableAccount"><tt class="xref py py-class docutils literal"><span class="pre">accounts.SyncableAccount</span></tt></a> which contains all functions used
for syncing an account.</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>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">offlineimap.CustomConfig.CustomConfigParser</span></tt>) &#8211; Representing the offlineimap configuration file.</li>
<li><strong>name</strong> &#8211; A (str) string denoting the name of the Account
as configured.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="offlineimap.accounts.SyncableAccount">
<em class="property">class </em><tt class="descname">SyncableAccount</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/offlineimap/accounts.html#SyncableAccount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.accounts.SyncableAccount" title="Permalink to this definition">¶</a></dt>
<dd><p>A syncable email account connecting 2 repositories.</p>
<p>Derives from <a class="reference internal" href="#offlineimap.accounts.Account" title="offlineimap.accounts.Account"><tt class="xref py py-class docutils literal"><span class="pre">accounts.Account</span></tt></a> but contains the additional
functions <tt class="xref py py-meth docutils literal"><span class="pre">syncrunner()</span></tt>, <tt class="xref py py-meth docutils literal"><span class="pre">sync()</span></tt>, <tt class="xref py py-meth docutils literal"><span class="pre">syncfolders()</span></tt>,
used for syncing.</p>
<dl class="data">
<dt id="offlineimap.SyncableAccount.ui">
<tt class="descname">ui</tt><em class="property"> = &lt;module 'offlineimap.ui' from '/builddir/build/BUILD/offlineimap-6.7.0/offlineimap/ui/__init__.pyc'&gt;</em><a class="headerlink" href="#offlineimap.SyncableAccount.ui" title="Permalink to this definition">¶</a></dt>
<dd><p>Contains the current <tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.ui</span></tt>, and can be used for logging etc.</p>
</dd></dl>

<dl class="method">
<dt id="offlineimap.accounts.SyncableAccount.get_abort_event">
<tt class="descname">get_abort_event</tt><big>(</big><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.get_abort_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if an abort signal had been sent.</p>
<p>If the &#8216;skipsleep&#8217; config option for this account had been set,
with <cite>set_abort_event(config, 1)</cite> it will get cleared in this
function. Ie, we will only skip one sleep and not all.</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">True, if the main thread had called
<tt class="xref py py-meth docutils literal"><span class="pre">set_abort_event()</span></tt> earlier, otherwise &#8216;False&#8217;.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="offlineimap.accounts.SyncableAccount.get_local_folder">
<tt class="descname">get_local_folder</tt><big>(</big><em>remotefolder</em><big>)</big><a class="reference internal" href="_modules/offlineimap/accounts.html#SyncableAccount.get_local_folder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.get_local_folder" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding local folder for a given remotefolder.</p>
</dd></dl>

<dl class="method">
<dt id="offlineimap.accounts.SyncableAccount.getconf">
<tt class="descname">getconf</tt><big>(</big><em>option</em>, <em>default=&lt;function CustomConfigDefault at 0x1b28c08&gt;</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.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.accounts.SyncableAccount.getconf_xform">
<tt class="descname">getconf_xform</tt><big>(</big><em>option</em>, <em>xforms</em>, <em>default=&lt;function CustomConfigDefault at 0x1b28c08&gt;</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.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.accounts.SyncableAccount.getconfboolean">
<tt class="descname">getconfboolean</tt><big>(</big><em>option</em>, <em>default=&lt;function CustomConfigDefault at 0x1b28c08&gt;</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.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.accounts.SyncableAccount.getconffloat">
<tt class="descname">getconffloat</tt><big>(</big><em>option</em>, <em>default=&lt;function CustomConfigDefault at 0x1b28c08&gt;</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.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.accounts.SyncableAccount.getconfint">
<tt class="descname">getconfint</tt><big>(</big><em>option</em>, <em>default=&lt;function CustomConfigDefault at 0x1b28c08&gt;</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.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.accounts.SyncableAccount.getconflist">
<tt class="descname">getconflist</tt><big>(</big><em>option</em>, <em>separator_re</em>, <em>default=&lt;function CustomConfigDefault at 0x1b28c08&gt;</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.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.accounts.SyncableAccount.serverdiagnostics">
<tt class="descname">serverdiagnostics</tt><big>(</big><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.serverdiagnostics" title="Permalink to this definition">¶</a></dt>
<dd><p>Output diagnostics for all involved repositories.</p>
</dd></dl>

<dl class="classmethod">
<dt id="offlineimap.accounts.SyncableAccount.set_abort_event">
<em class="property">classmethod </em><tt class="descname">set_abort_event</tt><big>(</big><em>config</em>, <em>signum</em><big>)</big><a class="headerlink" href="#offlineimap.accounts.SyncableAccount.set_abort_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Set skip sleep/abort event for all accounts.</p>
<p>If we want to skip a current (or the next) sleep, or if we want
to abort an autorefresh loop, the main thread can use
set_abort_event() to send the corresponding signal. Signum = 1
implies that we want all accounts to abort or skip the current
or next sleep phase. Signum = 2 will end the autorefresh loop,
ie all accounts will return after they finished a sync. signum=3
means, abort NOW, e.g. on SIGINT or SIGTERM.</p>
<p>This is a class method, it will send the signal to all accounts.</p>
</dd></dl>

</dd></dl>

<div class="section" id="offlineimaperror-a-notmuch-execution-error">
<h2><tt class="xref py py-exc docutils literal"><span class="pre">OfflineImapError</span></tt> &#8211; A Notmuch execution error<a class="headerlink" href="#offlineimaperror-a-notmuch-execution-error" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="offlineimap.error.OfflineImapError">
<em class="property">exception </em><tt class="descname">OfflineImapError</tt><big>(</big><em>reason</em>, <em>severity</em>, <em>errcode=None</em><big>)</big><a class="reference internal" href="_modules/offlineimap/error.html#OfflineImapError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.error.OfflineImapError" title="Permalink to this definition">¶</a></dt>
<dd><p>An Error during offlineimap synchronization</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>reason</strong> &#8211; Human readable string suitable for logging</li>
<li><strong>severity</strong> (<em>OfflineImapError.ERROR value</em>) &#8211; denoting which operations should be
aborted. E.g. a ERROR.MESSAGE can occur on a faulty
message, but a ERROR.REPO occurs when the server is
offline.</li>
<li><strong>errcode</strong> &#8211; optional number denoting a predefined error
situation (which let&#8217;s us exit with a predefined exit
value). So far, no errcodes have been defined yet.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>This exception inherits directly from <tt class="xref py py-exc docutils literal"><span class="pre">Exception</span></tt> and is raised
on errors during the offlineimap execution. It has an attribute
<cite>severity</cite> that denotes the severity level of the error.</p>
<dl class="class">
<dt id="offlineimap.error.OfflineImapError.ERROR">
<em class="property">class </em><tt class="descname">ERROR</tt><a class="reference internal" href="_modules/offlineimap/error.html#OfflineImapError.ERROR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.error.OfflineImapError.ERROR" title="Permalink to this definition">¶</a></dt>
<dd><p>Severity level of an Exception</p>
<ul class="simple">
<li><strong>MESSAGE</strong>:  Abort the current message, but continue with folder</li>
<li><strong>FOLDER_RETRY</strong>: Error syncing folder, but do retry</li>
<li><strong>FOLDER</strong>:   Abort folder sync, but continue with next folder</li>
<li><strong>REPO</strong>:     Abort repository sync, continue with next account</li>
<li><strong>CRITICAL</strong>: Immediately exit offlineimap</li>
</ul>
</dd></dl>

</dd></dl>

</div>
</div>
<div class="section" id="offlineimap-globals-module-with-global-variables">
<h1><a class="reference internal" href="#module-offlineimap.globals" title="offlineimap.globals"><tt class="xref py py-mod docutils literal"><span class="pre">offlineimap.globals</span></tt></a> &#8211; module with global variables<a class="headerlink" href="#offlineimap-globals-module-with-global-variables" title="Permalink to this headline">¶</a></h1>
<p>Module <cite>offlineimap.globals</cite> provides the read-only storage
for the global variables.</p>
<p>All exported module attributes can be set manually, but this practice
is highly discouraged and shouldn&#8217;t be used.
However, attributes of all stored variables can only be read, write
access to them is denied.</p>
<p>Currently, we have only <tt class="xref py py-attr docutils literal"><span class="pre">options</span></tt> attribute that holds
command-line options as returned by OptionParser.
The value of <tt class="xref py py-attr docutils literal"><span class="pre">options</span></tt> must be set by <tt class="xref py py-func docutils literal"><span class="pre">set_options()</span></tt>
prior to its first use.</p>
<span class="target" id="module-offlineimap.globals"></span><dl class="data">
<dt id="offlineimap.globals.options">
<tt class="descname">options</tt><a class="headerlink" href="#offlineimap.globals.options" title="Permalink to this definition">¶</a></dt>
<dd><p>You can access the values of stored options using the usual
syntax, offlineimap.globals.options.&lt;option-name&gt;</p>
</dd></dl>

<dl class="function">
<dt id="offlineimap.globals.set_options">
<tt class="descname">set_options</tt><big>(</big><em>source</em><big>)</big><a class="reference internal" href="_modules/offlineimap/globals.html#set_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#offlineimap.globals.set_options" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source for options variable</p>
</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's</span></tt> API documentation</a></li>
<li><a class="reference internal" href="#module-offlineimap"><tt class="docutils literal"><span class="pre">offlineimap</span></tt> &#8211; The OfflineImap module</a></li>
<li><a class="reference internal" href="#offlineimap-account"><tt class="docutils literal"><span class="pre">offlineimap.account</span></tt></a><ul>
<li><a class="reference internal" href="#offlineimaperror-a-notmuch-execution-error"><tt class="docutils literal"><span class="pre">OfflineImapError</span></tt> &#8211; A Notmuch execution error</a></li>
</ul>
</li>
<li><a class="reference internal" href="#offlineimap-globals-module-with-global-variables"><tt class="docutils literal"><span class="pre">offlineimap.globals</span></tt> &#8211; module with global variables</a></li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Welcome to OfflineIMAP&#8217;s developer documentation</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="repository.html"
                        title="next chapter"><tt class="docutils literal"><span class="pre">offlineimap.repository</span></tt> &#8211; Email repositories</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/API.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="repository.html" title="offlineimap.repository – Email repositories"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to OfflineIMAP’s developer documentation"
             >previous</a> |</li>
        <li><a href="index.html">OfflineIMAP 6.7.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright Copyright 2002-2016 John Goerzen &amp; contributors.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>

OHA YOOOO