[ Index ]
 

Code source de IMP H3 (4.1.5)

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/lib/ -> Compose.php (sommaire)

The virtual path to use for VFS data.

Poids: 1138 lignes (40 kb)
Inclus ou requis: 5 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

IMP_Compose:: (27 méthodes):
  IMP_Compose()
  sendMessage()
  findBody()
  getBodyId()
  replyMessage()
  forwardMessage()
  _getMsgHeaders()
  addUploadAttachment()
  addMIMEPartAttachment()
  _storeAttachment()
  deleteAttachment()
  deleteAllAttachments()
  updateAttachment()
  getAttachments()
  numberOfAttachments()
  sizeOfAttachments()
  buildAttachment()
  buildAllAttachments()
  _buildPartData()
  _expandAttribution()
  _retrieveMimeCache()
  getMessageCacheId()
  additionalAttachmentsAllowed()
  maxAttachmentSize()
  attachFilesFromMessage()
  convertToMultipartRelated()
  linkAttachments()


Classe: IMP_Compose  - X-Ref

The IMP_Compose:: class contains functions related to generating
outgoing mail messages.

$Horde: imp/lib/Compose.php,v 1.107.2.41 2007/01/02 13:54:55 jan Exp $

Copyright 2002-2007 Michael Slusarz <slusarz@bigworm.colorado.edu>

See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

IMP_Compose($params = array()   X-Ref
Constructor

param: array $params  Parameters needed.

sendMessage($email, &$headers, &$message, $charset)   X-Ref
Sends a message.

param: string $email          The e-mail list to send to.
param: IMP_Headers &$headers  The IMP_Headers object holding this
param: mixed &$message        Either the message text (string) or a
param: string $charset        The charset that was used for the headers.
return: mixed  True on success, PEAR_Error on error.

findBody(&$imp_contents)   X-Ref
Finds the main "body" text part (if any) in a message.

param: IMP_Contents &$imp_contents  An IMP_Contents object.
return: string  The text of the "body" part of the message.

getBodyId(&$imp_contents)   X-Ref
Returns the ID of the MIME part containing the "body".

param: IMP_Contents &$imp_contents  An IMP_Contents object.
return: string  The ID of the mime part's body.

replyMessage(&$imp_contents, $from, &$h)   X-Ref
Determine the reply text for a message.

param: IMP_Contents $imp_contents  An IMP_Contents object.
param: string $from                The email address of the
param: IMP_Headers $h              The IMP_Headers object for
return: string  The text of the body part of the message to use

forwardMessage(&$imp_contents, &$h)   X-Ref
Determine the text for a forwarded message.

param: IMP_Contents &$imp_contents  An IMP_Contents object.
param: IMP_Headers &$h              The IMP_Headers object for
return: string  The text of the body part of the message to use

_getMsgHeaders(&$h)   X-Ref
Determine the header information to display in the forward/reply.

param: IMP_Headers &$h  The IMP_Headers object for the message.
return: string  The header information for the original message.

addUploadAttachment($name, $disposition)   X-Ref
Adds an attachment to a MIME_Part from an uploaded file.
The actual attachment data is stored in a separate file - the
MIME_Part information entries 'temp_filename' and 'temp_filetype'
are set with this information.

param: string $name         The input field name from the form.
param: string $disposition  The disposition to use for the file.
return: mixed  Returns the filename on success.

addMIMEPartAttachment(&$part)   X-Ref
Adds an attachment to a MIME_Part from data existing in the part.

param: MIME_Part &$part  The MIME_Part object that contains the
return: PEAR_Error  Returns a PEAR_Error object on error.

_storeAttachment(&$part, $data, $vfs_file = true)   X-Ref
Stores the attachment data in its correct location.

param: MIME_Part &$part   The MIME_Part of the attachment.
param: string $data       Either the filename of the attachment or, if
param: boolean $vfs_file  If using VFS, is $data a filename?

deleteAttachment($number)   X-Ref
Delete attached files.

param: mixed $number  Either a single integer or an array of integers
return: array  The list of deleted filenames (MIME encoded).

deleteAllAttachments()   X-Ref
Deletes all attachments.


updateAttachment($number, $params)   X-Ref
Updates information in a specific attachment.

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

getAttachments()   X-Ref
Returns the list of current attachments.

return: array  The list of attachments.

numberOfAttachments()   X-Ref
Returns the number of attachments currently in this message.

return: integer  The number of attachments in this message.

sizeOfAttachments()   X-Ref
Returns the size of the attachments in bytes.

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

buildAttachment($id)   X-Ref
Build a single attachment part with its data.

param: integer $id  The ID of the part to rebuild.
return: MIME_Part  The MIME_Part with its contents.

buildAllAttachments(&$base, $charset)   X-Ref
Build the MIME_Part attachments from the temporary file data.

param: MIME_Part &$base  The base MIME_Part object to add the
param: string $charset   The charset to use for the filename.

_buildPartData(&$part)   X-Ref
Takes the temporary data for a single part and puts it into the
contents of that part.

param: MIME_Part &$part  The part to rebuild data into.

_expandAttribution($line, $from, &$h)   X-Ref
Expand macros in attribution text when replying to messages.

param: string $line     The line of attribution text.
param: string $from     The email address of the original
param: IMP_Headers &$h  The IMP_Headers object for the message.
return: string  The attribution text.

_retrieveMimeCache($cacheID)   X-Ref
Obtains the cached array of MIME_Parts to be attached to this message.

param: string $cacheID  The cacheID of the session object.

getMessageCacheId()   X-Ref
Obtains the cache ID for the session object that contains the
MIME_Part objects to be attached to this message.
This function needs to be run at least once per pageload to save the
session object.

return: string  The message cache ID if the object needs to be saved.

additionalAttachmentsAllowed()   X-Ref
How many more attachments are allowed?

return: mixed  Returns true if no attachment limit.

maxAttachmentSize()   X-Ref
What is the maximum attachment size allowed?

return: integer  The maximum attachment size allowed (in bytes).

attachFilesFromMessage(&$contents)   X-Ref
Adds the attachments to the message (in the case of a forward with
attachments).
This function MUST be called after IMP_Compose::forwardMessage().

param: IMP_Contents &$contents  An IMP_Contents object.
return: array  An array of PEAR_Error object on error.

convertToMultipartRelated($mime_part)   X-Ref
Convert a text/html MIME_Part message with embedded image links to
a multipart/related MIME_Part with the image data embedded in the part.

param: MIME_Part $mime_part  The text/html MIME_Part object.
return: MIME_Part  The modified MIME_Part.

linkAttachments($baseurl, $base_part, $auth)   X-Ref
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.

param: string    $baseurl    The base URL for creating the links.
param: MIME_Part $base_part  The body of the message.
param: string    $auth       The authorized user who owns the attachments.
return: MIME_Part  Modified part with links to attachments. Returns



Généré le : Thu Nov 29 12:30:07 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics