ballerina/mime1.1.0-alpha8
Package Overview
This package 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 package 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 package, see the below Functions. For examples on the usage of the operations, see the Request with multiparts Example and Response with multiparts Example.
Functions
[8]
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 |
Classes
[3]
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. |
Constants
[28]
APPLICATION_FORM_URLENCODED | Represents the |
APPLICATION_JSON | Represents the |
APPLICATION_OCTET_STREAM | Represents the |
APPLICATION_PDF | Represents the |
APPLICATION_SOAP_XML | Represents the |
APPLICATION_SVG_XML | Represents the |
APPLICATION_XHTML_XML | Represents the |
APPLICATION_XML | Represents the |
BOUNDARY | Key name for |
CHARSET | Key name for |
CONTENT_DISPOSITION | Represents |
CONTENT_ID | Represents |
CONTENT_LENGTH | Represents |
CONTENT_TYPE | Represents |
DEFAULT_CHARSET | Default charset to be used with MIME encoding and decoding. |
IMAGE_GIF | Represents the |
IMAGE_JPEG | Represents the |
IMAGE_PNG | Represents the |
MULTIPART_ALTERNATIVE | Represents the |
MULTIPART_FORM_DATA | Represents the |
MULTIPART_MIXED | Represents the |
MULTIPART_PARALLEL | Represents the |
MULTIPART_RELATED | Represents the |
START | Key name for |
TEXT_HTML | Represents the |
TEXT_PLAIN | Represents the |
TEXT_XML | Represents the |
TYPE | Key name for |
Errors
[1]
Error | Defines the common error type for the module |