Class: Mail_mimePart
Source Location: /modules/Apps/MailClient/PEAR/Mail/mimePart.php
Class Mail_mimePart
Class Overview
|
The Mail_mimePart class is used to create MIME E-mail messages
This class enables you to manipulate and build a mime email from the ground up. The Mail_Mime class is a userfriendly api to this class for people who aren't interested in the internals of mime mail. This class however allows full control over the email.
Located in /modules/Apps/MailClient/PEAR/Mail/mimePart.php [line 74]
Author(s):
Information Tags:
|
Methods
|
Methods
Mail_mimePart Mail_mimePart(
[$body
$body = ''], [$params
$params = array()]
)
|
|
Constructor.
Sets up the object.
Parameters:
|
$body |
$body: |
- The body of the mime part if any. |
|
$params |
$params: |
- An associative array of parameters: content_type - The content type for this part eg multipart/mixed encoding - The encoding to use, 7bit, 8bit, base64, or quoted-printable cid - Content ID to apply disposition - Content disposition, inline or attachment dfilename - Optional filename parameter for content disposition description - Content description charset - Character set to use |
API Tags:
A &addSubPart(
$body
$body, $params
$params
)
|
|
&addSubPart()
Adds a subpart to current mime part and returns a reference to it
Parameters:
|
$body |
$body: |
The body of the subpart, if any. |
|
$params |
$params: |
The parameters for the subpart, same as the $params argument for constructor. |
API Tags:
| Return: | reference to the part you just added. It is crucial if using multipart/* in your subparts that you use =& in your script when calling this function, otherwise you will not be able to add further subparts. |
| Access: | public |
encode()
Encodes and returns the email. Also stores it in the encoded member variable
API Tags:
| Return: | associative array containing two elements, body and headers. The headers element is itself an indexed array. |
| Access: | public |
|
|
