From 0d92bf0d81f564fbc58e8857e65893ac5979a162 Mon Sep 17 00:00:00 2001 From: lb803 <47544021+lb803@users.noreply.github.com> Date: Tue, 30 Jun 2026 17:03:47 +0100 Subject: [PATCH 1/4] address inconsistent formatting Addressed some minor issues of fomatting and indentation. --- docs/offlineimap.txt | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/offlineimap.txt b/docs/offlineimap.txt index 0be4d834..1d618344 100644 --- a/docs/offlineimap.txt +++ b/docs/offlineimap.txt @@ -24,8 +24,7 @@ Works with Python 3. OPTIONS ------- --h:: ---help:: +-h, --help:: Display summary of options. @@ -107,16 +106,16 @@ included), implies the single-thread option `-1'. -l :: - Send logs to . + Send logs to . -s:: - Send logs to syslog. + Send logs to syslog. -f :: - 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' @@ -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 @@ -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 @@ -181,6 +182,7 @@ flag first. --mbnames-prune:: + Remove dangling entries for removed accounts or if mbnames is not enabled/used anymore. + From 6156f67af9fe4b513f79f6c30e6317d6370b84e8 Mon Sep 17 00:00:00 2001 From: lb803 <47544021+lb803@users.noreply.github.com> Date: Tue, 30 Jun 2026 17:05:35 +0100 Subject: [PATCH 2/4] added missing > added missing > to the -k option --- docs/offlineimap.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/offlineimap.txt b/docs/offlineimap.txt index 1d618344..91401b01 100644 --- a/docs/offlineimap.txt +++ b/docs/offlineimap.txt @@ -121,7 +121,7 @@ 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. + From a05f5a1778fddfca7aa8656349eec2fb3d2100a8 Mon Sep 17 00:00:00 2001 From: lb803 <47544021+lb803@users.noreply.github.com> Date: Tue, 30 Jun 2026 17:09:51 +0100 Subject: [PATCH 3/4] remove Python 2 reference OfflineIMAP3 only supports Python 3, so the Python 2 reference is no longer needed. --- docs/offlineimap.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/offlineimap.txt b/docs/offlineimap.txt index 91401b01..ea21bd34 100644 --- a/docs/offlineimap.txt +++ b/docs/offlineimap.txt @@ -264,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. From d6a62a8e981cf81f143ca09df6fbc0c77270d462 Mon Sep 17 00:00:00 2001 From: lb803 <47544021+lb803@users.noreply.github.com> Date: Tue, 30 Jun 2026 17:27:36 +0100 Subject: [PATCH 4/4] address buried warnings Critical security notes are in dense paragraphs. Added a WARNING: prefix to highlight critical security caveat. --- docs/offlineimap.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/offlineimap.txt b/docs/offlineimap.txt index ea21bd34..32329bf5 100644 --- a/docs/offlineimap.txt +++ b/docs/offlineimap.txt @@ -303,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 + @@ -318,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`.