Integration Server 10.3 | Built-In Services Reference Guide | MIME Folder | Summary of Elements in this Folder | pub.mime:getBodyPartHeader
 
pub.mime:getBodyPartHeader
WmPublic. Returns the list of header fields for the specified body part.
Input Parameters
mimeData
Document MIME object whose message headers you want to retrieve. (This IData object is produced by pub.mime:createMimeData)
index
String Optional. Index number of the body part whose header fields you want to retrieve. The first body part is index zero.
Note:
If contentID is specified, index is ignored.
contentID
String Optional. Value of the Content-ID header field of the body part whose header fields you want to retrieve.
decodeHeaders
String Conditional. Flag whose value indicates whether to decode encoded headers in the MIME object. Set to:
*true to indicate that the headers should be decoded.
*false to indicate that the headers should not be decoded. This is the default.
Output Parameters
mimeHeader
Document IData object containing the message headers. Key names represent the names of the header fields. The value of a key represents the value of that header field.
For example, if the original message contained the following message header fields:
Content-Type: text/xml
X-Doctype: RFQ
X-Severity: 0
get Body Part Header would return the following IData object:
Key
Value
Content-Type
text/xml
X-Doctype
RFQ
X-Severity
0
Usage Notes
This service operates on the MIME object (mimeData) produced by pub.mime:createMimeData.
If you omit index or contentID, getBodyPartHeader returns the message headers from the first body part. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.
For general information about MIME messages and using the MIME services, see the MIME-S/MIME Developer’s Guide.
See Also
pub.mime:createMimeData
pub.mime:addBodyPart
pub.mime:getMimeHeader