integer $_atcid = 0 (line 101)

Internal ID for attachments.

string $_bodyCharset (line 51)

The "cached" charset of the body MIME part.

string $_cacheid (line 108)

The cache ID used to store object in session.

boolean $_findhtml = false (line 94)

In findBody(), indicate we want to return a text/html part.

string $_mimeid = null (line 44)

For findBody, the MIME ID of the "body" part.

boolean $_resume = false (line 115)

Are we resuming a message?

addFilesFromUpload (line 2947)

Add uploaded files from form data.

• return: Returns false if any file was unsuccessfully added.
• since: IMP 4.2

• string $field: The field prefix (numbering starts at 1).
• string $disp: The prefix for a file disposition input (numbering starts at 1).
• boolean $notify: Add a notification message for each successful attachment?

addMIMEPartAttachment (line 2097)

Adds an attachment to a MIME_Part from data existing in the part.

• return: Returns a PEAR_Error object on error.

• MIME_Part &$part: The MIME_Part object that contains the attachment data.

attachFilesFromMessage (line 2497)

Adds attachments from the IMP_Contents object to the message.

• return: An array of PEAR_Error object on error. An empty array if successful.

• IMP_Contents &$contents: An IMP_Contents object.
• boolean $download: Use the algorithm in IMP_Contents::getDownloadAllList() to determine the list of attachments?

attachVCard (line 2906)

Attach the user's vCard to every message sent by buildAndSendMessage().

• since: IMP 4.2.1

• boolean $attach: True if vCard should be attached.
• string $name: The user's name.

buildAttachment (line 2311)

Build a single attachment part with its data.

• return: The MIME_Part with its contents.

• integer $id: The ID of the part to rebuild.

deleteAllAttachments (line 2253)

Deletes all attachments.

expandAddresses (line 2697)

Uses the Registry to expand names and return error information for any address that is either not valid or fails to expand.

This method can be called statically, i.e.: $ret = IMP_Compose::expandAddresses()

• return: Either a string containing all expanded addresses or an array containing all matching address or an error object.

• string $addrString: The name(s) or address(es) to expand.
• boolean $full: If true generate a full, rfc822-valid address list.
• boolean $include: Include the original search term if it is a valid address?

formatAddr (line 400)

Formats the address properly.

Can be called statically.

• return: The formatted address.

• string $addr: The address to format.

getAttachments (line 2279)

Returns the list of current attachments.

• return: The list of attachments.

getBodyId (line 1573)

Returns the ID of the MIME part containing the "body".

• return: The ID of the mime part's body.

• IMP_Contents &$imp_contents: An IMP_Contents object.

getMessageBody (line 425)

Gets the message body and sets up the MIME parts.

• return: The body as a MIME object, or PEAR_Error on error.

• string $message: The raw message body.
• string $charset: The charset to use.
• boolean $html: Whether this is an HTML message.
• string $final_msg: Whether this is a message which will be sent out.

linkAttachments (line 2624)

Remove all attachments from an email message and replace with urls to downloadable links. Should properly save all attachments to a new folder and remove the MIME_Parts for the attachments.

• return: Modified part with links to attachments. Returns PEAR_Error on error.

• string $baseurl: The base URL for creating the links.
• MIME_Part $base_part: The body of the message.
• string $auth: The authorized user who owns the attachments.

numberOfAttachments (line 2289)

Returns the number of attachments currently in this message.

• return: The number of attachments in this message.

recipientList (line 1187)

Cleans up and returns the recipient list. Encodes all e-mail addresses with IDN domains.

• return: PEAR_Error on error, or an array with the following entries:

   'list' - An array of recipient addresses.
   'header' - An array containing the cleaned up 'to', 'cc', and 'bcc'
              header strings.

• array $hdr: An array of MIME headers. Recipients will be extracted from the 'to', 'cc', and 'bcc' entries.
• boolean $exceed: Test if user has exceeded the allowed number of recipients?

resumeDraft (line 297)

Resumes a previously saved draft message.

• return: PEAR_Error on error, or an array with the following keys:

   'msg' -- The message text.
   'mode' -- 'html' or 'text'.
   'header' -- A list of headers to add to the outgoing message.
   'identity' -- The identity used to create the message.

• string $index: The IMAP message mailbox/index. The index should be in IMP::parseIndicesList() format #1.

saveDraft (line 183)

Saves a message to the draft folder.

• return: Notification text on success, PEAR_Error on error.

• array $header: List of message headers.
• mixed $message: Either the message text (string) or a MIME_Message object that contains the text to send.
• string $charset: The charset that was used for the headers.
• boolean $html: Whether this is an HTML message.
• $headers

sendMessage (line 893)

Sends a message.

• return: True on success, PEAR_Error on error.

• string $email: The e-mail list to send to.
• IMP_Headers &$headers: The IMP_Headers object holding this message's headers.
• mixed &$message: Either the message text (string) or a MIME_Message object that contains the text to send.
• string $charset: The charset that was used for the headers.

sizeOfAttachments (line 2299)

Returns the size of the attachments in bytes.

• return: The size of the attachments (in bytes).

updateAttachment (line 2268)

Updates information in a specific attachment.

• integer $number: The attachment to update.
• array $params: An array of update information.

   'disposition'  --  The Content-Disposition value.
   'description'  --  The Content-Description value.

_addReferences (line 869)

Add necessary headers for replies.

• MIME_Headers &$headers: The object holding this message's headers.
• array $header: List of message headers.