-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.html
234 lines (202 loc) · 12.8 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>OfflineIMAP home</title>
<!--[if lt IE 9]>
// teach older IEs to render those elements at all (http://diveintohtml5.org/semantics.html#unknown-elements)
<script>
var e = ("abbr,article,aside,audio,canvas,datalist,details," +
"figure,footer,header,hgroup,mark,menu,meter,nav,output," +
"progress,section,time,video").split(',');
for (var i = 0; i < e.length; i++) {
document.createElement(e[i]);
}
</script>
<![endif]-->
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js" type="text/javascript"></script>
<script src="rssFeed/jquery.zrssfeed.min.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function () {
$('#rssFeed').rssfeed('https://github.com/spaetz/offlineimap/commits/next.atom', {
limit: 5, header: false
});
<!-- Disabled mail feed: $('#rssMails').rssfeed('http://rss.gmane.org/messages/excerpts/gmane.mail.imap.offlineimap.general', {limit: 5, header: true});-->
$('#rssNews').rssfeed('http://news.offlineimap.org/rss.xml', {
limit: 3, header: false, date: true, snippet: true,
});
});
</script>
<script src="http://static.oswatershed.org/js/package_badge.js" type="text/javascript" ></script>
</head>
<body>
<header>
<img id="logo" src="img/logo.png">
<hgroup>
<h1><a href="http://offlineimap.org">OfflineImap</a></h1>
<h2>Syncing IMAP accounts since 2002</h2>
</hgroup>
<nav>
<a class="reference" href="" >Home</a>
<a class="reference" href="#ref-download" >Download</a>
<a class="reference" href="#ref-quick-start" >Quick Start</a>
<a class="reference" href="#ref-documentation" >Documentation</a>
<a class="reference" href="development.html" >Development</a>
<a class="reference" href="#ref-links">Links</a>
</nav>
</header>
<section id="content">
<!-- A sidebox that shows the latest Commits-->
<aside id="commits">
<h4>Latest commits</h4><div id="rssFeed">Recent commits requires JavaScript.</div>
<div id="rssMails"></div>
</aside>
<section>
<article>
<p>OfflineImap synchronizes emails between two repositories, so that you can read the same mailbox from multiple computers. It supports IMAP as REMOTE repository and Maildir/IMAP as LOCAL repository. See below for a full list of features.</p>
</article>
<article>
<header><h2>News</h2></header>
<div id="rssNews">Recent news requires JavaScript.</div>
<p style="clear:left;">Older news <a href="http://news.offlineimap.org">here</a> or <a href="https://twitter.com/#!/OfflineImap">follow us on Twitter. <img src="img/twitter_logo.png"/></a></p>
</article>
</section>
<section class="multicol">
<article>
<header><h1><a id="ref-description"></a>Overview</h1></header>
<p>Configuring OfflineImap in basic mode is quite easy, however it provides an amazing amount of flexibility for those with special needs. You can specify the number of connections to your IMAP server, use arbitrary python functions (including regular expressions) to limit the number of folders being synchronized. You can transpose folder names between repositories using any python function, to mangle and modify folder names on the LOCAL repository. There are six different ways to hand the IMAP password to OfflineImap from console input, specifying in the configuration file, .netrc support, specifying in a separate file, to using arbitrary python functions that somehow return the password. Finally, you can use IMAPs IDLE infrastructure to always keep a connection to your IMAP server open and immediately be notified (and synchronized) when a new mail arrives (aka Push mail).</p>
<p>Most configuration is done via the configuration file. However, any setting can also be overriden by command line options handed to OfflineIMAP.</p>
<p>OfflineImap is well suited to be frequently invoked by cron jobs, or can run in daemon mode to periodically check your email (however, it will exit in some error situations).</p>
<p>OfflineIMAP was originally written
by <a href="http://www.complete.org/JohnGoerzen">John Goerzen</a>, who
retired from maintaining it at then end of 2010. It is now maintained
by Nicolas Sebrecht. We are grateful for the great job John did and for having shared his project with us.</p>
<p>It is a Free Software project licensed under
the <a href="https://github.com/spaetz/offlineimap/raw/master/COPYING">GNU
General Public License (v2+)</a>. You can download it for free, and you
can modify it. In fact, you are encouraged to contribute changes back to us.</p>
</article>
<article>
<header><h2><a id="method-of-operation">How it works</a></h2></header>
<p>OfflineIMAP traditionally operates by maintaining a hierarchy of mail
folders in Maildir format locally. Your own mail reader will read mail
from this tree, and need never know that the mail comes from IMAP.
OfflineIMAP will detect changes to the mail folders on your IMAP server
and your own computer and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary.</p>
<p>OfflineIMAP can also synchronize two IMAP servers with each other, with
no need to have a Maildir layer in-between. Many people use this if
they use a mail reader on their local machine that does not support
Maildirs. People may install an IMAP server on their local machine, and
point both OfflineIMAP and their mail reader of choice at it. This is
often preferable to the mail reader's own IMAP support since OfflineIMAP
supports many features (offline reading, for one) that most IMAP-aware
readers don't. However, this feature is not as time-tested as
traditional syncing, so my advice is to stick with normal methods of
operation for the time being.</p>
</article>
<article>
<header><h2><a id="rf-sys-reqs" >System requirements</a></h2></header>
<p>OfflineIMAP works on pretty much any POSIX operating system, such as
Linux, BSD operating systems, MacOS X, Solaris. With some fiddling, it
reportedly ran under Windows as well (TODO: Is there Win documentation?).</p>
<p>Required: Python >= 2.6, and optionally (but recommended) python-sqlite.</p>
</article>
<article>
<header><h1><a id="ref-download"></a>Source code</h1></header>
<p>The source code is hosted in a <a href="https://github.com/spaetz/offlineimap">github git repository</a>. Retrieve the git repository by issueing <tt>git clone git://github.com/spaetz/offlineimap.git</tt>. The <a href="https://github.com/spaetz/offlineimap/downloads">release tarballs</a> are automatically created by corresponding git tags, ie to retrieve release 6.4.0 you would issue <tt>git checkout v6.4.0</tt> in your git checkout. If you are simply interested in the lasted stable version, download <a href="https://github.com/spaetz/offlineimap/tarball/master">master.tar.gz</a> and <a hres="#id-installation">install it</a>.
</article>
<article>
<header><h1><a id="ref-quick-start"></a>Quick Start</h1></header>
<p>If you have already installed OfflineIMAP system-wide, or your system
administrator has done that for you, your task for setting up OfflineIMAP for
the first time is quite simple. You just need to set up your configuration
file, make your folder directory, and run it!</p>
<p>You can quickly set up your configuration file. The distribution
includes a file offlineimap.conf.minimal (Debian users may find this at
<tt>/usr/share/doc/offlineimap/examples/offlineimap.conf.minimal</tt>) that is a
basic example of setting of OfflineIMAP. You can simply copy this file into
your home directory and name it <tt >.offlineimaprc</tt> (note the leading period). A
command such as <tt>cp offlineimap.conf.minimal ~/.offlineimaprc</tt> will do it.
Or, if you prefer, you can just copy this text to <tt class="docutils literal"><span class="pre">~/.offlineimaprc</span></tt>:</p>
<pre class="literal-block">
[general]
accounts = Test
[Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost
remoteuser = jgoerzen
</pre>
<p>Now, edit the <span class="pre">~/.offlineimaprc</span> file with your
favorite editor. All you have to do is specify a directory for your
folders to be in (on the localfolders line), the host name of your IMAP
server (on the remotehost line), and your login name on the remote (on
the remoteuser line). That's it!</p>
<p>To run OfflineIMAP, you just have to say offlineimap ― it will fire
up, ask you for a login password if necessary, synchronize your folders,
and exit. That's it. See?</p>
<p>You could just throw away the rest of this finely-crafted,
perfectly-honed manual! However, the default settings are not tuned for maximum performance so make sure you read the documentation to make sure you get the most out of OfflineIMAP.</p>
</article>
<article>
<header><h1><a id="ref-documentation"></a>Documentation</h1></header>
<p>The user documentation is contained in the <a href="http://github.com/spaetz/offlineimap">source git repository</a> in the <i>docs</i> directory and can be generated by issueing <tt>make doc</tt> and <tt>make dev-doc</tt>.</p>
<p>The full documentation is also provided <a href="http://docs.offlineimap.org">online</a> for easy browsing. Do peruse, it might help you solve your problems and tweak OfflineIMAP. The manual contains explanations, hints, and typical use cases.</p>
<p>The full <a href="http://docs.offlineimap.org">developer documentation</a> can also be viewed online. It contains the code documentation of all relevant functions in the OfflineImap source code base and should help in case you plan to modify or improve OfflineImap.</p>
<h2><a id="id-installation"></a>Installation</h2>
<ol><li>Grab it via your distribution's package manager</li>
<li>Grab the <a href="https://github.com/spaetz/offlineimap/tarball/master">latest release</a> and <a href="http://docs.offlineimap.org/en/latest/INSTALL.html#installation-from-source-package">install it system-wide</a>.</li>
<li>Grab the <a href="https://github.com/spaetz/offlineimap/tarball/master">master.tar.gz</a> latest release</a> and run it locally by unpacking, <tt>cd</tt>'ing into the offlineimap directory and issueing <tt>./offlineimap.py</tt> (you need to configure things beforehand).</li>
</ol>
The full installation instructions are also part of the source code repository and can be <a href="http://docs.offlineimap.org/en/latest/INSTALL.html">viewed online</a>.
</article>
</section>
<hr/>
<section>
<article>
<header><h1><a id="ref-links">Important links</a></h1>All important links at a glance...</header>
<table id="linktable">
<tr>
<td width="10%">Source code</td>
<td width="90%"><ul><li>Current <a href="https://github.com/spaetz/offlineimap">github home</a><br/><tt>git clone git://github.com/spaetz/offlineimap.git</tt></li>
<li><a href="https://github.com/spaetz/offlineimap/downloads">release tarballs</a></li>
<li>Via your distributions package manager for
<p><a href="http://packages.debian.org/search?keywords=offlineimap">Debian</a>, <a href="http://packages.ubuntu.com/search?keywords=offlineimap&searchon=names">Ubuntu</a>, <a href="https://admin.fedoraproject.org/pkgdb/acls/name/offlineimap">Fedora</a>,
<a href="http://packages.gentoo.org/package/net-mail/offlineimap">Gentoo</a>,
<a href="https://wiki.archlinux.org/index.php/OfflineIMAP">Arch</a>,
...</p>
<div id="osw_offlineimap">
<script>document.write('These versions are currently available (courtesy to <a href="http://oswatershed.org">oswatershed</a>):<br/>');
$(document).ready(function(){ package_badge("offlineimap", "#osw_offlineimap"); });
</script>
</div>
</li>
</ul>
</td>
</tr><tr>
<td>Bugs & Discussion</td>
<td><ul><li><a href='mailto:o%66flin%65imap-pr%6Fj%65ct@lists.aliot%68.de%62ian.%6F%72%67'>offlineimap-project@lists.alioth.debian.org</a>;<br/>mailing list <a href="http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project">portal</a></li>
<li><a href="http://dir.gmane.org/gmane.mail.imap.offlineimap.general">list archive (Gmane)</a></li>
<li><a href="nntp://news.gmane.org/gmane.mail.imap.offlineimap.general">access via nntp (Usenet)</a></li>
<li>Bugs <a href="development.html#ref-reporting-bugs">should
be reported</a> to the mailing list. They will also be tracked at our <a href="https://github.com/spaetz/offlineimap/issues">issue tracker</a>.</li>
</ul>
</td>
</tr><tr><td>Related projects</td><td><ul><li><a href="http://notmuchmail.org">notmuch email client</a></li></ul></td>
</tr><tr><td></td><td></td>
</tr></table>
</article>
<article>
<header><h2><a id="ref-examples" ></a>Examples</h2></header>
We have collected some examples for typical use case configurations and some how-tos on the <a href="examples.html">examples page</a>.
</article>
</section>
</body>
</html>