[PHPMailer] element index

$AltBody

PHPMailer::$AltBody in class.phpmailer.php

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.

$attachment

PHPMailer::$attachment in class.phpmailer.php

AddAddress

PHPMailer::AddAddress() in class.phpmailer.php

Adds a "To" address.

AddAttachment

PHPMailer::AddAttachment() in class.phpmailer.php

Adds an attachment from a path on the filesystem.

AddBCC

PHPMailer::AddBCC() in class.phpmailer.php

Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

AddCC

PHPMailer::AddCC() in class.phpmailer.php

Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

AddCustomHeader

PHPMailer::AddCustomHeader() in class.phpmailer.php

Adds a custom header.

AddEmbeddedImage

PHPMailer::AddEmbeddedImage() in class.phpmailer.php

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".

AddReplyTo

PHPMailer::AddReplyTo() in class.phpmailer.php

Adds a "Reply-To" address.

AddStringAttachment

PHPMailer::AddStringAttachment() in class.phpmailer.php

Adds a string or binary attachment (non-filesystem) to the list.

Authenticate

SMTP::Authenticate() in class.smtp.php

Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.

Authorise

POP3::Authorise() in class.pop3.php

Combination of public events - connect, login, disconnect

$bcc

PHPMailer::$bcc in class.phpmailer.php

$Body

PHPMailer::$Body in class.phpmailer.php

Sets the Body of the message. This can be either an HTML or text body.

$boundary

PHPMailer::$boundary in class.phpmailer.php

$cc

PHPMailer::$cc in class.phpmailer.php

$CharSet

PHPMailer::$CharSet in class.phpmailer.php

Sets the CharSet of the message.

$ConfirmReadingTo

PHPMailer::$ConfirmReadingTo in class.phpmailer.php

Sets the email address that a reading confirmation will be sent.

$ContentType

PHPMailer::$ContentType in class.phpmailer.php

Sets the Content-type of the message.

$CRLF

SMTP::$CRLF in class.smtp.php

SMTP reply line ending

$CRLF

POP3::$CRLF in class.pop3.php

POP3 Carriage Return + Line Feed

$CustomHeader

PHPMailer::$CustomHeader in class.phpmailer.php

catchWarning

POP3::catchWarning() in class.pop3.php

Takes over from PHP for the socket warning handler

checkResponse

POP3::checkResponse() in class.pop3.php

Checks the POP3 server response for +OK or -ERR

ClearAddresses

PHPMailer::ClearAddresses() in class.phpmailer.php

Clears all recipients assigned in the TO array. Returns void.

ClearAllRecipients

PHPMailer::ClearAllRecipients() in class.phpmailer.php

Clears all recipients assigned in the TO, CC and BCC array. Returns void.

ClearAttachments

PHPMailer::ClearAttachments() in class.phpmailer.php

Clears all previously set filesystem, string, and binary attachments. Returns void.

ClearBCCs

PHPMailer::ClearBCCs() in class.phpmailer.php

Clears all recipients assigned in the BCC array. Returns void.

ClearCCs

PHPMailer::ClearCCs() in class.phpmailer.php

Clears all recipients assigned in the CC array. Returns void.

ClearCustomHeaders

PHPMailer::ClearCustomHeaders() in class.phpmailer.php

Clears all custom headers. Returns void.

ClearReplyTos

PHPMailer::ClearReplyTos() in class.phpmailer.php

Clears all recipients assigned in the ReplyTo array. Returns void.

Close

SMTP::Close() in class.smtp.php

Closes the socket and cleans up the state of the class.

Connect

SMTP::Connect() in class.smtp.php

Connect to the server specified on the port specified.

Connect

POP3::Connect() in class.pop3.php

Connect to the POP3 server

class.phpmailer.php

class.phpmailer.php in class.phpmailer.php

class.pop3.php

class.pop3.php in class.pop3.php

class.smtp.php

class.smtp.php in class.smtp.php

$do_debug

SMTP::$do_debug in class.smtp.php

Sets whether debugging is turned on

$do_debug

POP3::$do_debug in class.pop3.php

Displaying Debug warnings? (0 = now, 1+ = yes)

$do_verp

SMTP::$do_verp in class.smtp.php

Sets VERP use on/off (default is off)

Data

SMTP::Data() in class.smtp.php

Issues a data command and sends the msg_data to the server

Disconnect

POP3::Disconnect() in class.pop3.php

Disconnect from the POP3 server

displayErrors

POP3::displayErrors() in class.pop3.php

If debug is enabled, display the error message array

$Encoding

PHPMailer::$Encoding in class.phpmailer.php

Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".

$ErrorInfo

PHPMailer::$ErrorInfo in class.phpmailer.php

Holds the most recent mailer error message.

$error_count

PHPMailer::$error_count in class.phpmailer.php

Expand

SMTP::Expand() in class.smtp.php

Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.

$From

PHPMailer::$From in class.phpmailer.php

Sets the From email address for the message.

$FromName

PHPMailer::$FromName in class.phpmailer.php

Sets the From name of the message.

getFile

PHPMailer::getFile() in class.phpmailer.php

Read a file from a supplied filename and return it.

getResponse

POP3::getResponse() in class.pop3.php

Get the socket response back.

$Helo

PHPMailer::$Helo in class.phpmailer.php

Sets the SMTP HELO of the message (Default is $Hostname).

$Host

PHPMailer::$Host in class.phpmailer.php

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").

$host

POP3::$host in class.pop3.php

POP3 Mail Server

$Hostname

PHPMailer::$Hostname in class.phpmailer.php

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'.

HeaderLine

PHPMailer::HeaderLine() in class.phpmailer.php

Hello

SMTP::Hello() in class.smtp.php

Sends the HELO command to the smtp server.

Help

SMTP::Help() in class.smtp.php

Gets help information on the keyword specified. If the keyword

IsError

PHPMailer::IsError() in class.phpmailer.php

Returns true if an error occurred.

IsHTML

PHPMailer::IsHTML() in class.phpmailer.php

Sets message type to HTML.

IsMail

PHPMailer::IsMail() in class.phpmailer.php

Sets Mailer to send message using PHP mail() function.

IsQmail

PHPMailer::IsQmail() in class.phpmailer.php

Sets Mailer to send message using the qmail MTA.

IsSendmail

PHPMailer::IsSendmail() in class.phpmailer.php

Sets Mailer to send message using the $Sendmail program.

IsSMTP

PHPMailer::IsSMTP() in class.phpmailer.php

Sets Mailer to send message using SMTP.

$language

PHPMailer::$language in class.phpmailer.php

$LE

PHPMailer::$LE in class.phpmailer.php

Login

POP3::Login() in class.pop3.php

Login to the POP3 server (does not support APOP yet)

$Mailer

PHPMailer::$Mailer in class.phpmailer.php

Method to send mail: ("mail", "sendmail", or "smtp").

$MessageID

PHPMailer::$MessageID in class.phpmailer.php

Sets the message ID to be used in the Message-Id header.

$message_type

PHPMailer::$message_type in class.phpmailer.php

Mail

SMTP::Mail() in class.smtp.php

Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.

MsgHTML

PHPMailer::MsgHTML() in class.phpmailer.php

Evaluates the message and returns modifications for inline images and backgrounds

Noop

SMTP::Noop() in class.smtp.php

Sends the command NOOP to the SMTP server.

$Password

PHPMailer::$Password in class.phpmailer.php

Sets SMTP password.

$password

POP3::$password in class.pop3.php

POP3 Password

$PluginDir

PHPMailer::$PluginDir in class.phpmailer.php

Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.

$POP3_PORT

POP3::$POP3_PORT in class.pop3.php

Default POP3 port

$POP3_TIMEOUT

POP3::$POP3_TIMEOUT in class.pop3.php

Default Timeout

$Port

PHPMailer::$Port in class.phpmailer.php

Sets the default SMTP server port.

$port

POP3::$port in class.pop3.php

POP3 Port

$Priority

PHPMailer::$Priority in class.phpmailer.php

Email priority (1 = High, 3 = Normal, 5 = low).

PHPMailer

PHPMailer in class.phpmailer.php

POP3

POP3::POP3() in class.pop3.php

Constructor, sets the initial values

POP3

POP3 in class.pop3.php

Quit

SMTP::Quit() in class.smtp.php

Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.

$ReplyTo

PHPMailer::$ReplyTo in class.phpmailer.php

Recipient

SMTP::Recipient() in class.smtp.php

Sends the command RCPT to the SMTP server with the TO: argument of $to.

Reset

SMTP::Reset() in class.smtp.php

Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.

$Sender

PHPMailer::$Sender in class.phpmailer.php

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.

$Sendmail

PHPMailer::$Sendmail in class.phpmailer.php

Sets the path of the sendmail program.

$sign_cert_file

PHPMailer::$sign_cert_file in class.phpmailer.php

$sign_key_file

PHPMailer::$sign_key_file in class.phpmailer.php

$sign_key_pass

PHPMailer::$sign_key_pass in class.phpmailer.php

$SingleTo

PHPMailer::$SingleTo in class.phpmailer.php

Provides the ability to have the TO field process individual

$smtp

PHPMailer::$smtp in class.phpmailer.php

$SMTPAuth

PHPMailer::$SMTPAuth in class.phpmailer.php

Sets SMTP authentication. Utilizes the Username and Password variables.

$SMTPDebug

PHPMailer::$SMTPDebug in class.phpmailer.php

Sets SMTP class debugging on or off.

$SMTPKeepAlive

PHPMailer::$SMTPKeepAlive in class.phpmailer.php

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().

$SMTPSecure

PHPMailer::$SMTPSecure in class.phpmailer.php

Sets connection prefix.

$SMTP_PORT

SMTP::$SMTP_PORT in class.smtp.php

SMTP server port

$Subject

PHPMailer::$Subject in class.phpmailer.php

Sets the Subject of the message.

Send

SMTP::Send() in class.smtp.php

Starts a mail transaction from the email address specified in

Send

PHPMailer::Send() in class.phpmailer.php

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.

SendAndMail

SMTP::SendAndMail() in class.smtp.php

Starts a mail transaction from the email address specified in

SendOrMail

SMTP::SendOrMail() in class.smtp.php

Starts a mail transaction from the email address specified in

sendString

POP3::sendString() in class.pop3.php

Send a string down the open socket connection to the POP3 server

set

PHPMailer::set() in class.phpmailer.php

Set (or reset) Class Objects (variables)

SetLanguage

PHPMailer::SetLanguage() in class.phpmailer.php

Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.

Sign

PHPMailer::Sign() in class.phpmailer.php

Set the private key file and password to sign the message.

SMTP

SMTP in class.smtp.php

SMTP

SMTP::SMTP() in class.smtp.php

Initialize the class so that the data is in a known state.

SmtpClose

PHPMailer::SmtpClose() in class.phpmailer.php

Closes the active SMTP session if one exists.

$Timeout

PHPMailer::$Timeout in class.phpmailer.php

Sets the SMTP server timeout in seconds. This function will not work with the win32 version.

$to

PHPMailer::$to in class.phpmailer.php

$tval

POP3::$tval in class.pop3.php

POP3 Timeout Value

Turn

SMTP::Turn() in class.smtp.php

This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future

$username

POP3::$username in class.pop3.php

POP3 Username

$Username

PHPMailer::$Username in class.phpmailer.php

Sets SMTP username.

$Version

PHPMailer::$Version in class.phpmailer.php

Holds PHPMailer version.

Verify

SMTP::Verify() in class.smtp.php

Verifies that the name is recognized by the server.

$WordWrap

PHPMailer::$WordWrap in class.phpmailer.php

Sets word wrapping on the body of the message to a given number of characters.