# pm-jastore.rc -- Store messagee to inbox or gzip inbox
# $Id: pm-jastore.rc,v 2.4 2004/04/04 16:59:06 jaalto Exp $
#
#   File id
#
#       .Copyright (C)  1997-2004 Jari Aalto 
#       .$Keywords:     procmail, subroutine, storing, saving message $
#
#       This code is free software in terms of GNU Gen. pub. Lic. v2 or later
#	Refer to http://www.gnu.org/copyleft/gpl.html
#
#   Description
#
#	This subroutine stores the message to file pointed by `MBOX'. This
#	subroutine is meant to be used with the the other general purpose
#	includerc files. This makes it possible to have a centralized file
#	storage handling for all your rc files.
#
#	Regular user doesn't get much out of this rc unless he mixes both
#	.gz and regular files in his .procmailrc
#
#	R e p e a t: This module is basis for general purpose procmail
#	rc plug-ins to strre message to mailbox pointed by some rc
#	configuration variable. Normal user can simply say in his .procmailrc:
#
#	    :0:
#	    mail.private
#
#   Required settings
#
#	(none)
#
#   Call arguments (variables to set before calling)
#
#	`MBOX'		must have been set to point to message storage.
#	`MBOX_SUFFIX'	is extension added to MBOX. Default is none.
#	`MBOX_MH'	if "yes" then deliver to MH mailbox with
#			`MBOX_MH_CMD' which is "rcvstore" by default.
#
#	o   message is delivered to MH mailbox using `MBOX_MH_CMD'
#
#       otherwise
#
#	o   If MBOX is `some.mbox'     the message is stored as is.
#	o   If MBOX is `some.mbox.gz'  the message is gzipped to folder.
#	o   If MBOX is `some-dir/.'    then deliver as individual files
#
#   Example usage
#
#           $RC_MBOX   = $PMSRC/pm-jastore.rc
#
#           :0
#           * condition
#           {
#               MBOX = $HOME/Mail/spool/junk.mbox   INCLUDERC = $RC_MBOX
#           }
#
#   Change Log: (none)

# ............................................................ &init ...

id    = "pm-jastore.rc"
dummy = "
========================================================================
$id: init:
"


# ........................................................... &do-it ...
#   make sure you define MBOX before calling this module.

:0 h
* MBOX ?? /dev/null
/dev/null

:0 E
*   MBOX ?? [a-z]
{

    MBOX_SUFFIX = ${MBOX_SUFFIX:-""}
    MBOX_MH     = ${MBOX_MH:-"no"}
    MBOX_MH_CMD = ${MBOX_MH_CMD:-"rcvstore"}
    lock        = "$MBOX$LOCKEXT"

    :0 fhw              # Add possibly missing From_ line
    * ! ^From +
    | $FORMAIL

    dummy = "pm-jastore.rc: testing MH mbox"

    :0
    * MBOX_MH ?? yes
    {
        #   Do we need lock for MH ?

        :0 w: $lock
        | $MBOX_MH_CMD $MBOX
    }
    :0 E
    {

    	dummy = "pm-jastore.rc: testing compressed mbox"

        :0 w: $lock
        * MBOX ?? \.gz
        | $GZIP -9fc >> $MBOX

        #   Whether it is regular mbox or directory, this
        #   will deliver the message to it

        :0 E
 	{

    	    dummy = "pm-jastore.rc: if empty MBOX_SUFFIX (ordinary mbox)"

	    :0 :
	    * MBOX_SUFFIX ?? ^^^^
	    $MBOX

	    :0 E: 
	    $MBOX$MBOX_SUFFIX
 	}

}

:0 E
{
    dummy = "pm-jastore.rc: ***** WARNING - MBOX variable is empty ******"
} 

dummy = "$id: end:"

# pm-store.rc ends here