File 'mail.tcl' (part of 'Fmail')

::fmail::mail (type data)
Converts a mail into an input object usable by the rule engine. The mail can be specified either as channel or as string. In case of a channel the channel will be read until EOF. The procedure uses Tcl MIME to parse the mail. That package provides the implementations of the mail object methods too.
Argument: type	Specifies how the mail is given to the command. Either "channel" or "string".
Argument: data	Dependent on type. For a channel the handle of the channel to read. In case of "string" the mail itself.
Returns: the name of a command representing the mail as an object. The methods of the object are provided by Tcl MIME.

::fmail::mailObj (part method args)
The procedure wrapping around mails. Provides all procedures from Tcl MIME as methods and additionally 'delete' and 'copy2channel'. The latter is required to allow the usage of ::fmail::Pipeto.
Argument: part	The handle of the mail the procedure is wrapped about.
Argument: method	The name of the method to call.
Argument: args	Any additional arguments to the method.
Returns: depends on the called method.

::fmail::mailUnwrap (mail)
Complement to ::fmail::mailWrap. Removes the alias.
Argument: mail	The handle of the mail to unwrap.

::fmail::mailWrap (mail)
Adds an alias to the calling interpreter to reroute command based access to a Tcl MIME mail handle to an accessor procedure. The effect of this is that the mail handle acts like an object command afterward.
Argument: mail	The handle of the mail to wrap.