PIMM gate, PARSE_MULTIPART_RELATED function

Parses a MIME MultipartRelated message, splitting out the root document and the binary attachments. The root document and headers replace the contents of the original message in the container, and any binary attachments are stored in separate containers. The list of attachments is stored in the attachments list container.

Input Parameters

ATTACHMENTS_CONTAINER
The 16-byte name of the container in the specified channel that contains the binary attachments list.
BODY_CONTAINER
The 16-byte name of the body container in the specified channel that contains XOP or XML data. This should be a container of DATATYPE(CHAR).
CHANNEL_NAME
Optional parameter
The 16-byte name of the channel for all referenced containers. If this parameter is omitted, then the current channel is assumed.
HEADERS_CONTAINER
The 16-byte name of the headers container in the specified channel. This should be a container of DATATYPE(CHAR) that contains the MIME headers.

Output Parameters

ATTACHMENTS_COUNT
Optional parameter
The number of <xop:Include> elements that were processed. If the number is 0, the original body container does not include any XOP elements and has not been modified.
REASON
The following values are returned when RESPONSE is EXCEPTION:
  • NOT_MULTIPART_RELATED
  • CHANNEL_NOT_FOUND
  • CONTAINER_NOT_FOUND
  • CONTAINER_CCSID_ERROR
  • CONTAINER_WRONG_TYPE
  • CONTAINER_NAME_INVALID
  • HEADER_SYNTAX_ERROR
  • MIME_HEADER_ERROR
  • MIME_BOUNDARY_ERROR
  • ROOT_PART_NOT_FOUND
  • ENCODING_NOT_SUPPORTED
  • CHARSET_NOT_SUPPORTED
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_PIMMparse_multipart_related.html | Timestamp icon Last updated: Monday, 5 June 2017