implements the MultiPartAlternativeMessage class, a specialization of MultiPartMessage
More...
|
| | addEncodePart (data mime_data, string enc, string content_type=MimeTypeText, string disp='inline', *hash< auto > hdr) |
| | adds a message part to the end of the list; encodes the data according to the transfer encoding argument passed
|
| |
| | addPart (data mime_data, string content_type=MimeTypeText, string disp='inline', *hash< auto > hdr) |
| | adds a message part to the end of the list; the data muyst already be encoded and any Content-Transfer-Encoding header must already be present in hdr
|
| |
| | constructor (string boundary=MultiPartMessage::getBoundary()) |
| | creates the object
|
| |
| hash< MessageInfo > | getMsgAndHeaders () |
| | returns a hash of the message
|
| |
| | spliceEncodePart (data mime_data, string enc, string content_type=MimeTypeText, string disp='inline', *hash< auto > hdr) |
| | adds a message part to the start of the list; encodes the data according to the transfer encoding argument passed
|
| |
| | splicePart (data mime_data, string content_type=MimeTypeText, string disp='inline', *hash< auto > hdr) |
| | adds a message part to the start of the list
|
| |
| | constructor (string mptype, string boundary=MultiPartMessage::getBoundary()) |
| | creates the object
|
| |
| string | getBoundary () |
| | returns the message boundary string used
|
| |
| abstract hash< MessageInfo > | getMsgAndHeaders () |
| | returns a hash of the message
|
| |
|
binary | serialize () |
| | serializes the message with the Content-Type header first and returns a binary object ready to send over a socket
|
| |
| binary | serializeBody () |
| | serializes the message body only and returns a binary object ready to send over a socket
|
| |
| int | size () |
| | returns the number of parts in the message
|
| |
|
|
static string | getBoundary () |
| | returns a string embedded with the current timestamp designed to be used as MultiPart boundary string
|
| |
| static string | getRandomString (int len) |
| | returns a string of random characters
|
| |
| static hash< MessageInfo > | parseBody (string boundary, data body, bool decode=True) |
| | returns a hash representing a parsed multipart message body from a boundary string and body arguments
|
| |
| static binary | serializeHeaders (hash hdr) |
| | serializes a header hash to a binary object
|
| |
implements the MultiPartAlternativeMessage class, a specialization of MultiPartMessage
◆ addEncodePart()
| Mime::MultiPartAlternativeMessage::addEncodePart |
( |
data | mime_data, |
|
|
string | enc, |
|
|
string | content_type = MimeTypeText, |
|
|
string | disp = 'inline', |
|
|
*hash< auto > | hdr ) |
adds a message part to the end of the list; encodes the data according to the transfer encoding argument passed
- Parameters
-
| mime_data | the unencoded data for the part |
| enc | the transfer encoding to use for the part; see MIME Content Transfer Encoding Constants for possible values |
| content_type | the content_type for the part |
| disp | the Content-Disposition header (ex: 'inline', 'attachment; filename="file.txt"') |
| hdr | an optional hash of headers for the part |
- Exceptions
-
| MIME-TRANSFER-ENCODING-ERROR | unknown transfer encoding |
| PART-ERROR | empty content type argument passed |
- See also
-
◆ addPart()
| Mime::MultiPartAlternativeMessage::addPart |
( |
data | mime_data, |
|
|
string | content_type = MimeTypeText, |
|
|
string | disp = 'inline', |
|
|
*hash< auto > | hdr ) |
adds a message part to the end of the list; the data muyst already be encoded and any Content-Transfer-Encoding header must already be present in hdr
- Parameters
-
| mime_data | the data for the part |
| content_type | the content_type for the part |
| disp | the Content-Disposition header (ex: 'inline', 'attachment; filename="file.txt"') |
| hdr | an optional hash of headers for the part |
- Exceptions
-
| PART-ERROR | empty content type argument passed |
- See also
-
◆ constructor()
creates the object
- Parameters
-
| boundary | the boundary to use between parts |
◆ getMsgAndHeaders()
| hash< MessageInfo > Mime::MultiPartAlternativeMessage::getMsgAndHeaders |
( |
| ) |
|
returns a hash of the message
- Returns
- a hash of the message with the following keys:
hdr: a hash of header information
body: a binary object of serialized message parts
◆ spliceEncodePart()
| Mime::MultiPartAlternativeMessage::spliceEncodePart |
( |
data | mime_data, |
|
|
string | enc, |
|
|
string | content_type = MimeTypeText, |
|
|
string | disp = 'inline', |
|
|
*hash< auto > | hdr ) |
adds a message part to the start of the list; encodes the data according to the transfer encoding argument passed
- Parameters
-
| mime_data | the unencoded data for the part |
| enc | the transfer encoding to use for the part; see MIME Content Transfer Encoding Constants for possible values |
| content_type | the content_type for the part |
| disp | the Content-Disposition header (ex: 'inline', 'attachment; filename="file.txt"') |
| hdr | an optional hash of headers for the part |
- Exceptions
-
| MIME-TRANSFER-ENCODING-ERROR | unknown transfer encoding |
| PART-ERROR | empty content type argument passed |
- See also
-
◆ splicePart()
| Mime::MultiPartAlternativeMessage::splicePart |
( |
data | mime_data, |
|
|
string | content_type = MimeTypeText, |
|
|
string | disp = 'inline', |
|
|
*hash< auto > | hdr ) |
adds a message part to the start of the list
The data must already be encoded and any Content-Transfer-Encoding header must already be present in hdr
- Parameters
-
| mime_data | the data for the part |
| content_type | the content_type for the part |
| disp | the Content-Disposition header (ex: 'inline', 'attachment; filename="file.txt"') |
| hdr | an optional hash of headers for the part |
- Exceptions
-
| PART-ERROR | empty content type argument passed |
- See also
-