Mail_Mime::Mail_Mime() (Previous) (Next) Mail_Mime::addHTMLImage()
View this page in Last updated: Sun, 07 Sep 2008
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

Mail_Mime::addAttachment()

Mail_Mime::addAttachment() -- add attachment

Synopsis

require_once 'Mail/mime.php';

boolean addAttachment (string $file, string [$c_type = 'application/octet-stream'], string [$name = ''], boolean [$isfile = TRUE], string [$encoding = 'base64'])

Description

Adds an attachment to a message.

Parameter

  • string $file - The file name or the data itself

  • string $c_type - The content type of the image or file.

  • string $name - The suggested file name for the data. Only used, if $file contains data.

  • boolean $isfile - Whether $file is a file name or not.

  • string $encoding - Type of transfer encoding to use for the file data. Defaults is "base64". For text based files (eg. scripts/html etc.) this could be given as "quoted-printable".

Return value

boolean - Returns TRUE on success, PEAR_Error on failure.

Throws

Table 52-1. Possible PEAR_Error values

Error codeError messageReasonSolution
NULL "File is not readable file_name" The file was not found or the script has not enough rights to access the file. Check the file name and path. Check user and file permissions.
NULL "Could not open file_name" The file is already opened and exclusivly locked by another application. In the most cases a program opens the file for writing. addAttachment() does no file locking, so this problem is not caused by competitive callings of this function.

Note

This function can not be called statically.

Mail_Mime::Mail_Mime() (Previous) (Next) Mail_Mime::addHTMLImage()
Download Documentation Last updated: Sun, 07 Sep 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.