Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

formular

Processing of CGI email forms.

  1. Outdated egg!
  2. formular
    1. Introduction
    2. Library procedures
    3. Usage of form2wiki and form2txt
    4. Authors
    5. Version
    6. License

Introduction

FormMail is an HTML form to email gateway that receives the results of an HTML form and sends them to the specified email recipients.

The formular library contains a collection of routines for parsing emails generated by FormMail. The emails can be read either from an s-expression, or from a text file in Unix mbox format, via the mbox library.

There are two programs included with the library, form2wiki and form2txt. These programs read messages generated by FormMail from a Unix mbox file, and generate a representation of the form data in wiki format or text format.

This egg includes a copy of NMS FormMail Version 3.14c1 that has been modified to 1) include the submitted fields in the confirmation email; 2) use quotation marks to enclose field text that contains newline characters; 3) escape the submitted text in the notification email.

Library procedures

[procedure] mbox-messages->tree:: [MESSAGE] -> TREE

Given a list of messages created by the mbox-file->messages procedure in the mbox library, this procedure returns an ordered dictionary structure, where the key is the email address of the form sender, and the value is the list of all forms submitted by that sender. The API of the dictionary object follows that of the rb-tree library.

Usage of form2wiki and form2txt

 
form2wiki [options...]

The following options are recognized:

--exclude=FROM1
FROM2:... : specify a colon-separated list of entries to exclude (default is none )
--include=FROM1
FROM2:... : specify a colon-separated list of entries to include (default is all )
--after-date=N
omit entries with date before N (given in seconds)
--flimits=FIELD1
LIMIT1,... : specify a comma-separated list of fields and character limits (default is none )
--fields=FIELD1
FIELD2:... : specify a colon-separated list of fields to process (default is all fields )
--mbox-path=PATH
specify path to input mbox (default: mbox)
--order=N
specify order of form id (default: 3)
--prefix=STRING
specify prefix for wiki page title (default: Form Submission)
--read-alist=FILE
read an alist representation from FILE (mbox-path is ignored)
--stream
use the byte-blob-stream library for I/O
-h, --help
Print help
form2txt [options...] operands

The following options are recognized:

--exclude=FROM1
FROM2 : specify a colon-separated list of entries to exclude (default is none )
--after-date=N
omit entries with date before N (given in seconds)
--fields=FIELD1
FIELD : specify a colon-separated list of fields to process (default is all fields )
--mbox-path=PATH
specify path to input mbox (default: mbox)
--order=N
specify order of form id (default: 3)
--prefix=STRING
specify prefix for text page title (default: Form Submission)
--write-alist=FILE
write an alist representation to FILE
--read-alist=FILE
read an alist representation from FILE (mbox-path is ignored)
--stream
use the byte-blob-stream library for I/O
-h, --help
Print help

Authors

Ivan Raikov

Version
5.x
transition to typeclass interface for rb-tree
4.3
additional checks for well-formed fields in form2txt and form2wiki
4.1
added option --stream to form2txt and form2wiki
3.4-3.5
Small bug fixes in command-line option handling and data field processing
3.3
Update to reflect the API of rb-tree 4.0
3.2
Added missing dependency on byte-blob-stream

License

 
Copyright 2008-2013 Ivan Raikov and the Okinawa Institute of Science
and Technology.

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 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.

A full copy of the GPL license can be found at
<http://www.gnu.org/licenses/>.