Methods (v5.0.0) |
Type |
Default |
Description |
Set ($name, $value) |
String $name String $value |
|
Method provides ability for user to create own custom pseudo-properties (like X-headers, for example). Example use: $mail->set (' x-msmail-priority ', ' Normal '); |
Addcustomheader ($value) |
String $value |
|
Method provides ability for user to create own custom headers (like x-priority, for example). Example use: $mail->addcustomheader ("X-priority:3"); |
Msghtml ($message) |
|
|
Evaluates the message and returns modifications for inline images and backgrounds. Sets the IsHTML () method to True, initializes altbody () to either a-text version of the message or default text. |
IsMail () |
Boolean |
True |
Sets Mailer to send Message using PHP mail () function. (True, false or blank) |
ISSMTP () |
Boolean |
|
Sets Mailer to send message using SMTP. If set to True, the other options are also available. (True, false or blank) |
Issendmail () |
Boolean |
|
Sets Mailer to send is using the Sendmail program. (True, false or blank) |
Isqmail () |
Boolean |
|
The Sets Mailer to send message using the QMail MTA. (True, false or blank) |
Setfrom ($address, $name = "") |
String $address String $name |
|
Adds a ' from ' address. |
AddAddress ($address, $name = "") |
String $address String $name |
|
Adds a ' to ' address. |
ADDCC ($address, $name = "") |
String $address String $name |
|
Adds a "Cc" address. Note:this function works with the SMTP Mailer in Win32, not with the "mail" Mailer. |
ADDBCC ($address, $name = "") |
String $address String $name |
|
Adds a "Bcc" address. Note:this function works with the SMTP Mailer in Win32, not with the "mail" Mailer. |
Addreplyto ($address, $name = "") |
String $address String $name |
|
Adds a "reply-to" address. |
Send () |
|
|
Creates message and assigns Mailer. The If is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error. Returns true on success and false on failure. |
AddAttachment ($path, $name = "", $encoding = "base64", $type = "Application/octet-stream") |
String $path String $name String $encoding String $type |
|
Adds a attachment from path on the filesystem. Returns False if the file could not is found or accessed. |
Addembeddedimage ($path, $cid, $name = "", $encoding = "base64", $type = "Application/octet-stream") |
String $path String $cid String $name String $encoding String $type |
|
Adds an embedded attachment. This can include images, sounds, and just on any other document. Make sure to set the $type to a image type. For the JPEG images use "image/gif" with "Image/jpeg" and for GIF images. If You use the msghtml () method, there is no need to use Addembeddedimage () method. |
Clearaddresses () |
|
|
Clears all recipients assigned in the to array. Returns void. |
Clearccs () |
|
|
Clears all recipients assigned in the CC array. Returns void. |
Clearbccs () |
|
|
Clears all recipients assigned in the BCC array. Returns void. |
Clearreplytos () |
|
|
Clears all recipients assigned in the ReplyTo array. Returns void. |
Clearallrecipients () |
|
|
Clears all recipients assigned in the To, CC and BCC array. Returns void. |
Clearattachments () |
|
|
Clears all previously set filesystem, string, and binary attachments. Returns void. |
Clearcustomheaders () |
|
|
Clears all custom headers. Returns void. |