tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Markdown formatting

Browse Source 
Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
This commit is contained in:
Gioele 2014-06-23 08:33:47 +02:00 committed by Eygene Ryabinkin
parent f282f0b0e0
commit e791901b97
2 changed files with 35 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Changelog.rst
View File

@ -15,6 +15,8 @@ OfflineIMAP v6.5.6.1 (YYYY-MM-DD)
* Add missing version bump for 6.5.6 (it was released with * Add missing version bump for 6.5.6 (it was released with
6.5.5 in setup.py and other places). 6.5.5 in setup.py and other places).
* Various fixes in documentation.
OfflineIMAP v6.5.6 (2014-05-14) OfflineIMAP v6.5.6 (2014-05-14)
=============================== ===============================

66
README.md
View File

@ -39,18 +39,18 @@ detailed information on how to install and configure OfflineImap.
Quick Start Quick Start
=========== ===========
First, install OfflineIMAP. See docs/INSTALL.rst or read First, install OfflineIMAP. See `docs/INSTALL.rst` or read
http://docs.offlineimap.org/en/latest/INSTALL.html. <http://docs.offlineimap.org/en/latest/INSTALL.html>
(hint: `sudo python setup.py install`) (hint: `sudo python setup.py install`).
Second, set up your configuration file and run it! The distribution Second, set up your configuration file and run it! The distribution
includes offlineimap.conf.minimal (Debian users may find this at includes offlineimap.conf.minimal (Debian users may find this at
``/usr/share/doc/offlineimap/examples/offlineimap.conf.minimal``) that `/usr/share/doc/offlineimap/examples/offlineimap.conf.minimal`) that
provides you with the bare minimum of setting up OfflineIMAP. You can provides you with the bare minimum of setting up OfflineIMAP. You can
simply copy this file into your home directory and name it simply copy this file into your home directory and name it
``.offlineimaprc``. A command such as ``cp offlineimap.conf.minimal `.offlineimaprc`. A command such as `cp offlineimap.conf.minimal
~/.offlineimaprc`` will do it. Or, if you prefer, you can just copy ~/.offlineimaprc` will do it. Or, if you prefer, you can just copy
this text to ``~/.offlineimaprc``: this text to `~/.offlineimaprc`:
[general] [general]
accounts = Test accounts = Test
@ -69,17 +69,17 @@ this text to ``~/.offlineimaprc``:
remoteuser = jgoerzen remoteuser = jgoerzen
Now, edit the ``~/.offlineimaprc`` file with your favorite editor. All you have Now, edit the `~/.offlineimaprc` file with your favorite editor. All you have
to do is specify a directory for your folders to be in (on the localfolders 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 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! login name on the remote (on the `remoteuser` line). That's it!
If you prefer to be XDG-compatible, If you prefer to be compatible with the [XDG Base Directory
http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html spec](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html),
then substitute the above ``~/.offlineimaprc'' with then substitute the above `~/.offlineimaprc` with
``$XDG\_CONFIG\_HOME/offlineimap/config'' and don't forget to set `$XDG_CONFIG_HOME/offlineimap/config` and don't forget to set
XDG\_CONFIG\_HOME properly if you want it to be different from `XDG_CONFIG_HOME` properly if you want it to be different from
the default ``$HOME/.config'' for any reason. the default `$HOME/.config` for any reason.
To run OfflineIMAP, you just have to say `offlineimap` ― it will fire To run OfflineIMAP, you just have to say `offlineimap` ― it will fire
up, ask you for a login password if necessary, synchronize your folders, up, ask you for a login password if necessary, synchronize your folders,
@ -97,12 +97,12 @@ Mailing list & bug reporting
The user discussion, development and all exciting stuff take place in the The user discussion, development and all exciting stuff take place in the
OfflineImap mailing list at OfflineImap mailing list at
http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project. You do not <http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project>. You do not
need to subscribe to send emails. need to subscribe to send emails.
Bugs, issues and contributions should be reported to the mailing list. Bugs can Bugs, issues and contributions should be reported to the mailing list. Bugs can
also be reported in the issue tracker at also be reported in the issue tracker at
https://github.com/OfflineIMAP/offlineimap/issues. <https://github.com/OfflineIMAP/offlineimap/issues>.
Configuration Examples Configuration Examples
====================== ======================
@ -117,22 +117,22 @@ Multiple Accounts with Mutt
This example shows you how to set up OfflineIMAP to synchronize multiple This example shows you how to set up OfflineIMAP to synchronize multiple
accounts with the mutt mail reader. accounts with the mutt mail reader.
Start by creating a directory to hold your folders by running ``mkdir ~/Mail``. Start by creating a directory to hold your folders by running `mkdir ~/Mail`.
Then, in your ``~/.offlineimaprc``, specify: Then, in your `~/.offlineimaprc`, specify:
accounts = Personal, Work accounts = Personal, Work
Make sure that you have both an [Account Personal] and an [Account Work] Make sure that you have both an `[Account Personal]` and an `[Account Work]`
section. The local repository for each account must have different localfolder section. The local repository for each account must have different `localfolder`
path names. Also, make sure to enable [mbnames]. path names. Also, make sure to enable `[mbnames]`.
In each local repository section, write something like this: In each local repository section, write something like this:
localfolders = ~/Mail/Personal localfolders = ~/Mail/Personal
Finally, add these lines to your ``~/.muttrc``: Finally, add these lines to your `~/.muttrc`:
source ~/path-to-mbnames-muttrc-mailboxes source ~/path-to-mbnames-muttrc-mailboxes
folder-hook Personal set from="youremail@personal.com" folder-hook Personal set from="youremail@personal.com"
@ -149,10 +149,10 @@ UW-IMAPD and References
----------------------- -----------------------
Some users with a UW-IMAPD server need to use OfflineIMAP's "reference" feature Some users with a UW-IMAPD server need to use OfflineIMAP's "reference" feature
to get at their mailboxes, specifying a reference of ``~/Mail`` or ``#mh/`` to get at their mailboxes, specifying a reference of `~/Mail` or `#mh/`
depending on the configuration. The below configuration from (originally from depending on the configuration. The below configuration from (originally from
docwhat@gerf.org) shows using a reference of Mail, a nametrans that strips the docwhat@gerf.org) shows using a reference of Mail, a `nametrans` that strips the
leading Mail/ off incoming folder names, and a folderfilter that limits the leading `Mail/` off incoming folder names, and a `folderfilter` that limits the
folders synced to just three: folders synced to just three:
[Account Gerf] [Account Gerf]
@ -191,16 +191,16 @@ configuration file options that are Python expressions. This example is based
on one supplied by Tommi Virtanen for this feature. on one supplied by Tommi Virtanen for this feature.
In ~/.offlineimaprc, he adds these options: In `~/.offlineimaprc`, he adds these options:
[general] [general]
pythonfile=~/.offlineimap.py pythonfile=~/.offlineimap.py
[Repository foo] [Repository foo]
foldersort=mycmp foldersort=mycmp
Then, the ~/.offlineimap.py file will contain: Then, the `~/.offlineimap.py` file will contain:
prioritized = ['INBOX', 'personal', 'announce', 'list'] prioritized = ['INBOX', 'personal', 'announce', 'list']
def mycmp(x, y): def mycmp(x, y):
for prefix in prioritized: for prefix in prioritized:
@ -221,5 +221,5 @@ Then, the ~/.offlineimap.py file will contain:
print folders print folders
This code snippet illustrates how the foldersort option can be customized with a This code snippet illustrates how the `foldersort` option can be customized with a
Python function from the pythonfile to always synchronize certain folders first. Python function from the `pythonfile` to always synchronize certain folders first.