| Type | Description | ||
|---|---|---|---|
| AddAttachment( $path, $name = "", $encoding = "base64", $type = "" ) |
string $path string $name string $encoding string $type |
Adds an attachment from a path on the filesystem. Returns false if the file could not be found or accessed. | |
| AddBCC($address, $name = "") | string $address string $name |
Adds a "Bcc" address. | |
| AddCC($address, $name = "") | string $address string $name |
Adds a "Cc" address. | |
| 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"); |
|
| AddEmbeddedImage( $path, $cid, $name = "", $encoding = "base64", $type = "" ) |
string $path string $cid string $name string $encoding string $type |
Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif". If you use the MessageHTML property, there is no need to use AddEmbeddedImage() method. | |
| AddRecipient($address, $name = "") | string $address string $name |
Adds a "To" address. | |
| AddReplyTo($address, $name = "") | string $address string $name |
Adds a "Reply-to" address. | |
| ClearAddresses() | Clears all recipients assigned in the TO 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. | ||
| ClearBCCs() | Clears all recipients assigned in the BCC array. Returns void. | ||
| ClearCCs() | Clears all recipients assigned in the CC array. Returns void. | ||
| ClearCustomHeaders() | Clears all custom headers. Returns void. | ||
| ClearReplyTos() | Clears all recipients assigned in the ReplyTo array. Returns void. | ||
| IsSMTP() deprecated | boolean | Sets PHPMailer Pro to send message using SMTP. If set to true, other options are also available. (true, false or blank) | |
| MessageHTML = $message | Evaluates the message and returns modifications for inline images and backgrounds. Sets the SetTypeHTML() method to true, initializes MessageText() to either a text version of the message or default text. | ||
| Send() | Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error. Returns true on success, false on failure. | ||
| 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'); |
|
| SetSender( array($address => $name = "") ) |
string $address string $name |
Adds a "From" address. | |
| SetSMTPAccount( array($username => $password) ) |
Sets the SMTP Username and Password | ||
| SetSMTPEncryption( array($socket_protocol => $port) ) |
Sets the SMTP Protocol and Port |