<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>spamc - client for spamd</title> <link rev="made" href="mailto:root@localhost" /> </head> <body style="background-color: white"> <p><a name="__index__"></a></p> <!-- INDEX BEGIN --> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#options">OPTIONS</a></li> <li><a href="#description">DESCRIPTION</a></li> <li><a href="#see_also">SEE ALSO</a></li> <li><a href="#author">AUTHOR</a></li> <li><a href="#prerequisites">PREREQUISITES</a></li> </ul> <!-- INDEX END --> <hr /> <p> </p> <h1><a name="name">NAME</a></h1> <p>spamc - client for spamd</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <dl> <dt><strong><a name="item_spamc_%5b%2dc%5d_%5b%2dd_host%5d_%5b%2df%5d_%5b%2d">spamc [-c] [-d host] [-f] [-h] [-p port] [-s max_size] [-u username] [-e command [args]]</a></strong><br /> </dt> </dl> <p> </p> <hr /> <h1><a name="options">OPTIONS</a></h1> <dl> <dt><strong><a name="item_%2db"><strong>-B</strong></a></strong><br /> </dt> <dd> Assume input is a single BSMTP-formatted message. In other words, spamc will pull out everything between the DATA line and the lone-dot line to feed to spamd, and will place the spamd output back in the same envelope (thus, any SIZE extension in your BSMTP file will cause many problems). </dd> <p></p> <dt><strong><a name="item_%2dc"><strong>-c</strong></a></strong><br /> </dt> <dd> Just check if the message is spam or not. Set process exitcode to 1 is message is spam, 0 if not spam or processing failure occurs. Will print score/threshold to stdout (as ints) or 0/0 if there was an error. </dd> <p></p> <dt><strong><a name="item_%2dd_host"><strong>-d</strong> <em>host</em></a></strong><br /> </dt> <dd> Connect to spamd server on given host. </dd> <p></p> <dt><strong><a name="item_%2de_command_%5bargs%5d"><strong>-e</strong> <em>command</em> <em>[args]</em></a></strong><br /> </dt> <dd> Instead of writing to stdout, pipe the output to <em>command</em>'s standard input. Note that there is a very slight chance mail will be lost here, because if the fork-and-exec fails there's no place to put the mail message... </dd> <dd> <p>Note that this must be the LAST command line option, as everything after the <strong>-e</strong> is taken as arguments to the command (it's like <em>rxvt</em> or <em>xterm</em>).</p> </dd> <p></p> <dt><strong><a name="item_%2df"><strong>-f</strong></a></strong><br /> </dt> <dd> Cause spamc to safe-failover if it can't connect to spamd -- what this means is that in case spamc fails to connect to spamd, it will not return with an exitcode set, it will instead dump the original message to stdout, allowing the message to be delivered, albeit unscanned for spam. Without this flag, connection failures to spamd will cause message delivery failures. </dd> <dd> <p>Even with this flag set however, if spamc connects successfully, and then encounters an error at a later stage of communication, it will still return an exitcode.</p> </dd> <dd> <p>This now defaults to <strong>on</strong>, and can't be turned off. This flag is accepted though for backwards-compatibility.</p> </dd> <p></p> <dt><strong><a name="item_%2dh"><strong>-h</strong></a></strong><br /> </dt> <dd> Print this help message and terminate without action </dd> <p></p> <dt><strong><a name="item_%2dp_port"><strong>-p</strong> <em>port</em></a></strong><br /> </dt> <dd> Connect to spamd server listening on given port </dd> <p></p> <dt><strong><a name="item_%2ds_max_size"><strong>-s</strong> <em>max_size</em></a></strong><br /> </dt> <dd> Set the maximum message size which will be sent to spamd -- any bigger than this threshold and the message will be returned unprocessed. Note that the default size is 250k, so if spamc gets handed a message bigger than this, it won't be passed to spamd. The size is specified in bytes, and if you send it a negative number, things are quite likely to break very hard. </dd> <p></p> <dt><strong><a name="item_%2du_username"><strong>-u</strong> <em>username</em></a></strong><br /> </dt> <dd> This argument has been semi-obsoleted. To have spamd use per-user-config files, run spamc as the user whose config files spamd should load. If you're running spamc as some other user, though, (eg. root, mail, nobody, cyrus, etc.) then you can still use this flag. </dd> <p></p></dl> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p>Spamc is the client half of the spamc/spamd pair. It should be used in place of <code>spamassassin</code> in scripts to process mail. It will read the mail from STDIN, and spool it to its connection to spamd, then read the result back and print it to STDOUT. Spamc has extremely low overhead in loading, so it should be much faster to load than the whole spamassassin program.</p> <p>See the <em>README</em> file in the <em>spamd</em> directory of the SpamAssassin distribution for more details.</p> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><code>spamd(1)</code> <code>spamassassin(1)</code> Mail::SpamAssassin(3)</p> <p> </p> <hr /> <h1><a name="author">AUTHOR</a></h1> <p>Craig R Hughes <<a href="mailto:craig@hughes-family.org">craig@hughes-family.org</a>></p> <p> </p> <hr /> <h1><a name="prerequisites">PREREQUISITES</a></h1> <p><code>Mail::SpamAssassin</code></p> </body> </html>
