mbox2gs

Synopsis

mbox2gs [-h] [-v] [-l <LISTID>] [-f <FILE>] [-c <CONFIG>] [-i <INSTANCE>] url

Description

Usually, an advanced user of Groupserver calls mbox2gs when required to add email messages from mbox archive to a GroupServer group.

Positional Arguments

url

The URL for the GroupServer site.

Optional Arguments

-h, --help

Show a help message and exit.

-v, --verbose

Turn on verbose output (default is quiet: no news is good news).

-l <LISTID>, --list <LISTID>

The list to send the message to. By default it is extracted from the x-original-to header.

-f <FILE>, --file <FILE>

The name of the file that contains the mbox archive. Only one archive can be imported at the time. If omitted (or -) standard-input will be read.

-c <CONFIG>, --config <CONFIG>

The name of the GroupServer configuration file (default INSTANCE_HOME/etc/gsconfig.ini) that contains the token that will be used to authenticate the script when it tries to add the email to the site. (See Configuration file for more information.)

-i <INSTANCE>, --instance <INSTANCE>

The identifier of the GroupServer instance configuration to use (default default).

Returns

The script returns 0 on success, or a non-zero on an error. In the case of an error, mbox2gs follows the convention specified in /usr/include/sysexits.h. In addition the error message that is written to stderr starts with the enhanced mail system status code (RFC 3463). See smtp2gs for more information.

Examples

Import the mbox archive stored in /tmp/test.mbox into the group my_group that is on the site groups.example.com, and produce verbose output:

$ mbox2gs -v -l my_group -f /tmp/test.mbox http://groups.example.com