Class PHPMailer
PHPMailer - PHP email transport class
NOTE: Requires PHP version 5 or later
Located in /class.phpmailer.php (line 43)
Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.
Sets the Body of the message. This can be either an HTML or text body.
If HTML then run IsHTML(true).
Sets the CharSet of the message.
Sets the email address that a reading confirmation will be sent.
Sets the Content-type of the message.
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Holds the most recent mailer error message.
Sets the From email address for the message.
Sets the From name of the message.
Sets the SMTP HELO of the message (Default is $Hostname).
Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com").
Hosts will be tried in order.
Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.
Provides the ability to change the line ending
Method to send mail: ("mail", "sendmail", or "smtp").
Sets the message ID to be used in the Message-Id header.
If empty, a unique id will be generated.
Sets SMTP password.
Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
Sets the default SMTP server port.
Email priority (1 = High, 3 = Normal, 5 = low).
Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
Sets the path of the sendmail program.
Provides the ability to have the TO field process individual
emails, instead of sending to entire TO addresses
Sets SMTP authentication. Utilizes the Username and Password variables.
Sets SMTP class debugging on or off.
Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().
Sets the Subject of the message.
Sets the SMTP server timeout in seconds.
This function will not work with the win32 version.
Sets SMTP username.
Sets word wrapping on the body of the message to a given number of characters.
Constructor
- boolean $exceptions: Should we throw external exceptions?
Adds a "To" address.
- string $address
- string $name
Adds an attachment from a path on the filesystem.
Returns false if the file could not be found or accessed.
- string $path: Path to the attachment.
- string $name: Overrides the attachment name.
- string $encoding: File encoding (see $Encoding).
- string $type: File extension (MIME) type.
Adds a "Bcc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
- string $address
- string $name
Adds a "Cc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
- string $address
- string $name
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".
- string $path: Path to the attachment.
- string $cid: Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
- string $name: Overrides the attachment name.
- string $encoding: File encoding (see $Encoding).
- string $type: File extension (MIME) type.
Adds a "Reply-to" address.
- string $address
- string $name
Adds a string or binary attachment (non-filesystem) to the list.
This method can be used to attach ascii or binary data, such as a BLOB record from a database.
- string $string: String attachment data.
- string $filename: Name of the attachment.
- string $encoding: File encoding (see $Encoding).
- string $type: File extension (MIME) type.
Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
- string $str: multi-byte text to wrap encode
Clears all recipients assigned in the TO array. Returns void.
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Clears all previously set filesystem, string, and binary attachments. Returns void.
Clears all recipients assigned in the BCC array. Returns void.
Clears all recipients assigned in the ReplyTo array. Returns void.
Assembles the message body. Returns an empty string on failure.
Encode a header string to best (shortest) of Q, B, quoted or none.
Encode string to q encoding.
- string $str: the text to encode
- string $position: Where the text is going to be used, see the RFC for what that means
Encode string to RFC2045 (6.7) quoted-printable format
Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding
- string $string: the text to encode
- integer $line_max: Number of chars allowed on a line before wrapping
- boolean $space_conv: Dummy param for compatibility with existing EncodeQP function
Encode string to quoted-printable.
Only uses standard PHP, slow, but will always work
- string $string: the text to encode
- integer $line_max: Number of chars allowed on a line before wrapping
Encodes string to requested format.
Returns an empty string on failure.
- string $str: The text to encode
- string $encoding: The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
Checks if a string contains multibyte characters.
- string $str: multi-byte text to wrap encode
Returns a formatted header line.
Returns true if an inline attachment is present.
Sends mail using the PHP mail() function.
- string $header: The message headers
- string $body: The message body
Evaluates the message and returns modifications for inline images and backgrounds
Strips newlines to prevent header injection.
- string $str: String
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.
Sends mail using the $Sendmail program.
- string $header: The message headers
- string $body: The message body
Set (or reset) Class Objects (variables)
Usage Example: $page->set('X-Priority', '3');
- string $name: Parameter Name
- mixed $value: Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset
Set the From and FromName properties
- string $address
- string $name
Sets the language for all class error messages.
Returns false if it cannot load the language file. The default language is English.
- string $langcode: ISO 639-1 2-character language code (e.g. Portuguese: "br")
- string $lang_path: Path to the language file directory
Set the private key file and password to sign the message.
- string $key_filename: Parameter File Name
- string $key_pass: Password for private key
Initiates a connection to an SMTP server.
Returns false if the operation failed.
Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
- string $header: The message headers
- string $body: The message body
Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
Original written by Colin Brown.
- string $encodedText: utf-8 QP text
- int $maxLength: find last character boundary prior to this length
Check that a string looks roughly like an email address should
Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822
- string $address: The email address to check
Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
Original written by philippe.
- string $message: The message to wrap
- integer $length: The line length to wrap to
- boolean $qp_mode: Whether to run in Quoted-Printable mode
Gets the MIME type of the embedded or inline image
- string $ext: File extension
Documentation generated on Thu, 02 Apr 2009 17:51:25 -0400 by phpDocumentor 1.3.0RC3