debian man page for lr_getbody

LR_GETBODY.IN(1)					  LogReport's Lire Documentation					  LR_GETBODY.IN(1)

NAME
       lr_getbody - Extract file, sender and subject information from an email

SYNOPSIS
       eval `lr_getbody [-c content-type] <messagefile>`

DESCRIPTION
       lr_getbody reads an email message on stdin (or specified as argument), will extract the submitter address and the subject from that email.
       It will also extract the biggest attachment or the first one having a content-type matching the content-type argument.

       This information is passed to the caller by printing that information in a format suitable for eval. The following variable will be printed
       on STDOUT:

       lr_getbody_SUBMITTER
	   Email address of the submitter. That is the first email that is found in the headers (searched in the following order): Reply-To, From,
	   Sender. This will only contains the address portion (without the <>).

       lr_getbody_TO
	   The email address to which the email was sent.

       lr_getbody_SUBJECT
	   Subject of the message. That string is sanitized.

       lr_getbody_DATE
	   The date of the message. That string is sanitized.

       lr_getbody_FILE
	   Path to the temporary file holding the found attachment.

       lr_getbody_OK
	   This will be set if the operation was completed successfully. It is possible for lr_getbody to fail to extract the attachment, but the
	   header information might still be available.

       This script is used by lr_processmail(1) and lr_rawmail2mail(1).

VERSION
       $Id: lr_getbody.in,v 1.10 2006/07/23 13:16:33 vanbaal Exp $

COPYRIGHT
       Copyright (C) 2002 Stichting LogReport Foundation LogReport@LogReport.org

       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 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with
       http://www.gnu.org/copyleft/gpl.html.

AUTHOR
       Francis J. Lacoste <flacoste@logreport.org>

Lire 2.1.1							    2006-07-23							  LR_GETBODY.IN(1)