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

README.md: Renaming file so that github renders it nicely.

Browse Source
This commit is contained in:
Hugo Osvaldo Barrera 2013-04-19 19:28:17 -03:00
parent a73b4b3465
commit 84857f9430
1 changed files with 74 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README → README.md
View File

@ -1,5 +1,5 @@
OfflineImap README
==================
OfflineImap
===========
Description
-----------
@ -26,7 +26,7 @@ Documentation
The documentation is included (in .rst format) in the `docs` directory.
Read it directly or generate nice html docs (python-sphinx needed) and/or
the man page (python-docutils needed) while being in the `docs` dir via::
the man page (python-docutils needed) while being in the `docs` dir via:
'make doc' (user docs), 'make man' (man page only) or 'make' (both)
@ -50,7 +50,7 @@ provides you with the bare minimum of setting up OfflineIMAP. You can
simply copy this file into your home directory and name it
``.offlineimaprc``. A command such as ``cp offlineimap.conf.minimal
~/.offlineimaprc`` will do it. Or, if you prefer, you can just copy
this text to ``~/.offlineimaprc``::
this text to ``~/.offlineimaprc``:
[general]
accounts = Test
@ -111,7 +111,7 @@ This example shows you how to set up OfflineIMAP to synchronize multiple
accounts with the mutt mail reader.
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
@ -120,12 +120,12 @@ Make sure that you have both an [Account Personal] and an [Account Work]
section. The local repository for each account must have different localfolder
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
Finally, add these lines to your ``~/.muttrc``::
Finally, add these lines to your ``~/.muttrc``:
source ~/path-to-mbnames-muttrc-mailboxes
folder-hook Personal set from="youremail@personal.com"
@ -146,7 +146,7 @@ to get at their mailboxes, specifying a reference of ``~/Mail`` or ``#mh/``
depending on the configuration. The below configuration from (originally from
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
folders synced to just three::
folders synced to just three:
[Account Gerf]
localrepository = GerfLocal
@ -184,14 +184,14 @@ configuration file options that are Python expressions. This example is based
on one supplied by Tommi Virtanen for this feature.
In ~/.offlineimaprc, he adds these options::
In ~/.offlineimaprc, he adds these options:
[general]
pythonfile=~/.offlineimap.py
[Repository foo]
foldersort=mycmp
Then, the ~/.offlineimap.py file will contain::
Then, the ~/.offlineimap.py file will contain:
prioritized = ['INBOX', 'personal', 'announce', 'list']