[PHPMailer] element index

_mime_types

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

Gets the MIME type of the embedded or inline image

__construct

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

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

__construct

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

Constructor, sets the initial values

__construct

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

Constructor

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

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.

AddCC

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

Adds a "Cc" address.

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

AddrAppend

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

Creates recipient headers.

AddReplyTo

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

Adds a "Reply-to" address.

AddrFormat

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

Formats an address correctly.

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

$Body

PHPMailer::$Body in class.phpmailer.php

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

Base64EncodeWrapMB

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

Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.

$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

POP3::$CRLF in class.pop3.php

POP3 Carriage Return + Line Feed

$CRLF

SMTP::$CRLF in class.smtp.php

SMTP reply line ending

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

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

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

Connect to the POP3 server

Connect

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

Connect to the server specified on the port specified.

Connected

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

Returns true if connected to a server otherwise false

CreateBody

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

Assembles the message body. Returns an empty string on failure.

CreateHeader

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

Assembles message header.

$do_debug

POP3::$do_debug in class.pop3.php

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

$do_debug

SMTP::$do_debug in class.smtp.php

Sets whether debugging is turned on

$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

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

EncodeHeader

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

Encode a header string to best (shortest) of Q, B, quoted or none.

EncodeQ

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

Encode string to q encoding.

EncodeQP

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

Encode string to RFC2045 (6.7) quoted-printable format

EncodeQPphp

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

Encode string to quoted-printable.

EncodeString

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

Encodes string to requested format.

errorMessage

phpmailerException::errorMessage() in class.phpmailer.php

VERSION

PHPMailer::VERSION in class.phpmailer.php

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

GetAttachments

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

Return the current array of attachments

getError

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

Get the current error

GetMailMIME

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

Returns the message MIME.

GetTranslations

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

Return the current array of language strings

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

HasMultiBytes

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

Checks if a string contains multibyte characters.

HeaderLine

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

Returns a formatted header line.

Hello

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

Sends the HELO command to the smtp server.

InlineImageExists

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

Returns true if an inline attachment is present.

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

Provides the ability to change the line ending

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.

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.

MailSend

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

Sends mail using the PHP mail() function.

MsgHTML

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

Evaluates the message and returns modifications for inline images and backgrounds

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

POP3::$port in class.pop3.php

POP3 Port

$Port

PHPMailer::$Port in class.phpmailer.php

Sets the default SMTP server port.

$Priority

PHPMailer::$Priority in class.phpmailer.php

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

PHPMailer

PHPMailer in class.phpmailer.php

PHPMailer - PHP email transport class

phpmailerException

phpmailerException in class.phpmailer.php

POP3

POP3 in class.pop3.php

POP Before SMTP Authentication Class Version 5.0.0

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.

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.

RFCDate

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

Returns the proper RFC 822 formatted date.

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

$SingleTo

PHPMailer::$SingleTo in class.phpmailer.php

Provides the ability to have the TO field process individual

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

SecureHeader

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

Strips newlines to prevent header injection.

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

SendmailSend

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

Sends mail using the $Sendmail program.

set

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

Set (or reset) Class Objects (variables)

SetError

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

Adds the error message to the error container.

SetFrom

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

Set the From and FromName properties

SetLanguage

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

Sets the language for all class error messages.

SetWordWrap

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

Set the body wrapping.

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 is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.

SmtpClose

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

Closes the active SMTP session if one exists.

SmtpConnect

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

Initiates a connection to an SMTP server.

SmtpSend

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

Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.

StartTLS

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

Initiate a TLS communication with the server.

$Timeout

PHPMailer::$Timeout in class.phpmailer.php

Sets the SMTP server timeout in seconds.

$tval

POP3::$tval in class.pop3.php

POP3 Timeout Value

STOP_CONTINUE

PHPMailer::STOP_CONTINUE in class.phpmailer.php

STOP_CRITICAL

PHPMailer::STOP_CRITICAL in class.phpmailer.php

STOP_MESSAGE

PHPMailer::STOP_MESSAGE in class.phpmailer.php

TextLine

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

Returns a formatted mail line.

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

PHPMailer::$Username in class.phpmailer.php

Sets SMTP username.

$username

POP3::$username in class.pop3.php

POP3 Username

UTF8CharBoundary

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

Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.

ValidateAddress

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

Check that a string looks roughly like an email address should

$WordWrap

PHPMailer::$WordWrap in class.phpmailer.php

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

WrapText

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

Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.