VERSION
VERSION
Object-oriented representation of a MIME part (RFC 2045-2049).
$parent : \Horde_Mime_Part
Parent object. Value only accurate when iterating.
$_headers : \Horde_Mime_Headers
The MIME headers for this part.
setContents(mixed $contents, array $options = array())
Set the body contents of this part.
| mixed | $contents | The part body. Either a string or a stream resource, or an array containing both. |
| array | $options | Additional options:
|
appendContents(mixed $contents, $options = array())
Add to the body contents of this part.
| mixed | $contents | The part body. Either a string or a stream resource, or an array containing both.
|
| $options |
getContents(array $options = array()) : mixed
Return the body of the part.
| array | $options | Additional options:
|
The body text (string) of the part, null if there is no contents, and a stream resource if 'stream' is true.
getDefaultType() : string
If the subtype of a MIME part is unrecognized by an application, the default type should be used instead (See RFC 2046). This method returns the default subtype for a particular primary MIME type.
The default MIME type of this part (ex.: text/plain).
setTransferEncoding(string $encoding, array $options = array())
Set the transfer encoding to use for this part.
Only needed in the following circumstances: 1.) Indicate what the transfer encoding is if the data has not yet been set in the object (can only be set if there presently are not any contents). 2.) Force the encoding to a certain type on a toString() call (if 'send' is true).
| string | $encoding | The transfer encoding to use. |
| array | $options | Additional options:
|
addMimeHeaders(array $options = array()) : \Horde_Mime_Headers
Returns a Horde_Mime_Header object containing all MIME headers needed for the part.
| array | $options | Additional options:
|
A Horde_Mime_Headers object.
toString(array $options = array()) : mixed
Return the entire part in MIME format.
| array | $options | Additional options:
|
The MIME string (returned as a resource if $stream is true).
replaceEOL(mixed $text, string $eol = null, boolean $stream = false) : string
Replace newlines in this part's contents with those specified by either the given newline sequence or the part's current EOL setting.
| mixed | $text | The text to replace. Either a string or a stream resource. If a stream, and returning a string, will close the stream when done. |
| string | $eol | The EOL sequence to use. If not present, uses the part's current EOL setting. |
| boolean | $stream | If true, returns a stream resource. |
The text with the newlines replaced by the desired newline sequence (returned as a stream resource if $stream is true).
setBytes(integer $bytes)
Explicitly set the size (in bytes) of this part. This value will only be returned (via getBytes()) if there are no contents currently set.
This function is useful for setting the size of the part when the contents of the part are not fully loaded (i.e. creating a Horde_Mime_Part object from IMAP header information without loading the data of the part).
| integer | $bytes | The size of this part in bytes. |
send(string $email, \Horde_Mime_Headers $headers, \Horde_Mail_Transport $mailer, array $opts = array())
Sends this message.
| string | The address list to send to. |
|
| \Horde_Mime_Headers | $headers | The Horde_Mime_Headers object holding this message's headers. |
| \Horde_Mail_Transport | $mailer | A Horde_Mail_Transport object. |
| array | $opts | Additional options:
- broken_rfc2231: (boolean) Attempt to work around non-RFC
2231-compliant MUAs by generating both a RFC
2047-like parameter name and also the correct RFC
2231 parameter (@since 2.5.0).
DEFAULT: false
- encode: (integer) The encoding to use. A mask of self::ENCODE_*
values.
DEFAULT: Auto-determined based on transport driver.
|
findBody(string $subtype = null) : mixed
Finds the main "body" text part (if any) in a message.
"Body" data is the first text part under this part.
| string | $subtype | Specifically search for this subtype. |
The MIME ID of the main body part, or null if a body part is not found.
getPartByIndex( $index) : \Horde_Mime_Part
Returns a subpart by index.
| $index |
Part, or null if not found.
parseMessage(string $text, array $opts = array()) : \Horde_Mime_Part
Attempts to build a Horde_Mime_Part object from message text.
| string | $text | The text of the MIME message. |
| array | $opts | Additional options:
|
A MIME Part object.
getRawPartText(mixed $text, string $type, string $id) : string
Attempts to obtain the raw text of a MIME part.
| mixed | $text | The full text of the MIME message. The text is assumed to be MIME data (no MIME-Version checking is performed). It can be either a stream or a string. |
| string | $type | Either 'header' or 'body'. |
| string | $id | The MIME ID. |
The raw text.
_transferDecode(resource $fp, string $encoding) : resource
Decodes the contents of the part to binary encoding.
| resource | $fp | A stream containing the data to decode. |
| string | $encoding | The original file encoding. |
A new file resource with the decoded data.
_transferEncode(resource $fp, string $encoding) : resource
Encodes the contents of the part as necessary for transport.
| resource | $fp | A stream containing the data to encode. |
| string | $encoding | The encoding to use. |
A new file resource with the encoded data.
_getTransferEncoding(integer $encode = self::ENCODE_7BIT) : string
Get the transfer encoding for the part based on the user requested transfer encoding and the current contents of the part.
| integer | $encode | A mask of allowable encodings. |
The transfer-encoding of this part.
_writeStream(array $data, array $options = array()) : resource
Write data to a stream.
| array | $data | The data to write. Either a stream resource or a string. |
| array | $options | Additional options:
|
The stream resource.
_getStructure(string $header, string $body, array $opts = array()) : \Horde_Mime_Part
Creates a MIME object from the text of one part of a MIME message.
| string | $header | The header text. |
| string | $body | The body text. |
| array | $opts | Additional options:
- ctype: (string) The default content-type.
- forcemime: (boolean) If true, the message data is assumed to be
MIME data. If not, a MIME-Version header must exist to
be parsed as a MIME message.
- level: (integer) Current nesting level.
- no_body: (boolean) If true, don't set body contents of parts.
|
The MIME part object.
_findBoundary(string $text, integer $pos, string $boundary, integer $end = null) : array
Find the location of the next boundary string.
| string | $text | The text to search. |
| integer | $pos | The current position in $text. |
| string | $boundary | The boundary string. |
| integer | $end | If set, return after matching this many boundaries. |
Keys are the boundary number, values are an array with two elements: 'start' and 'length'.
_sanityCheckRfc822Attachments()
Re-enocdes message/rfc822 parts in case there was e.g., some broken line length in the headers of the message in the part. Since we shouldn't alter the original message in any way, we simply reset cause the part to be encoded as base64 and sent as a application/octet part.
_reEncodeMessageAttachment(\Horde_Mime_Part $part)
Rebuilds $part and forces it to be a base64 encoded application/octet-stream part.
| \Horde_Mime_Part | $part | The MIME part. |