larch - Online in the Cloud

PROGRAM:

NAME

larch - copy messages from one IMAP server to another

SYNOPSIS

larch [options]

larch [--from URI] [--to URI]

DESCRIPTION

Larch is a tool to copy messages from one IMAP server to another quickly and safely. It's
smart enough not to copy messages that already exist on the destination and robust enough
to deal with interruptions caused by flaky connections or misbehaving servers.

Larch is particularly well-suited for copying email to, from, or between Gmail accounts.

OPTIONS

Server options
--from, -f URI
URI of the source IMAP server.

--from-folder, -F FOLDER
Source folder to copy from. Default is INBOX.

--from-pass, -p PASSWD
Source server password. Default is to prompt the user.

--from-user, -u USER
Source server username. Default is to prompt the user.

--to, -t URI
URI of the destination IMAP server.

--to-folder, -T FOLDER
Destination folder to copy to. Default is INBOX.

--to-pass, -P PASSWD
Destination server password. Default is to prompt the user.

--to-user, -U USER
Destination server username. Default is to prompt the user.

Copy options
--all, -a
Copy all folders recursively.

--all-subscribed, -s
Copy all subscribed folders recursively.

--delete, -d
Delete messages from the source after copying them, or if they already exist at the
destination.

--exclude PATTERN [ PATTERN... ]
List of mailbox names/patterns that shouldn't be copied.

--exclude-file FILE
Filename containing mailbox names/patterns that shouldn't be copied.

--expunge, -x
Expunge deleted messages from the source.

--sync-flags, -S
Sync message flags from the source to the destination for messages that already
exist at the destination.

General options
--config, -c FILE
Specify a non-default config file to use. Default is ~/.larch/config.yaml.

--database FILE
Specify a non-default message database to use. Default is ~/.larch/larch.db.

--dry-run, -n
Don't actually make any changes.

--max-retries NUM
Maximum number of times to retry after a recoverable error. Default is 3.

--no-create-folder
Don't create destination folders that don't already exist.

--ssl-certs FILE
Path to a trusted certificate bundle to use to verify server SSL certificates.

--ssl-verify
Verify server SSL certificates.

--verbosity, -V STR
Output verbosity: debug, info, warn, error, or fatal. Default is info.

--version, -v
Print version and exit.

--help, -h
Show a help message.

CONFIGURATION

While it's possible to control Larch entirely from the command line, this can be
inconvenient if you need to specify a lot of options or if you run Larch frequently and
can't always remember which options to use. Using a configuration file can simplify
things.

By default, Larch looks for a config file at ~/.larch/config.yaml and uses it if found.
You may specify a custom config file using the --config command line option.

The Larch configuration file is a simple YAML ⟨http://yaml.org/⟩ file that may contain
multiple sections, each with a different set of options, as well as a special default
section. The options in the default section will be used unless they're overridden either
in another config section or on the command line.

Here's a sample Larch config file:

# Copy all subscribed folders by default
default:
all-subscribed: true

# Copy mail from Gmail to my server, excluding stuff I don't want.
gmail to my server:
from: imaps://imap.gmail.com
from-user: example
from-pass: secret

to: imaps://mail.example.com
to-user: example
to-pass: secret

exclude:
- "[Gmail]/Sent Mail"
- "[Gmail]/Spam"
- "[Gmail]/Trash"

# Copy mail from my INBOX to Gmail's INBOX
my inbox to gmail inbox:
all-subscribed: false

from: imaps://mail.example.com
from-folder: INBOX
from-user: example
from-pass: secret

to: imaps://imap.gmail.com
to-folder: INBOX
to-user: example
to-pass: secret

This file contains three sections. The options from default will be used in all other
sections as well unless they're overridden.

To specify which config section you want Larch to use, just pass its name on the command
line (use quotes if the name contains spaces):

larch 'gmail to my server'

If you specify additional command line options, they'll override options in the config
file:

larch 'gmail to my server' --from-user anotheruser

Running Larch with no command line arguments will cause the default section to be used.
With the example above, this will result in an error since the default section doesn't
contain the required from and to options, but if you only need to use Larch with a single
configuration, you could use the default section for everything and save yourself some
typing on the command line.

Use larch online using onworks.net services