@ -1,6 +1,6 @@
.ig
.ig
\" isync - IMAP4 to maildir mailbox synchronizer
\" isync - IMAP4 to maildir mailbox synchronizer
\" Copyright (C) 2000-2 Michael R. Elkins <me@mutt.org>
\" Copyright (C) 2000-2002 Michael R. Elkins <me@mutt.org>
\"
\"
\" This program is free software; you can redistribute it and/or modify
\" This program is free software; you can redistribute it and/or modify
\" it under the terms of the GNU General Public License as published by
\" it under the terms of the GNU General Public License as published by
@ -16,66 +16,70 @@
\" along with this program; if not, write to the Free Software
\" along with this program; if not, write to the Free Software
\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
. .
. .
.TH isync 1 "2002 Jun 17 "
.TH isync 1 "2002 Oct 14 "
. .
. .
.SH NAME
.SH NAME
isync - synchronize IMAP4 and maildir mailboxes
isync - synchronize IMAP4 and maildir mailboxes
. .
. .
.SH SYNOPSIS
.SH SYNOPSIS
.B isync
\fB isync\fR [\fI options...\fR ] \fI mailbox\fR [\fI mailbox ...\fR ]
[
.br
.I options...
\fB isync\fR [\fI options...\fR ] \fI -a\fR
]
.br
.I mailbox
\fB isync\fR [\fI options...\fR ] \fI -l\fR
[
.I mailbox ...
]
. .
. .
.SH DESCRIPTION
.SH DESCRIPTION
.B isync
\fB isync\fR is a command line application which synchronizes a local
is a command line application which synchronizes a local maildir-style
maildir-style mailbox with a remote IMAP4 mailbox, suitable for use in
mailbox with a remote IMAP4 mailbox, suitable for use in IMAP-disconnected
IMAP-disconnected mode. Multiple copies of the remote IMAP4 mailbox can
mode. Multiple copies of the remote IMAP4 mailbox can be maintained, and
be maintained, and all flags are synchronized.
all flags are synchronized.
. .
. .
.SH OPTIONS
.SH OPTIONS
.TP
.TP
\fB -c\fR , \fB --config\fR \fI file\fR
Read configuration from \fI file\fR .
By default, the configuration is read from ~/.isyncrc if it exists.
.TP
\fB -1\fR , \fB --one-to-one\fR
Instead of using the mailbox specifications in ~/.isyncrc, isync will pick up
all mailboxes from the local directory and remote folder and map them 1:1
onto each other according to their names.
.TP
\fB -I\fR , \fB --inbox\fR \fI mailbox\fR
Exception to the 1:1 mapping created by -1: the special IMAP mailbox \fI INBOX\fR
is mapped to the local \fI mailbox\fR (relative to the maildir).
.TP
\fB -a\fR , \fB --all\fR
\fB -a\fR , \fB --all\fR
Synchronize all mailboxes specified in the user's ~/.isyncrc.
Synchronize all mailboxes (either specified in ~/.isyncrc or determined by the
1:1 mapping).
.TP
.TP
\fB -C\fR , \fB --create\fR
\fB -l\fR , \fB --list\fR
Don't synchronize anything, but list all mailboxes and exit.
.TP
\fB -L\fR , \fB --create-local\fR
Automatically create the local maildir-style mailbox if it doesn't already
Automatically create the local maildir-style mailbox if it doesn't already
exist.
exist.
.TP
.TP
\fB -c\fR , \fB --config\fR \fI file\fR
\fB -R\fR , \fB --create-remote\fR
Read configuration from
Automatically create the remote IMAP mailbox if it doesn't already exist.
.I file
.TP
By default, configuration is read from ~/.isyncrc if it exists.
\fB -C\fR , \fB --create\fR
.TP
Automatically create any mailboxes if they doesn't already exist.
.B -d, --delete
.TP
Causes
\fB -d\fR , \fB --delete\fR
.B isync
Causes \fB isync\fR to delete messages from the local maildir mailbox
to delete messages from the local maildir mailbox which do not exist on the
which do not exist on the IMAP server. By default, \fI dead\fR messages
IMAP server. By default,
are \fB not\fR deleted.
.I dead
messages are
.B not
deleted.
.TP
.TP
\fB -e\fR , \fB --expunge\fR
\fB -e\fR , \fB --expunge\fR
Causes
Causes \fB isync\fR to permanently remove all messages marked for deletion
.B isync
in both the local maildir mailbox and the remote IMAP mailbox. By default,
to permanently remove all messages marked for deletion in both the local
messages are \fB not\fR expunged.
maildir mailbox and the remote IMAP mailbox. By default, messages are
.B not
expunged.
.TP
.TP
\fB -f\fR , \fB --fast\fR
\fB -f\fR , \fB --fast\fR
Causes
Causes \fB isync\fR to skip the step of synchronzing message flags between the
.B isync
local maildir mailbox and the IMAP mailbox. Only new messages existing on the
to skip the step of synchronzing message flags between the local maildir
server will be fetched into the local mailbox.
mailbox and the IMAP mailbox. Only new messages existing on the server will
be fetched into the local mailbox.
.TP
.TP
\fB -h\fR , \fB --help\fR
\fB -h\fR , \fB --help\fR
Displays a summary of command line options
Displays a summary of command line options
@ -96,44 +100,34 @@ Specifies the hostname of the IMAP server
\fB -u\fR , \fB --user\fR \fI user\fR
\fB -u\fR , \fB --user\fR \fI user\fR
Specifies the login name to access the IMAP server (default: $USER)
Specifies the login name to access the IMAP server (default: $USER)
.TP
.TP
.B -v, --version
\fB -M\fR , \fB --maildir\fR \fI dir\fR
Displays
Specifies the location for your local mailboxes.
.B isync
.TP
version information
\fB -F\fR , \fB --folder\fR \fI folder\fR /
Specifies the location for your remote mailboxes.
.TP
\fB -v\fR , \fB --version\fR
Displays \fB isync\fR version information.
.TP
.TP
.B -V, --verbose
\fB -V\fR , \fB --verbose\fR
Enables
Enables \fI verbose\fR mode, which displays the IMAP4 network traffic.
.I verbose
mode, which displays the IMAP4 network traffic.
. .
. .
.SH CONFIGURATION
.SH CONFIGURATION
.B isync
\fB isync\fR reads \fI ~/.isyncrc\fR to load default configuration data.
reads
Each line of the configuration file consists of a command.
.I ~/.isyncrc
The following commands are understood:
to load default configuration data. Each line of the configuration file
consists of a command. The following commands are understood:
.TP
.TP
\fB Mailbox\fR \fI path\fR
\fB Mailbox\fR \fI path\fR
Defines a local maildir mailbox. All configuration commands following this
Defines a local maildir mailbox. All configuration commands following this
line, up until the next
line, up until the next \fI Mailbox\fR command, apply to this mailbox only.
.I Mailbox
command, apply to this mailbox only.
. .
. .
.TP
.TP
\fB Host\fR \fB [\fR imaps:\fB ]\fR \fI name\fR
\fB Host\fR \fB [\fR imaps:\fB ]\fR \fI name\fR
Defines the DNS name or IP address of the IMAP server. If the hostname is
Defines the DNS name or IP address of the IMAP server. If the hostname is
prefixed with
prefixed with \fI imaps:\fR the connection is assumed to be a SSL connection
.I imaps:
to port 993 (though you can change this by placing a \fB Port\fR command
the connection is assumed to be a SSL connection to port 993 (though you can
\fB after\fR the \fB Host\fR command. Note that some servers support SSL on
change this by placing a
the default port 143. \fB isync\fR will always attempt to use SSL if available.
.B Port
command
.B after
the
.B Host
command. Note that some servers support SSL on the default port 143.
.B isync
will always attempt to use SSL if available.
. .
. .
.TP
.TP
\fB Port\fR \fI port\fR
\fB Port\fR \fI port\fR
@ -150,12 +144,9 @@ Defines the login name on the IMAP server (Default: current user)
. .
. .
.TP
.TP
\fB Pass\fR \fI password\fR
\fB Pass\fR \fI password\fR
Defines the password for
Defines the password for \fI username\fR on the IMAP server.
.I username
Note that this option is \fB NOT\fR required.
on the IMAP server. Note that this option is
If no password is specified in the configuration file, \fB isync\fR
.B NOT
required. If no password is specified in the configuration file,
.B isync
will prompt you for it.
will prompt you for it.
. .
. .
.TP
.TP
@ -164,64 +155,58 @@ Defines an alias for the mailbox which can be used as a shortcut on the
command line.
command line.
. .
. .
.TP
.TP
\fB CopyDeletedTo\fR \fI string \fR
\fB CopyDeletedTo\fR \fI mailbox \fR
Specifies the remote IMAP mailbox to copy deleted messages prior to
Specifies the remote IMAP mailbox to copy deleted messages prior to
expunging (Default: none).
expunging (Default: none).
. .
. .
.TP
.TP
\fB Delete\fR \fI yes|no\fR
\fB Delete\fR \fI yes\fR |\fI no\fR
Specifies whether messages in the local copy of the mailbox which don't
Specifies whether messages in the local copy of the mailbox which don't
exist on the server are automatically deleted. (Default: no).
exist on the server are automatically deleted. (Default: no).
\fB NOTE:\fR The \fI -d\fR command line option overrides this setting when
set to \fI no\fR .
. .
. .
.TP
.TP
\fB Expunge\fR \fI yes|no\fR
\fB Expunge\fR \fI yes\fR |\fI no\fR
Specifies whether deleted messages are expunged by default (Default: no).
Specifies whether deleted messages are expunged by default (Default: no).
\fB NOTE:\fR The
\fB NOTE:\fR The \fI -e\fR command line option overrides this setting when
.I -e
set to \fI no\fR .
command line option overrides this setting when set to
. .
\fI no\fR .
.TP
. .
\fB MailDir\fR \fI directory\fR
.TP
Specifies the location of your local mailboxes if a relative path is
\fB MailDir\fR \fI string\fR
specified in a \fI Mailbox\fR command (Default: \fI ~\fR ).
Specifies the location for your mailboxes if a relative path is
\fB NOTE:\fR This directive is only meaningful in the \fI global\fR
specified in a
section (see below).
.I Mailbox
. .
command (Default: \fI ~\fR ).
.TP
.B NOTE:
\fB Folder\fR \fI directory\fR /
This directive is only meaningful the in
Specifies the location of your IMAP mailboxes
.I global
specified in \fI Box\fR commands (Default: \fI ""\fR ).
\fB NOTE:\fR You \fB must\fR append the hierarchy delimiter (usually
a slash) to this specification.
\fB NOTE 2:\fR This directive is only meaningful in the \fI global\fR
section (see below).
section (see below).
. .
. .
.TP
.TP
\fB MaxMessages\fR \fI count\fR
\fB MaxMessages\fR \fI count\fR
Sets the number of messages
Sets the number of messages \fB isync\fR should keep in a mailbox.
.B isync
should keep in a mailbox.
This is useful for mailboxes where you keep a complete archive on the
This is useful for mailboxes where you keep a complete archive on the
server, but want to mirror only the last messages (for instance, for mailing
server, but want to mirror only the last messages (for instance, for mailing
lists.)
lists.)
The messages that were the first to arrive in the mailbox (independent of the
The messages that were the first to arrive in the mailbox (independent of the
actual date of the message) will automatically be deleted if you tell
actual date of the message) will automatically be deleted if you
pass
pass \fB isync\fR the delete (-d, --delete) flag.
.B isync
the delete (-d, --delete) flag.
Messages that are flagged (marked as important) will not be automatically
Messages that are flagged (marked as important) will not be automatically
deleted.
deleted.
If
If \fI count\fR is 0, the maximum number of messages is \fB unlimited\fR
.I count
is 0, the maximum number of messages is
.B unlimited
(Default: 0).
(Default: 0).
. .
. .
.TP
.TP
\fB MaxSize\fR \fI bytes\fR
\fB MaxSize\fR \fI bytes\fR
Sets a threshold for the maximum message size (in bytes) for which
Sets a threshold for the maximum message size (in bytes) for which \fB isync\fR
.B isync
should fetch from the server. This is useful for weeding out messages with
should fetch from the server. This is useful for weeding out messages with
large attachments. If
large attachments. If \fI bytes\fR is 0, the maximum file size is \fB unlimited\fR .
.I bytes
is 0, the maximum file size is
.B unlimited.
. .
. .
.TP
.TP
\fB Tunnel\fR \fI command\fR
\fB Tunnel\fR \fI command\fR
@ -229,79 +214,64 @@ Specify a command to run to establish a connection rather than opening a TCP
socket. This allows you to run an IMAP session over an SSH tunnel, for
socket. This allows you to run an IMAP session over an SSH tunnel, for
example.
example.
.TP
.TP
\fB UseNamespace\fR \fI yes|no\fR
\fB UseNamespace\fR \fI yes\fR |\fI no\fR
Selects whether
Selects whether \fB isync\fR should select mailboxes using the namespace given
.B isync
by the NAMESPACE command. This is useful with broken IMAP servers. (Default:
should select mailboxes using the namespace given by the NAMESPACE command.
\fI yes\fR )
This is useful with broken IMAP servers. (Default:
.I yes
)
. .
. .
.TP
.TP
\fB RequireCRAM\fR \fI yes|no\fR
\fB RequireCRAM\fR \fI yes\fR |\fI no\fR
If set to
If set to \fI yes\fR , \fB isync\fR will require that the server accept CRAM-MD5
.I yes
intead of PLAIN to authenticate the user.
,
.B isync
will require that the server accept CRAM-MD5 intead of PLAIN to authenticate
the user.
. .
. .
.TP
.TP
\fB RequireSSL\fR \fI yes|no\fR
\fB RequireSSL\fR \fI yes\fR |\fI no\fR
.B isync
\fB isync\fR will abort the connection if a TLS/SSL session to the IMAP
will abort the connection if a TLS/SSL session to the IMAP
server can not be established. (Default: \fI yes\fR )
server can not be established. (Default:
.I yes
)
. .
. .
.TP
.TP
\fB CertificateFile\fR \fI path\fR
\fB CertificateFile\fR \fI path\fR
File containing X.509 CA certificates used to verify server identities.
File containing X.509 CA certificates used to verify server identities.
. .
. .
.TP
.TP
\fB UseSSLv2\fR \fI yes|no\fR
\fB UseSSLv2\fR \fI yes\fR |\fI no\fR
Should
Should \fB isync\fR use SSLv2 for communication with the IMAP server over SSL?
.B isync
(Default: \fI yes\fR if the imaps port is used, otherwise \fI no\fR )
use SSLv2 for communication with the IMAP server over SSL? (Default:
. .
.I yes
.TP
if the imaps port is used, otherwise
\fB UseSSLv3\fR \fI yes\fR |\fI no\fR
.I no
Should \fB isync\fR use SSLv3 for communication with the IMAP server over SSL?
)
(Default: \fI yes\fR if the imaps port is used, otherwise \fI no\fR )
. .
.TP
\fB UseTLSv1\fR \fI yes\fR |\fI no\fR
Should \fB isync\fR use TLSv1 for communication with the IMAP server over SSL?
(Default: \fI yes\fR )
. .
. .
.TP
.TP
\fB UseSSLv3\fR \fI yes|no\fR
\fB OneToOne\fR
Should
\fB isync\fR will ignore any \fI Mailbox\fR specifications and instead pick up
.B isync
all mailboxes from the local \fI MailDir\fR and remote \fI Folder\fR and map
use SSLv3 for communication with the IMAP server over SSL? (Default:
them 1:1 onto each other according to their names.
.I yes
\fB NOTE:\fR This directive is only meaningful in the \fI global\fR
if the imaps port is used, otherwise
section (see below).
.I no
)
. .
. .
.TP
.TP
\fB UseTLSv1\fR \fI yes|no\fR
\fB Inbox\fR \fI mailbox\fR
Should
Exception to the OneToOne mapping: the special IMAP mailbox \fI INBOX\fR
.B isync
is mapped to the local \fI mailbox\fR (relative to the \fI MailDir\fR ).
use TLSv1 for communication with the IMAP server over SSL? (Default:
\fB NOTE:\fR This directive is only meaningful in the \fI global\fR
.I yes
section (see below).
)
. .
. .
.P
.P
Configuration commands that appear prior to the first
Configuration commands that appear prior to the first \fB Mailbox\fR
.B Mailbox
command are considered to be \fI global\fR
command are considered to be
.I global
options which are used as defaults when those specific options are not
options which are used as defaults when those specific options are not
specifically set for a defined Mailbox. For example, if you use the same
specifically set for a defined Mailbox. For example, if you use the same
login name for several IMAP servers, you can put a
login name for several IMAP servers, you can put a \fB User\fR command before
.B User
the first \fB Mailbox\fR command, and then leave out the \fB User\fR command
command before the first
in the sections for each mailbox.
.B Mailbox
\fB isync\fR will then use the global value by default.
command, and then leave out the
.B User
command in the sections for each mailbox.
.B isync
will then use the global value by default.
. .
. .
.SH FILES
.SH FILES
.TP
.TP
@ -309,20 +279,16 @@ will then use the global value by default.
Default configuration file
Default configuration file
. .
. .
.SH BUGS
.SH BUGS
.B isync
\fB isync\fR does not use NFS-safe locking. It will correctly prevent
does not use NFS-safe locking. It will correctly prevent concurrent
concurrent synchronization of a mailbox on the same host, but not across NFS.
synchronization of a mailbox on the same host, but not across NFS.
.P
.P
When synchronizing multiple mailboxes on the same IMAP server, it is not
When synchronizing multiple mailboxes on the same IMAP server, it is not
possible to select different SSL options for each mailbox. Only the options
possible to select different SSL options for each mailbox. Only the options
from the first mailbox are applied since the SSL session is reused.
from the first mailbox are applied since the SSL session is reused.
.P
.P
If new mail arrives in the IMAP mailbox after
If new mail arrives in the IMAP mailbox after \fB isync\fR
.B isync
has retrieved the initial message list, the new mail will not be fetched
has retrieved the initial message list, the new mail will not be fetched
until the next time
until the next time \fB isync\fR is invoked.
.B isync
is invoked.
.P
.P
It is currently impossible to unset the \\ Flagged attribute of a message
It is currently impossible to unset the \\ Flagged attribute of a message
once it is set. It has to be manually unset everywhere since isync
once it is set. It has to be manually unset everywhere since isync
@ -331,12 +297,12 @@ message.
.P
.P
The ndbm database created for each mailbox is not portable across different
The ndbm database created for each mailbox is not portable across different
architectures. It currently stores the UID in host byte order.
architectures. It currently stores the UID in host byte order.
.P
The configuration file takes precedence over command line options.
.SH SEE ALSO
.SH SEE ALSO
mutt(1), maildir(5)
mutt(1), maildir(5)
.P
.P
Up to date information on
Up to date information on \fB isync\fR can be found at
.B isync
can be found at
http://www.cs.hmc.edu/~me/isync/.
http://www.cs.hmc.edu/~me/isync/.
. .
. .
.SH AUTHOR
.SH AUTHOR