mailMessage

The mailMessage allows processing of an internet mail message.  Framework EDI (FREDI) recognizes an internet mail message as a document that follows the standard described in RFC 822: Standard For the Format of ARPA Text Messages, which basically describes a text message consisting of a header and a body.  This standard has been revised to RFC 2822: Internet Message Format  and extended into other RFCs (example MIME), but still the fundamental concept of the header-body message continue to be maintained.

• Header.  The header section always appears before the body and consists of a list of fields.  A single field is made up of a field name and a field value separated by a colon.  The field is terminated by a carriage-return line-feed pair (CRLF).
• Body.  The body is optional and contains the freeform data of the message.  In a composite message, the body does not exist but is instead replaced with multiple sub messages or body parts.

The header and body section must be separated by an empty line.

 

Message Header

The message header section consists of a list of fields.  A header field consists of a field name and a field value separated by a colon. The field is terminated by a carriage-return line-feed pair (CRLF). 

            <field name> <colon> <field value> <CRLF>

 Example: 

            Subject: The quick brown fox 

Where:

            “Subject” is the field name.
            “The quick brown fox” is the field value.

The header section of the message can contain a list of fields that must follow each other in succession and not separated by any empty line.  When the header gets too long, the field value is terminated with a CRLF, and continues to the next line preceded by a character space.  This is known as folding. 

Example of header being folded:

The first empty line encountered indicates the end of the header section and any data following thereafter begins the body section. 

Example:

Message Body

The message body is the freeform data.  Any data can go here even binary data.  In a composite message, the single body is replaced by multiple sub messages separated by a boundary string.  The composite message must have the “Content/Type” header which specifies the type of composite message -- “multipart” or “message” – and specifies the boundary string in the “boundary” parameter.

Example of composite message:

Methods

• AddTextToBody - Appends or concatenates a text to the body of the message.
• Erase - Erases the contents of the message.
• GenerateDigest - Calculates and return the digest of the message or parts of the message.
• GetBody - Gets the body of the message.
• GetContentTransferEncoding - Gets the object representing the MIME content transfer encoding header.
• GetContentType - Gets the object representing the MIME content type header.
• GetHeaderTypeDate - Gets a header having a Date type.
• GetHeaderTypeParameters - Gets a header having a Parameters type.
• GetHeaderTypeURI - Gets a header having an URI type.
• GetMessages - Gets the collection of sub messages or body parts containing in the message.
• GetMsgString - Gets the string representing the entire message.
• GetSecurity - Gets the security object of the message.
• Import - Imports the contents of an external file to the body of the message.
• Prepare - Applies the changes made to the message and returns a new message based on the changes.
• PrepareNew - Applies the changes made to the message and returns a new message based on the changes.
• PutEdi - Puts the entire output of the EDI document, currently loaded, into the body of the message.
• PutMsgString - Builds the entire the message internally by concatenating strings to an internal string that represents the message.
• Save - Saves the entire content of the message to an external file.
• UnZip - Decompresses or inflates the compressed body of the message and replaces the current message with the expanded data.
• VerifyDigest - Verifies a digest against a message or part of a message.
• Zip - Compresses the message header and body and replaces the body with the compressed data.

Properties

• BodyText - Sets or gets the text content of the body of the message.
• Boundary - Sets or gets the boundary.
• EnableMultipartEncrypt - Sets or gets the security configuration to indicate if multipart/encrypted should be applied when encrypting.
• EnableMultipartSigned - Sets or gets the security configuration to indicate if multipart/signed should be applied when digital signing.
• HeadersCount - Gets the count of headers already in the message.
• HeaderFieldValue - Sets or gets the field value of a message header.