Whitebeam Object Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Object Definition

MessageGroup.message

Generic message container

Elements

The MessageGroup.message struct has 12 elements:

Name Type/Value Range/Length Description
fromstring7-240 characters Optional.

The return ("From:") address to be set in the message header and envelope

Note that this is the composite from address from the message template, including both Full Name, and email address in one of a number of valid formats according to Internet and news address formats.

If this is not present or empty then it will be created from the name and email properties.
Note that it is preferable to reference name and email properties rather than the raw from property for almost all purposes.

emailstring7-240 characters Optional.

The email part of the from address in the article header

namestring7-240 characters Optional.

The return ("From:") address to be set in the message header and envelope

Must be a valid RFC822 sender addresses

groupsarray of strings1 - 20 newsgroup identifiers, each of up to 240 characters Optional. An array of valid newsgroup identifiers
referencesarray of strings0 - 20 strings, each of up to 240 characters Optional. An array of valid message Ids, of articles which a preceed this on in the thread
All addresses must be valid RFC822 message IDs
subjectstring1-80 characters Optional. A valid subject line for this message Without the "Subject: " header text
datestring1-80 characters Optional. An RFC 822 Date string
messageIDstring1-80 characters Optional. Read only string, the message ID of this message.
bodystring0-16384 characters Optional. Raw body text of the message.
childarray of struct MessageGroup.messagessee definition Optional. This is an array of all the messages which are direct replies to this message.
parentstruct MessageGroup.messagesee definition Optional. This is the message to which this article is a direct reply (if it is a reply)
htmlBodystring0-16384 characters Optional.

Read only string, an HTML representation of the raw body text.

Special characters within HTML (e.g. <, >, & etc), are concerted into their escaped equivalent for output.

Additionaly heuristics are applied to the plain text in order to detect strings which look like embedded HTTP URLs, or e-mail addresses. These are converted into hyperlinks suitable for direct output to a browser.


Whitebeam release 1.3.36
(loadtime : 10ms)