message.tcl' (part of 'Pool_Net')

Description (short): Mail manipulation, defined in separate namespace, tcl 8.x only.
Written by: Andreas Kupries
Description: Mail manipulation functionality, from the simple to the arcane (not yet?)
Depends on: Tcl
Keywords: Mail manipulation, Header manipulation, RFC 821, RFC 822

::pool::mail::address (text)
::pool::mail::addressB (text default)
::pool::mail::addresses (text)
::pool::mail::analyse (message)
::pool::mail::body (message)
::pool::mail::build (msgvar)
::pool::mail::header (message)
::pool::mail::headerAnalyse (header)
::pool::mail::invisibleRecipients (msgvar)
::pool::mail::recipients (msgvar)
::pool::mail::sender (msgvar)

::pool::mail::address (text)

Extracts a valid rfc821 address from text. Copied from 'Exmh/lib/msgShow.tcl' (copyright: Brent Welch)

Argument: text The string to search for a mail address

Returns: Hopefully a valid mail address.

::pool::mail::addressB (text default)

see RFC 821 on mail messages originally copied from 'Exmh/lib/msgShow.tcl'. Added comments and default argument. A variant of ::pool::mail::address, returns the default if no address could be recognized.

Argument: text Text check for an embedded email address.

Argument: default (= {}) value to use if no address was extractable.

Returns: The email address embedded in text or the default.

::pool::mail::addresses (text)

Extracts a list of address from text. They must be separated by ,

Argument: text The string to search for a mail addresses

Returns: Hopefully a list of valid mail addresses.

::pool::mail::analyse (message)

Transforms the whole message into a form suitable for 'array set'. The body is stored as pseudo header 'x-body:'.

Argument: message String containing the message to be analysed.

Returns: Returns a list of header keywords and associated contents.

::pool::mail::body (message)

Extract the body of message.

Argument: message String containing the message to be analysed.

Returns: Return body of message.

::pool::mail::build (msgvar)

Takes an array containing headers and body of a message (same format as generated by ::pool::mail::analyse) and builds a message string.

Argument: msgvar Name of the array variable containing the message in split form

Returns: A message suitable for transmission

::pool::mail::header (message)

Extract the headers from the message.

Argument: message String containing the message to be analysed.

Returns: Return headers of message.

::pool::mail::headerAnalyse (header)

Transform the message header into a form suitable to 'array set'. Multiple instances of the same header are merged into one (Received:). Continuation lines are merged into a single line.

Argument: header String containing the headers to be analysed

Returns: List suitable for 'array set', mapping header keywords to their contents. Keywords are all lowercase.

::pool::mail::invisibleRecipients (msgvar)

Retrieves the recipients of the message which are invisible to all others from the given array.

Argument: msgvar Name of the array variable containing the message in split form

Returns: List of addresses

::pool::mail::recipients (msgvar)

Retrieves the recipients of the message from the given array.

Argument: msgvar Name of the array variable containing the message in split form

Returns: Mail addresses of the recipients.

::pool::mail::sender (msgvar)

Retrieves the sender of the message from the given array.

Argument: msgvar Name of the array variable containing the message in split form

Returns: Mail address of sender.

Generated by AutoDoc 2.4 at 09/14/2000, invoked by Andreas Kupries

::pool::mail::address (text)
Extracts a valid rfc821 address from text. Copied from 'Exmh/lib/msgShow.tcl' (copyright: Brent Welch)
Argument: text	The string to search for a mail address
Returns: Hopefully a valid mail address.

::pool::mail::addressB (text default)
see RFC 821 on mail messages originally copied from 'Exmh/lib/msgShow.tcl'. Added comments and default argument. A variant of ::pool::mail::address, returns the default if no address could be recognized.
Argument: text	Text check for an embedded email address.
Argument: default (= {})	value to use if no address was extractable.
Returns: The email address embedded in text or the default.

::pool::mail::addresses (text)
Extracts a list of address from text. They must be separated by ,
Argument: text	The string to search for a mail addresses
Returns: Hopefully a list of valid mail addresses.

::pool::mail::analyse (message)
Transforms the whole message into a form suitable for 'array set'. The body is stored as pseudo header 'x-body:'.
Argument: message	String containing the message to be analysed.
Returns: Returns a list of header keywords and associated contents.

::pool::mail::body (message)
Extract the body of message.
Argument: message	String containing the message to be analysed.
Returns: Return body of message.

::pool::mail::build (msgvar)
Takes an array containing headers and body of a message (same format as generated by ::pool::mail::analyse) and builds a message string.
Argument: msgvar	Name of the array variable containing the message in split form
Returns: A message suitable for transmission

::pool::mail::header (message)
Extract the headers from the message.
Argument: message	String containing the message to be analysed.
Returns: Return headers of message.

::pool::mail::headerAnalyse (header)
Transform the message header into a form suitable to 'array set'. Multiple instances of the same header are merged into one (Received:). Continuation lines are merged into a single line.
Argument: header	String containing the headers to be analysed
Returns: List suitable for 'array set', mapping header keywords to their contents. Keywords are all lowercase.

::pool::mail::invisibleRecipients (msgvar)
Retrieves the recipients of the message which are invisible to all others from the given array.
Argument: msgvar	Name of the array variable containing the message in split form
Returns: List of addresses

::pool::mail::sender (msgvar)
Retrieves the sender of the message from the given array.
Argument: msgvar	Name of the array variable containing the message in split form
Returns: Mail address of sender.