.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "SM-ARCHIVE" 1 "2008-03-21" "" ""
.SH NAME
sm-archive \- a sendmail milter to add recipients to messages
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 11
\fBsm\-archive\fR [\fB\-c\fR] [\fB\-d\ \fIn\fR\fR] [\fB\-p\ \fIsendmail\-socket\fR\fR] [\fB\-t\ \fItimeout\fR\fR]
.ad
.hy

.SH "OPTIONS"

.TP
\-c
Load the configuration file, print a cannonical form of the configuration on stdout, and exit\&.

.TP
\-d \fIn\fR
Set the debug level to \fIn\fR\&.

.TP
\-p \fIsendmail\-socket\fR
Set the socket used for the milter connection to sendmail\&. This is either "inet:port@ip\-address" or "local:local\-domain\-socket\-file\-name"\&.

.TP
\-t \fItimeout\fR
Set the timeout in seconds used for communication with sendmail\&.

.SH "USAGE"

.PP
\fBsm\-archive\fR \-c

.PP
\fBsm\-archive\fR \-d 10 \-p local:sm\-archive\&.sock

.SH "INSTALLATION"

.PP
This is now a standard GNU autoconf/automake installation, so the normal "\&./configure; make; su; make install" works\&. "make chkconfig" will setup the init\&.d runlevel scripts\&. Alternatively, you can use the source or binary RPMs at http://www\&.five\-ten\-sg\&.com/sm\-archive/packages: \fIhttp://www.five-ten-sg.com/sm-archive/packages\fR\&.

.PP
Note that this has ONLY been tested on Linux, specifically RedHat Linux\&. You will need at a minimum a C++ compiler with a minimally thread safe STL implementation\&. The distribution includes a test\&.cpp program\&. If it fails this milter won't work\&. If it passes, this milter might work\&.

.PP
Modify your sendmail\&.mc by adding the following line in your sendmail\&.mc and rebuild the \&.cf file

.PP


.IP
INPUT_MAIL_FILTER(`sm\-archive', `S=local:/var/run/sm\-archive/sm\-archive\&.sock, F=T, T=C:30s;S:5m;R:5m;E:5m')

.PP
Modify the default \fBsm\-archive\&.conf\fR(5) configuration\&.

.SH "CONFIGURATION"

.PP
The configuration file is documented in \fBsm\-archive\&.conf\fR(5)\&. Any change to the config file, or any file included from that config file, will cause it to be reloaded within three minutes\&.

.SH "INTRODUCTION"

.PP
Consider the problem of archiving all the mail sent to or from particular email addresses or domains\&. This milter allows you to configure archive mailboxes for each address or domain\&. It will add the address of the archive mailbox to messages that pass thru this milter\&.

.PP
The archive milter reads a text configuration file (sm\-archive\&.conf) on startup, and whenever the config file (or any of the referenced include files) is changed\&. The entire configuration file is case insensitive\&. If the configuration cannot be loaded due to a syntax error, the milter will log the error and quit\&. If the configuration cannot be reloaded after being modified, the milter will log the error and send an email to root from sm\-archive@$hostname\&. You probably want to added sm\-archive@$hostname to your /etc/mail/virtusertable since otherwise sendmail will reject that message\&.

.SH "TODO"

.PP
Placeholder for future ideas\&.

.SH "COPYRIGHT"

.PP
Copyright (C) 2007 by 510 Software Group <carl@five\-ten\-sg\&.com>

.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version\&.

.PP
You should have received a copy of the GNU General Public License along with this program; see the file COPYING\&. If not, please write to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA\&.

.SH "VERSION"

.PP
1\&.7