Mail Body Part Object

Overview

---

Sections

Init, Main, Procedures, OnExit, and Structure.

note

The object is declared in the Declare section.

Properties

Name	Description
BodyParts	Contains only the "sibling" parts that exist at the level of the referenced Message Object or Part Object.
Charset	The character set used for string/byte conversions in Data and DataAsString properties.
Data	Data associated with the part.
DataAsString	Data associated with the part.
Error	Indicates that an MD5 digest string was included and the digest has been checked and found invalid.
File	The attached (decoded) file for this Part Object.
Headers	Collection of header fields contained in a Part Object.
Index	Identifier for a body part.
ObjectIsEmpty	Returns 1 if object is not created.
LastReturnCode	Returns last known return code from object.

note

Properties ObjectIsEmpty and LastReturnCode are common methods. For more information see Common properties and methods.

Methods

Name	Description
CreateObject	Creates a new instance of the object.
FreeObject	Releases the instance of the object.

note

Methods CreateObject and FreeObject are common methods. For more information see Common properties and methods.

See Also

Mail Message Object
Mail Body Parts Object

Properties

---

BodyParts

This property contains the collection of child body parts.

Type: Mail Body Parts Object
Default: -
Read: get_BodyParts
Write: put_BodyParts

---

Charset

The character set used for string/byte conversions in Data and DataAsString properties. This value defaults to the language used on the runtime machine.

Type: CharsetName
Default: -
Read: get_Charset
Write: put_Charset

---

Data

This property contains data associated with the part. If the part references an attached file, and the AttachmentDirectory property is "" (empty string), this property contains the file contents when the message is decoded. Otherwise, the property is empty.

If the part contains text, this property is used to set or read the text. When this property is set, ReturnType is ignored. The DataAsString, Data and File properties are mutually exclusive.

DataAsString and Data contains the same data.

Type: Binary Array Object Default: -
Read: get_Data
Write: put_Data

See Also

Mail Body Part Object::DataAsString
Mail Body Part Object::File

---

DataAsString

This property contains data associated with the part. If the part references an attached file, and the AttachmentDirectory property is "" (empty string), this property contains the file contents when the message is decoded. Otherwise, the property is empty.

If the part contains text, this property is used to set or read the text. When this property is set, ReturnType is ignored. The DataAsString, Data and File properties are mutually exclusive.

DataAsString and Data contains the same data.

Type: String
Default: -
Read: get_DataAsString
Write: put_DataAsString

See Also

Mail Body Part Object::Data
Mail Body Part Object::File

---

Error

Indicates that an MD5 digest string was included and the digest has been checked and found invalid. This suggests that the received message part does not match the authored message part.
The integrity of individual body parts is reflected in this property. MD5 digest checking is always performed when a Content-MD5 label is detected.

Type: ParamTypeBool
Default: -
Read: get_Error
Write: -

---

File

The attached (decoded) file for this Part. When a message containing an attachment is received, the filename is stripped of path information and the AttachmentDirectory property is prepended to the received name to produce this property.

When composing, you may set the File property to the fully qualified name of the file to be attached.

The DataAsString, Data and File properties are mutually exclusive.

Type: ParamTypeFilepath
Default: -
Read: get_File
Write: put_File

See Also

Mail Body Part Object::Data Mail Body Part Object::DataAsString

---

Headers

Collection of header fields contained in a Mail Body Part Object.

The difference between the Header property associated with the Mail Message Object and Mail Body Part Object is the treatment of the To, Cc, and Bcc labels. The Mail Message Object has separate properties for these labels, and therefore excludes these labels from the Header property. The Mail Body Part Objects include these labels within this property.

Type: Mail Header Fields Object
Default: -
Read: get_Headers
Write: put_Headers

See Also

Mail Message Object::Headers
Mail Message Object::HeaderLabel

---

Index

Identifier for a body part. This value is recalculated whenever changes to the message structure occur.

Read-only.

The property is defined by the relative position of the Mail Body Part Object within the structure of a message. If the structure of the message is altered, then this property changes.

Returned form is Level1.Level2. ... .Levelx. For example, "2.3.1".

Type: String
Default: -
Read: get_Index
Write: -

---