Module : mime
Module Overview
This module provides functions to encapsulate multiple body parts such as attachments into a single message. The communication of such messages follow the MIME (Multipurpose Internet Mail Extensions) specification as specified in the RFC 2045 standard.
Entity refers to the header fields and the content of a message or a part of the body in a multipart entity.
Modify and retrieve the data in an entity
This module provides functions to set and get an entity body from different kinds of message types such as XML, text, JSON, byte[], and body parts. Headers can be modified through functions such as addHeader()
, setHeader()
, removeHeader()
, etc.
For information on the operations, which you can perform with this module, see the below Functions. For examples on the usage of the operations, see the Request with multiparts Example and Response with multiparts Example.
Detail |
Holds the details of the entity header and body-related errors. |
ContentDisposition |
Represents values in |
Entity |
Represents the headers and body of a message. |
MediaType |
Describes the nature of the data in the body of a MIME entity. |
base64Decode |
Deprecated API. |
base64DecodeBlob |
Deprecated API. |
base64Encode |
Deprecated API. |
base64EncodeBlob |
Deprecated API. |
getContentDispositionObject |
Given the Content-Disposition as a string, gets the ContentDisposition object with it. |
getMediaType |
Gets the |
prepareDecodingErrorWithDetail |
Constructs a |
prepareEncodingErrorWithDetail |
Constructs an |
LEADING |
Header is placed before the payload of the request/response. |
TRAILING |
Header is placed after the payload of the request/response. |
APPLICATION_OCTET_STREAM |
Represents the |
APPLICATION_JSON |
Represents the |
APPLICATION_XML |
Represents the |
APPLICATION_SVG_XML |
Represents the |
APPLICATION_XHTML_XML |
Represents the |
APPLICATION_SOAP_XML |
Represents the |
APPLICATION_FORM_URLENCODED |
Represents the |
APPLICATION_PDF |
Represents the |
IMAGE_JPEG |
Represents the |
IMAGE_GIF |
Represents the |
IMAGE_PNG |
Represents the |
MULTIPART_FORM_DATA |
Represents the |
MULTIPART_MIXED |
Represents the |
MULTIPART_ALTERNATIVE |
Represents the |
MULTIPART_RELATED |
Represents the |
MULTIPART_PARALLEL |
Represents the |
TEXT_PLAIN |
Represents the |
TEXT_HTML |
Represents the |
TEXT_XML |
Represents the |
ENCODE_ERROR |
Identifies encoding errors. |
DECODE_ERROR |
Identifies decoding errors. |
GENERIC_MIME_ERROR |
Identifies generic errors related to MIME. |
SET_HEADER_FAILED |
Identifies the set header errors. |
READING_HEADER_FAILED |
Identifies header parsing errors. |
PARSER_ERROR |
Identifies entity body parsing errors. |
INVALID_CONTENT_TYPE |
Identifies errors related to content-type header. |
HEADER_UNAVAILABLE |
Identifies errors related to header unavailability. |
IDLE_TIMEOUT_TRIGGERED |
Identifies errors related to read/write timeouts. |
NO_CONTENT_ERROR_CODE |
Identifies the errors occurred due to payloads with no content. |
BOUNDARY |
Key name for |
START |
Key name for |
TYPE |
Key name for |
CHARSET |
Key name for |
DEFAULT_CHARSET |
Default charset to be used with MIME encoding and decoding. |
CONTENT_ID |
Represents |
CONTENT_LENGTH |
Represents |
CONTENT_TYPE |
Represents |
CONTENT_DISPOSITION |
Represents |
Error |
Represents MIME related errors. |
HeaderPosition |
Defines the position of the headers in the request/response. |
DecodeError |
Represents a |
EncodeError |
Represents an |
GenericMimeError |
Represents a |
HeaderUnavailableError |
Represents a |
IdleTimeoutTriggeredError |
Represents an |
InvalidContentTypeError |
Represents an |
NoContentError |
Represents a |
ParserError |
Represents a |
ReadingHeaderFailed |
Represents a |
SetHeaderError |
Represents a |