LamsonProject: Available Lamson Commands

#

# Available Lamson Commands

The following is also available by running lamson help and you can get the help for each individual command with lamson help -for COMMAND replacing COMMAND with one of these listed below.

The format for the printed options show default options as an actual setting, and required options as a CAPITALIZED setting you must give. For example, in the send command:

    lamson send -port 8825 -host 127.0.0.1 -debug 1 -sender EMAIL -to EMAIL -subject STR -body STR -attach False

The options -port, -host, -debug, and -file have default settings, but -sender, -to, -subject and -body require a STRing or EMAIL. Notice also that -file defaults to False which you can change by just including -file (that toggles it true).

## lamson blast

    Given a maildir, this command will go through each email
    and blast it at your server.  It does nothing to the message, so
    it will be real messages hitting your server, not cleansed ones.

## lamson cleanse

    Uses Lamson mail cleansing and canonicalization system to take an
    input maildir (or mbox) and replicate the email over into another
    maildir.  It's used mostly for testing and cleaning.

## lamson gen

    Generates various useful things for you to get you started.

    lamson gen -project STR -FORCE False

## lamson help

    Prints out help for the commands.

    lamson help

    You can get help for one command with:

    lamson help -for STR

## lamson log

    Runs a logging only server on the given hosts and port.  It logs
    each message it receives and also stores it to the run/queue
    so that you can make sure it was received in testing.

    lamson log -port 8825 -host 127.0.0.1 \
            -pid ./run/log.pid -chroot False  \
            -chdir "." -umask False -uid False -gid False \
            -FORCE False

    If you specify a uid/gid then this means you want to first change to
    root, set everything up, and then drop to that UID/GID combination.
    This is typically so you can bind to port 25 and then become "safe"
    to continue operating as a non-root user.

    If you give one or the other, this it will just change to that
    uid or gid without doing the priv drop operation.

## lamson queue

    Let's you do most of the operations available to a queue.

    lamson queue (-pop | -get | -remove | -count | -clear | -keys) -name run/queue

## lamson restart

    Simply attempts a stop and then a start command.  All options for both
    apply to restart.  See stop and start for options available.

## lamson routes

    Prints out valuable information about an application's routing configuration
    after everything is loaded and ready to go.  Helps debug problems with
    messages not getting to your handlers.  Path has the search paths you want
    separated by a ':' character, and it's added to the sys.path.

    lamson routes -path $PWD -- config.testing -test ""

    It defaults to running your config.testing to load the routes.
    If you want it to run the config.boot then give that instead:

    lamson routes -- config.boot

    You can also test a potential target by doing -test EMAIL.

## lamson send

    Sends an email to someone as a test message.
    See the sendmail command for a sendmail replacement.

    lamson send -port 8825 -host 127.0.0.1 -debug 1 \
            -sender EMAIL -to EMAIL -subject STR -body STR -attach False'

## lamson sendmail

    Used as a testing sendmail replacement for use in programs
    like mutt as an MTA.  It reads the email to send on the stdin
    and then delivers it based on the port and host settings.

    lamson sendmail -port 8825 -host 127.0.0.1 -debug 0 -- [recipients]

## lamson start

    Runs a lamson server out of the current directory:

    lamson start -pid ./run/smtp.pid -FORCE False -chroot False -chdir "." \
            -umask False -uid False -gid False -boot config.boot

## lamson status

    Prints out status information about lamson useful for finding out if it's
    running and where.

    lamson status -pid ./run/smtp.pid

## lamson stop

    Stops a running lamson server.  Give -KILL True to have it
    stopped violently.  The PID file is removed after the
    signal is sent.  Give -ALL the name of a run directory and
    it will stop all pid files it finds there.

    lamson stop -pid ./run/smtp.pid -KILL False -ALL False

## lamson version

        Prints the version of Lamson, the reporitory revision, and the
        file it came from.

## lamson web

    Starts a very simple files only web server for easy testing of applications
    that need to make some HTML files as the result of their operation.
    If you need more than this then use a real web server.

    lamson web -basedir "." -port 8888 -host '127.0.0.1'

    This command doesn't exit so you can view the logs it prints out.