The MIME_Part:: class provides a wrapper around MIME parts and methods for dealing with them.
$Horde: framework/MIME/MIME/Part.php,v 1.177.4.30 2010/07/07 23:27:51 slusarz Exp $
Copyright 1999-2009 The Horde Project (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
Located in /MIME/MIME/Part.php (line 54)
Class | Description |
---|---|
![]() |
The MIME_Message:: class provides methods for creating and manipulating MIME email messages. |
Unique MIME_Part boundary string.
Default value for this Part's size.
The list of CIDs for this part.
The content-ID for this part.
The body of the part.
The content type parameters of this part.
The current transfer encoding of the contents of this part.
The description of this part.
The disposition of this part (inline or attachment).
The disposition parameters of this part.
Should the message be encoded via 7-bit?
The sequence to use as EOL for this part.
The default is currently to output the EOL sequence internally as just "\n" instead of the canonical "\r\n" required in RFC 822 & 2045. To be RFC complaint, the full <CR><LF> EOL combination should be used when sending a message. It is not crucial here since the PHP/PEAR mailing functions will handle the EOL details.
Internal class flags.
Part -> ID mapping cache.
Information/Statistics on the subpart.
The MIME ID of this part.
The subparts of this part.
The subtype (ex.: plain) of this part.
Per RFC 2045, the default is 'octet-stream'.
The desired transfer encoding of this part.
The type (ex.: text) of this part.
Per RFC 2045, the default is 'application'.
MIME_Part constructor.
Add to the list of CIDs for this part.
Add a MIME subpart.
Alter a current MIME subpart.
Add to the body contents of this part.
Clears the body contents of this part.
Clears a content type parameter from this part.
Returns a mapping of all MIME IDs to their content-types.
Get all parameters from the Content-Type header.
Get all parameters from the Content-Disposition header.
Determine the size of a MIME_Part and its child members.
Returns the contents in strict RFC 822 & 2045 output - namely, all newlines end with the canonical <CR><LF> sequence.
Get the character set to use for of this part. Returns a charset for all types (not just 'text/*') since we use this charset to determine how to encode text in MIME headers.
Returns the list of CIDs for this part.
Returns the Content-ID for this part.
Return the body of the part.
Get a content type parameter from this part.
Retrieves the current encoding of the contents in the object.
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.
Get the description of this part.
Get the content-disposition of this part.
Get a disposition parameter from this part.
Get the string to use for EOLs.
Retrieve information about the MIME_Part.
Returns the MIME ID of this part.
Get the name of this part.
Retrieve a specific MIME part.
Get a list of all MIME subparts.
Get the primary type of this part.
Returns the relative MIME ID of this part.
e.g., if the base part has MIME ID of 2, and you want the first subpart of the base part, the relative MIME ID is 2.1.
Output the size of this MIME_Part in KB.
Get the subtype of this part.
Get the transfer encoding for the part based on the user requested transfer encoding and the current contents of the part.
Get the full MIME Content-Type of this part.
Return the unique MIME_Part boundary string generated for this object.
This may not be the boundary string used when building the message since a user defined 'boundary' Content-Type parameter will override this value.
Add the appropriate MIME headers for this part to an existing array.
Remove a MIME_Part subpart.
Replace newlines in this part's contents with those specified by either the given newline sequence or the part's current EOL setting.
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 MIME_Part object from IMAP header information without loading the data of the part).
Set the character set of this part.
Sets the Content-ID header for this part.
Set the body contents of this part.
Add a content type parameter to this part.
Set the description of this part.
Set the content-disposition of this part.
Add a disposition parameter to this part.
Sets a new string to use for EOLs.
Add information about the MIME_Part.
Alter the MIME ID of this part.
Set the name of this part.
TODO: MIME encode here instead of in header() - add a charset parameter.
Set the transfer encoding to use for this part.
Set the mimetype of this part.
Split the contents of the current Part into its respective subparts, if it is multipart MIME encoding. Unlike the imap_*() functions, this will preserve all MIME header information.
The boundary content-type parameter must be set for this function to work correctly.
Should we make sure the message is encoded via 7-bit (e.g. to adhere to mail delivery standards such as RFC 2821)?
Returns the encoded part in strict RFC 822 & 2045 output - namely, all newlines end with the canonical <CR><LF> sequence.
Return the entire part in MIME format. Includes headers on request.
Decodes the contents of the part to either a 7bit or 8bit encoding.
Transfer decode the contents and set them as the new contents.
Encodes the contents with the part's transfer encoding.
Transfer encode the contents (to the transfer encoding identified via getTransferEncoding()) and set as the part's new contents.
Documentation generated on Sun, 30 Jan 2011 05:20:16 +0000 by phpDocumentor 1.4.3