You are looking at historical revision 10248 of this page. It may differ significantly from its current revision.

• egg

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 SRFI-40 stream, or from a text file in Unix mbox format.

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.

Library procedures

read-form:: ENVELOPE * STRM -> FORM

Given SRFI-40 streams that contain an RFC 822 envelope and message, this procedure parses the headers and fields that are found in the message stream, and returns an s-expression of the form:

(form (envelope <envelope-string>) 
      (headers <RFC 822 header alist>) 
      (fields <field alist>))

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 )

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

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

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

-h, --help Print help

Authors

Ivan Raikov

Version

1.0

Initial version

License

Copyright 2008 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/>.