"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "libs/maildir/maildirmake.1.in" between
sqwebmail-6.0.0.tar.bz2 and sqwebmail-6.0.1.tar.bz2

About: SqWebMail is a CGI Webmail client for Maildir mailboxes (module of the Courier mail server).

maildirmake.1.in  (sqwebmail-6.0.0.tar.bz2):maildirmake.1.in  (sqwebmail-6.0.1.tar.bz2)
'\" t '\" t
.\"<!-- Copyright 1998 - 2018 Double Precision, Inc. See COPYING for --> .\"<!-- Copyright 1998 - 2018 Double Precision, Inc. See COPYING for -->
.\"<!-- distribution information. --> .\"<!-- distribution information. -->
.\" Title: maildirmake .\" Title: maildirmake
.\" Author: Sam Varshavchik .\" Author: Sam Varshavchik
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 07/29/2018 .\" Date: 03/27/2019
.\" Manual: Double Precision, Inc. .\" Manual: Double Precision, Inc.
.\" Source: Courier Mail Server .\" Source: Courier Mail Server
.\" Language: English .\" Language: English
.\" .\"
.TH "MAILDIRMAKE" "1" "07/29/2018" "Courier Mail Server" "Double Precision, Inc\ &." .TH "MAILDIRMAKE" "1" "03/27/2019" "Courier Mail Server" "Double Precision, Inc\ &."
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673 .\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq .ie \n(.g .ds Aq \(aq
.el .ds Aq ' .el .ds Aq '
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
skipping to change at line 306 skipping to change at line 306
.ie n \{\ .ie n \{\
\h'-04'\(bu\h'+03'\c \h'-04'\(bu\h'+03'\c
.\} .\}
.el \{\ .el \{\
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
Updating Courier to version 1\&.0, and later, from prior versions of Courier\&. Updating Courier to version 1\&.0, and later, from prior versions of Courier\&.
.RE .RE
.PP .PP
These versions have been updated to implement native Unicode support in several E\-mail\-related protocols\&. It is already expected that updating Internet stan dards to use native Unicode\-formatted E\-mail messages will not be 100% backwar ds\-compatible, in terms of E\-mail client support\&. Given that, this major upd ate to Unicode will also introduce some backwards\-incompatible changes to the i nternal structure of maildirs, as a long term major to simplify Unicode support going forward\&. Might as well go through the pain of a major upgrade once\&. These versions have been updated to implement native Unicode support in several E\-mail\-related protocols\&. It is already expected that updating Internet stan dards to use native Unicode\-formatted E\-mail messages will not be 100% backwar ds\-compatible, in terms of E\-mail client support\&. Given that, this major upd ate to Unicode will also introduce some backwards\-incompatible changes to the i nternal structure of maildirs, as a major upgrade to simplify Unicode support go ing forward\&. Might as well go through the pain of a major upgrade once\&.
.PP .PP
\fBmaildirmake\fR\*(Aqs \fBmaildirmake\fR\*(Aqs
\fB\-\-checkutf8\fR \fB\-\-checkutf8\fR
and and
\fB\-\-convutf8\fR \fB\-\-convutf8\fR
options are tools to aid in conversion of existing mailbox to the new Unicode\-b ased naming standard\&. options are tools to aid in conversion of existing mailboxes to the new Unicode\ -based naming standard\&.
.SS "Background" .SS "Background"
.PP .PP
Mail folders in a maildir are hidden subdirectories\&. For example: a folder nam e Mail folders in a maildir are hidden subdirectories\&. For example: a folder nam e
\(lqMailing list\(rq \(lqMailing list\(rq
is a maildir subdirectory named is a maildir subdirectory named
$HOME/Maildir/\&.Mailing list $HOME/Maildir/\&.Mailing list
(with ($HOME/Maildir
$HOME/Maildir is the main mailbox)\&.
being the main mailbox)\&.
.PP .PP
Prior to the unicode update, non\-English characters in folder names were implem ented using a convention that was derived from the non\-standard Prior to the unicode update, non\-English characters in folder names used a conv ention based on the non\-standard
\(lqmodified\-UTF7\(rq \(lqmodified\-UTF7\(rq
encoding used by IMAP\&. A folder named encoding used by IMAP\&. A folder named
\(lqRésumé\(rq \(lqRésumé\(rq
was in a maildir subdirectory named is a maildir subdirectory named
$HOME/Maildir/\&.R&AOk\-sum&AOk\-\&. The current versions of Courier, $HOME/Maildir/\&.R&AOk\-sum&AOk\-\&. The current versions of Courier,
Courier\-IMAP, and SqWebmail, will simply create Courier\-IMAP, and SqWebmail, now creates
$HOME/Maildir/\&.Résumé $HOME/Maildir/\&.Résumé
using the using the
UTF8 UTF8
encoding, which will appear simply as a encoding\&. This appears as plain
\(lq\&.Résumé\(rq \(lq\&.Résumé\(rq
(hidden) subdirectory on modern UTF8\-based systems\&. (hidden) subdirectory on modern UTF8\-based systems\&.
.PP .PP
Consequently, any existing maildirs that have non\-English folders must be conve Consequently, any existing maildirs with folders that use non\-English names mus
rted as part of updating to the current version of Courier, t be converted as part of updating to the current version of Courier,
Courier\-IMAP, and SqWebmail from pre\-unicode versions\&. At this time this doe Courier\-IMAP, and SqWebmail from pre\-unicode versions\&. This does not happen
s not occur as part of automatically updating to the current version, and must b automatically when updating to the current version\&. This must be done manually
e done manually given the wide variety of individual mail server configurations given the wide variety of individual mail server configurations that are possib
that are possible\&. le\&.
.SS "Unicode conversion overview" .SS "Unicode conversion overview"
.PP .PP
Updating from pre\-unicode versions involves: Updating from pre\-unicode versions involves:
.sp .sp
.RS 4 .RS 4
.ie n \{\ .ie n \{\
\h'-04'\(bu\h'+03'\c \h'-04'\(bu\h'+03'\c
.\} .\}
.el \{\ .el \{\
.sp -1 .sp -1
skipping to change at line 366 skipping to change at line 365
.sp .sp
.RS 4 .RS 4
.ie n \{\ .ie n \{\
\h'-04'\(bu\h'+03'\c \h'-04'\(bu\h'+03'\c
.\} .\}
.el \{\ .el \{\
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
Updating the Updating the
$HOME/Maildir/courierimapsubscribed, which is a list of subscribed IMAP folders, $HOME/Maildir/courierimapsubscribed
if it exists\&. file, which is a list of subscribed IMAP folders, if it exists\&.
.RE .RE
.sp .sp
.RS 4 .RS 4
.ie n \{\ .ie n \{\
\h'-04'\(bu\h'+03'\c \h'-04'\(bu\h'+03'\c
.\} .\}
.el \{\ .el \{\
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
Updating any Updating any
maildrop maildrop
mail filtering recipe, mail filtering recipes,
$HOME/\&.mailfilter, if it exists, to reference the unicode maildir folders; or updating any custom site mail filtering engine that delivers to maildir folders, to reference the correct subdirectory names\&. $HOME/\&.mailfilter, if it exists, to reference the unicode maildir folders; or updating any custom site mail filtering engine that delivers to maildir folders, to reference the correct subdirectory names\&.
.RE .RE
.SS "Unicode conversion steps" .SS "Unicode conversion steps"
.PP .PP
The The
\fB\-\-checkutf8\fR \fB\-\-checkutf8\fR
and and
\fB\-\-convutf8\fR \fB\-\-convutf8\fR
options to options to
\fBmaildirmake\fR \fBmaildirmake\fR
skipping to change at line 458 skipping to change at line 458
.RS 4 .RS 4
.ie n \{\ .ie n \{\
\h'-04'\(bu\h'+03'\c \h'-04'\(bu\h'+03'\c
.\} .\}
.el \{\ .el \{\
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
A shell script needs to run the A shell script needs to run the
\fB\-\-checkutf8\fR \fB\-\-checkutf8\fR
option for every mailbox\&. A list of each account\*(Aqs maildir needs to be pre option for every mailbox\&. A list of all accounts\*(Aq maildirs needs to be pre
pared in advance, together with the corresponding pared in advance, together with the corresponding
\&.mailfilter \&.mailfilters (where appropriate)\&. courier\-authlib\*(Aqs
(where appropriate)\&. courier\-authlib\*(Aqs
\fBauthenumerate\fR \fBauthenumerate\fR
command is usually a good starting point\&. It\*(Aqs ok to explicitly specify ea ch mailbox\*(Aqs command is usually a good starting point\&. It\*(Aqs ok to explicitly specify ea ch mailbox\*(Aqs
\&.mailfilter, when using \&.mailfilter, when using
SqWebMail SqWebMail
even if a particular mailbox does not use it\&. It will be ignored\&. The list o f all accounts\*(Aq maildirs gets converted to a shell script that runs even if a particular mailbox does not use it\&. It will be ignored\&. The list o f all accounts\*(Aq maildirs gets converted to a shell script that runs
\fBmaildirmake\fR \fBmaildirmake\fR
with the with the
\fB\-\-checkutf8\fR \fB\-\-checkutf8\fR
option\&. The script should report any maildir whose option\&. The script should report any maildir whose
\fB\-\-checkutf8\fR \fB\-\-checkutf8\fR
skipping to change at line 527 skipping to change at line 526
\fB\-\-convutf8\fR \fB\-\-convutf8\fR
a second time after it successfully converted a maildir\&. In nearly all cases n othing will happen, but there are rare edge cases where some folder names may ge t garbled, or it fails completely\&. a second time after it successfully converted a maildir\&. In nearly all cases n othing will happen, but there are rare edge cases where some folder names may ge t garbled, or it fails completely\&.
.sp .5v .sp .5v
.RE .RE
.SS "Resolving unicode conversion problems" .SS "Resolving unicode conversion problems"
.PP .PP
The only likely problems that might be encountered is the fall\-out from buggy I MAP clients that did not follow the pre\-Unicode naming convention for non\-Lati n folder names\&. The customized IMAP The only likely problems that might be encountered is the fall\-out from buggy I MAP clients that did not follow the pre\-Unicode naming convention for non\-Lati n folder names\&. The customized IMAP
\(lqmodified\-UTF7\(rq \(lqmodified\-UTF7\(rq
encoding convention for non\-Latin folder names is mostly an IMAP client convent ion, and the pre\-Unicode version of encoding convention for non\-Latin folder names is mostly an IMAP client convent ion, and the pre\-Unicode version of
Courier\-IMAP Courier\-IMAP
did not enforce it\&. The server just uses the name from the IMAP client, as is\ &. did not enforce it\&. The server took the name from the IMAP client, as is\&.
.PP .PP
Unicode conversion (\fB\-\-checkutf8\fR Unicode conversion (\fB\-\-checkutf8\fR
or or
\fB\-\-convutf8\fR) fails if it finds a folder name that does not correctly use IMAP\*(Aqs \fB\-\-convutf8\fR) fails if it finds a folder name that does not correctly use IMAP\*(Aqs
\(lqmodified\-UTF7\(rq \(lqmodified\-UTF7\(rq
encoding\&. This can only be resolved manually, by renaming the folder\&. This m ay also involve manually editing encoding\&. This can only be resolved manually, by renaming the folder\&. This m ay also involve manually editing
courierimapsubscribed courierimapsubscribed
and and
\&.mailfilter \&.mailfilter
if they exist\&. The bad folder name should be removed from if they exist\&. The bad folder name should be removed from
 End of changes. 14 change blocks. 
25 lines changed or deleted 23 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)