NAME
    ssoma - mail archive synchronization and extraction client

SYNOPSIS
    ssoma add LISTNAME URL maildir:/path/to/maildir/ [TARGET]

    ssoma add LISTNAME URL mbox:/path/to/mbox

    ssoma add LISTNAME URL imap://USER@HOST/INBOX

    ssoma sync [--since=DATE] [LISTNAME]

    ssoma cat MESSAGE-ID [LISTNAME|GIT_DIR]

DESCRIPTION
    ssoma may be used to sync and export mail to Maildir, IMAP or mbox(5)
    from any published ssoma git repository.

    add LISTNAME URL DESTINATION [TARGET]
        This starts a subscription to a mailing list by configuring a git
        repository. LISTNAME is a name of your choosing. It must only
        consist of alphanumeric characters, underscores, periods and dashes,
        and must start and end with an alphanumeric character. URL is the
        URL to a git repository, this supports all URLs git(7) supports.
        DESTINATION is the local destination to extract mail to. This may be
        a maildir:, mbox: path, or an imap:// or imaps:// URL.

        The repository is stored in ~/.ssoma/$LISTNAME.git

        If at any time a user wishes to stop following the list, just remove
        the git repository from your file system.

        IMAP users may configure the imap.pass and imap.tunnel variables in
        ~/.ssoma/$LISTNAME.git/config in the same way as git-imap-send(1).
        Remember to restrict permissions to ~/.ssoma/$LISTNAME.git/config if
        you are storing a password in it.

        TARGET may optionally be specified if you wish to extract a list to
        multiple destinations (e.g. an mbox for certain tools, but also to
        your IMAP account). The default TARGET name is "local".

    sync [--since=DATE] [LISTNAME] [TARGET]
        This clones/fetches from the remote git repository into the local
        repository and extracts messages into destinations configured with
        the "add" sub-command. If LISTNAME is not given, all list
        subscriptions are synchronized. If LISTNAME is given, only
        subscriptions for a given LISTNAME is synchronized. If TARGET is
        also given, the only the specified TARGET is synchronized.

        If you are following a list with a long history, you may only want
        to extract recent messages by specifying --since=DATE and passing
        any DATE format understood by git-log(1).

    cat MESSAGE-ID [LISTNAME|GIT_DIR]
        This outputs the message matching MESSAGE-ID to stdout (in mbox
        format). If LISTNAME is given, this limits the Message-ID search to
        that list.

        Specifying a GIT_DIR in place of LISTNAME is also possible, this is
        intended for administrators using ssoma-rm(1).

FILES
    All client-side git repositories are stored in ~/.ssoma/$LISTNAME.git/

    See ssoma_repository(5) for details.

ENVIRONMENT VARIABLES
    SSOMA_HOME may be used to override the default ~/.ssoma/ directory. This
    is useful for testing, but not recommended otherwise.

CONTACT
    The mail archives are hosted at <git://public-inbox.org/meta>

    See ssoma(1) for instructions on how to subscribe.

    You may subscribe using ssoma:

            ssoma add pi git://public-inbox.org/meta mbox:/path/to/mbox
            ssoma sync pi

SOURCE CODE
            git clone git://80x24.org/ssoma

COPYRIGHT
    Copyright 2013-2016 all contributors <mailto:meta@public-inbox.org>

    License: AGPL-3.0+ <http://www.gnu.org/licenses/agpl-3.0.txt>

SEE ALSO
    git(1), ssoma_repository(5), ssoma-rm(1)