'\" t
.\"     Title: mailping-store
.\"    Author: Tommi Virtanen <tv@havoc.fi>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 
      2004-04-15
    
.\"    Manual: Mailping
.\"    Source: 
      mailping
     
      0.0.4
    
.\"  Language: English
.\"
.TH "MAILPING\-STORE" "1" "2004\-04\-15" "mailping 0." "Mailping"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
mailping-store \- store email from stdin to a mailping incoming maildir
.SH "SYNOPSIS"
.HP \w'\fBmailping\-store\fR\ 'u
\fBmailping\-store\fR
.SH "DESCRIPTION"
.PP
 \fBmailping\-store\fR reads an email from standard input and writes it into a maildir chosen according to following logic: 
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
If
\fBEXTENSION\fP
is not set, select
\fIMaildir\fP\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
If
\fBEXTENSION\fP
is set, ensure its value is safe to use, and select
\fI\fBEXTENSION\fP/incoming\fP\&.
.RE
.sp
 
.PP
 \fBmailping\-store\fR is usually run from a \fI\&.forward\fP file, and thus the filenames above are relative to the home directory of the account in question\&.
.SS "Normal use"
.PP
Normally, \fBmailping\-store\fR is used to ease the setup of new circuits to probe from \fBmailping\-cron\fR\&. This is done with a system account mailping using <mailping@\fByourhost\&.example\&.com\fP> as the \fIfrom\fP address, and <mailping+\fBcircuitname\fP@\fByourhost\&.example\&.com\fP> (or some remote address aliased to that) as the \fIto\fP address\&. In fact, these are the default values for \fIfrom\fP and \fIto\fP, so you can just skip creating those configuration files\&.
.PP
This allows adding new test circuits without any changes to the email configuration\&.
.SH "FILES"
.PP
\fI/var/lib/mailping/state/\fBcircuit\fP/incoming\fP
.RS 4
Maildir to store the email to\&.
.RE
.PP
\fI/var/lib/mailping/state/Maildir/\fP
.RS 4
Maildir to store the email to, if no extension was given\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBMAILPING_STATEDIR\fP
.RS 4
Override the location of the state directory\&. Circuit states are stored in the
\fIstate\fP
subdirectory of this directory, in subdirectories named after the circuit name\&. Default:
\fI/var/lib/mailping\fP
.RE
.PP
\fBEXTENSION\fP
.RS 4
Name of the current circuit to store the mail for\&.
.RE
.SH "SEE ALSO"
.PP
 mailping\-cron(1), mailping\-success(1), mailping\-latency(1) 
.SH "AUTHOR"
.PP
\fBTommi Virtanen\fR <\&tv@havoc\&.fi\&>
.br
Havoc Consulting
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2004 Havoc Consulting
.br