Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions docs/offlineimap.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Works with Python 3.
OPTIONS
-------

-h::
--help::
-h, --help::

Display summary of options.

Expand Down Expand Up @@ -107,22 +106,22 @@ included), implies the single-thread option `-1'.

-l <path/to/file.log>::

Send logs to <file.log>.
Send logs to <file.log>.

-s::

Send logs to syslog.
Send logs to syslog.


-f <folder1[,folder1[,...]]>::

Only sync the specified folders.
Only sync the specified folders.
+
The folder names are the untranslated foldernames of the remote repository.
This command-line option overrides any 'folderfilter' and 'folderincludes'
options in the configuration file.

-k <[section:]option=value::
-k <[section:]option=value>::

Override any configuration file option.
+
Expand Down Expand Up @@ -158,6 +157,7 @@ blinkenlights, machineui.


--delete-folder::

Delete a folder on the remote repository.
+
Only one account must be specified/configured for this feature to work or you
Expand All @@ -167,6 +167,7 @@ otherwise. E.g.: "Remote/folder/name".


--migrate-fmd5-using-nametrans::

Migrate FMD5 hashes from versions prior to 6.3.5.
+
The way that FMD5 hashes are calculated was changed in version 6.3.5 (now using
Expand All @@ -181,6 +182,7 @@ flag first.


--mbnames-prune::

Remove dangling entries for removed accounts or if mbnames is not enabled/used
anymore.
+
Expand Down Expand Up @@ -262,8 +264,7 @@ Security and SSL
By default, OfflineIMAP will connect using any method that 'openssl' supports,
that is SSLv2, SSLv3, or TLSv1.

Do note that SSLv2 is notoriously insecure and deprecated. Unfortunately,
python2 does not offer easy ways to disable SSLv2. It is recommended you test
Do note that SSLv2 is notoriously insecure and deprecated. It is recommended you test
your setup and make sure that the mail server does not use an SSLv2
connection. Use e.g. "openssl s_client -host mail.server -port 443" to find
out the connection that is used by default.
Expand Down Expand Up @@ -302,8 +303,8 @@ will not protect you from active attacks, such as Man-In-The-Middle attacks
which cause you to connect to the wrong server and pretend to be your mail
server.
+
*DO NOT RELY ON STARTTLS AS A SAFE CONNECTION GUARANTEEING THE AUTHENTICITY OF
YOUR IMAP SERVER!*
WARNING: DO NOT RELY ON STARTTLS AS A SAFE CONNECTION GUARANTEEING THE
AUTHENTICITY OF YOUR IMAP SERVER!

* allow_nonstandard_capabilities
+
Expand All @@ -317,8 +318,8 @@ enables a best-effort fallback: OfflineIMAP reuses the capabilities advertised
before STARTTLS, removing `LOGINDISABLED`, so that authentication can continue
over the (assumed) encrypted connection.
+
*WARNING: only enable this option when you have verified that TLS is actually
established correctly.* If the server is not performing STARTTLS properly,
WARNING: Only enable this option when you have verified that TLS is actually
established correctly. If the server is not performing STARTTLS properly,
enabling this option could cause credentials to be transmitted in plain text.
+
Default: `no`.
Expand Down