[PHPMailer] element index

Package indexes

All elements
a b c d e f g h i l m p q r s t u v w _
_
top
Method _mime_types
PHPMailer::_mime_types() in class.phpmailer.php
Gets the MIME type of the embedded or inline image
Method __construct
SMTP::__construct() in class.smtp.php
Initialize the class so that the data is in a known state.
Method __construct
POP3::__construct() in class.pop3.php
Constructor, sets the initial values
Method __construct
PHPMailer::__construct() in class.phpmailer.php
Constructor
a
top
Variable $action_function
PHPMailer::$action_function in class.phpmailer.php
Callback Action function name
Variable $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.
Method AddAddress
PHPMailer::AddAddress() in class.phpmailer.php
Adds a "To" address.
Method AddAttachment
PHPMailer::AddAttachment() in class.phpmailer.php
Adds an attachment from a path on the filesystem.
Method AddBCC
PHPMailer::AddBCC() in class.phpmailer.php
Adds a "Bcc" address.
Method AddCC
PHPMailer::AddCC() in class.phpmailer.php
Adds a "Cc" address.
Method AddCustomHeader
PHPMailer::AddCustomHeader() in class.phpmailer.php
Adds a custom header.
Method 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".
Method AddrAppend
PHPMailer::AddrAppend() in class.phpmailer.php
Creates recipient headers.
Method AddReplyTo
PHPMailer::AddReplyTo() in class.phpmailer.php
Adds a "Reply-to" address.
Method AddrFormat
PHPMailer::AddrFormat() in class.phpmailer.php
Formats an address correctly.
Method AddStringAttachment
PHPMailer::AddStringAttachment() in class.phpmailer.php
Adds a string or binary attachment (non-filesystem) to the list.
Method Authenticate
SMTP::Authenticate() in class.smtp.php
Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
Method Authorise
POP3::Authorise() in class.pop3.php
Combination of public events - connect, login, disconnect
b
top
Variable $Body
PHPMailer::$Body in class.phpmailer.php
Sets the Body of the message. This can be either an HTML or text body.
Method Base64EncodeWrapMB
PHPMailer::Base64EncodeWrapMB() in class.phpmailer.php
Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
c
top
Variable $CharSet
PHPMailer::$CharSet in class.phpmailer.php
Sets the CharSet of the message.
Variable $ConfirmReadingTo
PHPMailer::$ConfirmReadingTo in class.phpmailer.php
Sets the email address that a reading confirmation will be sent.
Variable $ContentType
PHPMailer::$ContentType in class.phpmailer.php
Sets the Content-type of the message.
Variable $CRLF
SMTP::$CRLF in class.smtp.php
SMTP reply line ending
Variable $CRLF
POP3::$CRLF in class.pop3.php
POP3 Carriage Return + Line Feed
Method ClearAddresses
PHPMailer::ClearAddresses() in class.phpmailer.php
Clears all recipients assigned in the TO array. Returns void.
Method ClearAllRecipients
PHPMailer::ClearAllRecipients() in class.phpmailer.php
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Method ClearAttachments
PHPMailer::ClearAttachments() in class.phpmailer.php
Clears all previously set filesystem, string, and binary attachments. Returns void.
Method ClearBCCs
PHPMailer::ClearBCCs() in class.phpmailer.php
Clears all recipients assigned in the BCC array. Returns void.
Method ClearCCs
PHPMailer::ClearCCs() in class.phpmailer.php
Clears all recipients assigned in the CC array. Returns void.
Method ClearCustomHeaders
PHPMailer::ClearCustomHeaders() in class.phpmailer.php
Clears all custom headers. Returns void.
Method ClearReplyTos
PHPMailer::ClearReplyTos() in class.phpmailer.php
Clears all recipients assigned in the ReplyTo array. Returns void.
Method Close
SMTP::Close() in class.smtp.php
Closes the socket and cleans up the state of the class.
Method Connect
SMTP::Connect() in class.smtp.php
Connect to the server specified on the port specified.
Method Connect
POP3::Connect() in class.pop3.php
Connect to the POP3 server
Method Connected
SMTP::Connected() in class.smtp.php
Returns true if connected to a server otherwise false
Method CreateBody
PHPMailer::CreateBody() in class.phpmailer.php
Assembles the message body. Returns an empty string on failure.
Method CreateHeader
PHPMailer::CreateHeader() in class.phpmailer.php
Assembles message header.
Page class.phpmailer.php
class.phpmailer.php in class.phpmailer.php
Page class.pop3.php
class.pop3.php in class.pop3.php
Page class.smtp.php
class.smtp.php in class.smtp.php
d
top
Variable $DKIM_domain
PHPMailer::$DKIM_domain in class.phpmailer.php
Used with DKIM DNS Resource Record
Variable $DKIM_identity
PHPMailer::$DKIM_identity in class.phpmailer.php
Used with DKIM DNS Resource Record
Variable $DKIM_private
PHPMailer::$DKIM_private in class.phpmailer.php
Used with DKIM DNS Resource Record
Variable $DKIM_selector
PHPMailer::$DKIM_selector in class.phpmailer.php
Used with DKIM DNS Resource Record
Variable $do_debug
SMTP::$do_debug in class.smtp.php
Sets whether debugging is turned on
Variable $do_debug
POP3::$do_debug in class.pop3.php
Displaying Debug warnings? (0 = now, 1+ = yes)
Variable $do_verp
SMTP::$do_verp in class.smtp.php
Sets VERP use on/off (default is off)
Method Data
SMTP::Data() in class.smtp.php
Issues a data command and sends the msg_data to the server
Method Disconnect
POP3::Disconnect() in class.pop3.php
Disconnect from the POP3 server
Method DKIM_Add
PHPMailer::DKIM_Add() in class.phpmailer.php
Create the DKIM header, body, as new header
Method DKIM_BodyC
PHPMailer::DKIM_BodyC() in class.phpmailer.php
Generate DKIM Canonicalization Body
Method DKIM_HeaderC
PHPMailer::DKIM_HeaderC() in class.phpmailer.php
Generate DKIM Canonicalization Header
Method DKIM_QP
PHPMailer::DKIM_QP() in class.phpmailer.php
Set the private key file and password to sign the message.
Method DKIM_Sign
PHPMailer::DKIM_Sign() in class.phpmailer.php
Generate DKIM signature
Method doCallback
PHPMailer::doCallback() in class.phpmailer.php
e
top
Variable $Encoding
PHPMailer::$Encoding in class.phpmailer.php
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Variable $ErrorInfo
PHPMailer::$ErrorInfo in class.phpmailer.php
Holds the most recent mailer error message.
Method EncodeHeader
PHPMailer::EncodeHeader() in class.phpmailer.php
Encode a header string to best (shortest) of Q, B, quoted or none.
Method EncodeQ
PHPMailer::EncodeQ() in class.phpmailer.php
Encode string to q encoding.
Method EncodeQP
PHPMailer::EncodeQP() in class.phpmailer.php
Encode string to RFC2045 (6.7) quoted-printable format
Method EncodeQPphp
PHPMailer::EncodeQPphp() in class.phpmailer.php
Encode string to quoted-printable.
Method EncodeString
PHPMailer::EncodeString() in class.phpmailer.php
Encodes string to requested format.
Method errorMessage
phpmailerException::errorMessage() in class.phpmailer.php
f
top
Variable $From
PHPMailer::$From in class.phpmailer.php
Sets the From email address for the message.
Variable $FromName
PHPMailer::$FromName in class.phpmailer.php
Sets the From name of the message.
g
top
Method GetAttachments
PHPMailer::GetAttachments() in class.phpmailer.php
Return the current array of attachments
Method getError
SMTP::getError() in class.smtp.php
Get the current error
Method GetMailMIME
PHPMailer::GetMailMIME() in class.phpmailer.php
Returns the message MIME.
Method GetTranslations
PHPMailer::GetTranslations() in class.phpmailer.php
Return the current array of language strings
h
top
Variable $Helo
PHPMailer::$Helo in class.phpmailer.php
Sets the SMTP HELO of the message (Default is $Hostname).
Variable $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").
Variable $host
POP3::$host in class.pop3.php
POP3 Mail Server
Variable $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'.
Method HasMultiBytes
PHPMailer::HasMultiBytes() in class.phpmailer.php
Checks if a string contains multibyte characters.
Method HeaderLine
PHPMailer::HeaderLine() in class.phpmailer.php
Returns a formatted header line.
Method Hello
SMTP::Hello() in class.smtp.php
Sends the HELO command to the smtp server.
i
top
Method InlineImageExists
PHPMailer::InlineImageExists() in class.phpmailer.php
Returns true if an inline attachment is present.
Method IsError
PHPMailer::IsError() in class.phpmailer.php
Returns true if an error occurred.
Method IsHTML
PHPMailer::IsHTML() in class.phpmailer.php
Sets message type to HTML.
Method IsMail
PHPMailer::IsMail() in class.phpmailer.php
Sets Mailer to send message using PHP mail() function.
Method IsQmail
PHPMailer::IsQmail() in class.phpmailer.php
Sets Mailer to send message using the qmail MTA.
Method IsSendmail
PHPMailer::IsSendmail() in class.phpmailer.php
Sets Mailer to send message using the $Sendmail program.
Method IsSMTP
PHPMailer::IsSMTP() in class.phpmailer.php
Sets Mailer to send message using SMTP.
l
top
Variable $language
PHPMailer::$language in class.phpmailer.php
Variable $LE
PHPMailer::$LE in class.phpmailer.php
Provides the ability to change the line ending
Method Login
POP3::Login() in class.pop3.php
Login to the POP3 server (does not support APOP yet)
m
top
Variable $Mailer
PHPMailer::$Mailer in class.phpmailer.php
Method to send mail: ("mail", "sendmail", or "smtp").
Variable $MessageID
PHPMailer::$MessageID in class.phpmailer.php
Sets the message ID to be used in the Message-Id header.
Method 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.
Method MailSend
PHPMailer::MailSend() in class.phpmailer.php
Sends mail using the PHP mail() function.
Method MsgHTML
PHPMailer::MsgHTML() in class.phpmailer.php
Evaluates the message and returns modifications for inline images and backgrounds
p
top
Variable $Password
PHPMailer::$Password in class.phpmailer.php
Sets SMTP password.
Variable $password
POP3::$password in class.pop3.php
POP3 Password
Variable $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.
Variable $POP3_PORT
POP3::$POP3_PORT in class.pop3.php
Default POP3 port
Variable $POP3_TIMEOUT
POP3::$POP3_TIMEOUT in class.pop3.php
Default Timeout
Variable $port
POP3::$port in class.pop3.php
POP3 Port
Variable $Port
PHPMailer::$Port in class.phpmailer.php
Sets the default SMTP server port.
Variable $Priority
PHPMailer::$Priority in class.phpmailer.php
Email priority (1 = High, 3 = Normal, 5 = low).
Class PHPMailer
PHPMailer in class.phpmailer.php
PHPMailer - PHP email transport class
Class phpmailerException
phpmailerException in class.phpmailer.php
Class POP3
POP3 in class.pop3.php
POP Before SMTP Authentication Class Version 5.0.0
q
top
Method 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.
r
top
Method Recipient
SMTP::Recipient() in class.smtp.php
Sends the command RCPT to the SMTP server with the TO: argument of $to.
Method 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.
Method RFCDate
PHPMailer::RFCDate() in class.phpmailer.php
Returns the proper RFC 822 formatted date.
s
top
Variable $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.
Variable $Sendmail
PHPMailer::$Sendmail in class.phpmailer.php
Sets the path of the sendmail program.
Variable $SingleTo
PHPMailer::$SingleTo in class.phpmailer.php
Provides the ability to have the TO field process individual
Variable $SingleToArray
PHPMailer::$SingleToArray in class.phpmailer.php
If SingleTo is true, this provides the array to hold the email addresses
Variable $SMTPAuth
PHPMailer::$SMTPAuth in class.phpmailer.php
Sets SMTP authentication. Utilizes the Username and Password variables.
Variable $SMTPDebug
PHPMailer::$SMTPDebug in class.phpmailer.php
Sets SMTP class debugging on or off.
Variable $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().
Variable $SMTPSecure
PHPMailer::$SMTPSecure in class.phpmailer.php
Sets connection prefix.
Variable $SMTP_PORT
SMTP::$SMTP_PORT in class.smtp.php
SMTP server port
Variable $Subject
PHPMailer::$Subject in class.phpmailer.php
Sets the Subject of the message.
Method SecureHeader
PHPMailer::SecureHeader() in class.phpmailer.php
Strips newlines to prevent header injection.
Method 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.
Method SendAndMail
SMTP::SendAndMail() in class.smtp.php
Starts a mail transaction from the email address specified in
Method SendmailSend
PHPMailer::SendmailSend() in class.phpmailer.php
Sends mail using the $Sendmail program.
Method set
PHPMailer::set() in class.phpmailer.php
Set (or reset) Class Objects (variables)
Method SetError
PHPMailer::SetError() in class.phpmailer.php
Adds the error message to the error container.
Method SetFrom
PHPMailer::SetFrom() in class.phpmailer.php
Set the From and FromName properties
Method SetLanguage
PHPMailer::SetLanguage() in class.phpmailer.php
Sets the language for all class error messages.
Method SetWordWrap
PHPMailer::SetWordWrap() in class.phpmailer.php
Set the body wrapping.
Method Sign
PHPMailer::Sign() in class.phpmailer.php
Set the private key file and password to sign the message.
Class 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.
Method SmtpClose
PHPMailer::SmtpClose() in class.phpmailer.php
Closes the active SMTP session if one exists.
Method SmtpConnect
PHPMailer::SmtpConnect() in class.phpmailer.php
Initiates a connection to an SMTP server.
Method 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.
Method StartTLS
SMTP::StartTLS() in class.smtp.php
Initiate a TLS communication with the server.
Class Constant STOP_CONTINUE
PHPMailer::STOP_CONTINUE in class.phpmailer.php
Class Constant STOP_CRITICAL
PHPMailer::STOP_CRITICAL in class.phpmailer.php
Class Constant STOP_MESSAGE
PHPMailer::STOP_MESSAGE in class.phpmailer.php
t
top
Variable $Timeout
PHPMailer::$Timeout in class.phpmailer.php
Sets the SMTP server timeout in seconds.
Variable $tval
POP3::$tval in class.pop3.php
POP3 Timeout Value
Method TextLine
PHPMailer::TextLine() in class.phpmailer.php
Returns a formatted mail line.
Method 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
u
top
Variable $Username
PHPMailer::$Username in class.phpmailer.php
Sets SMTP username.
Variable $username
POP3::$username in class.pop3.php
POP3 Username
Method UTF8CharBoundary
PHPMailer::UTF8CharBoundary() in class.phpmailer.php
Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
v
top
Variable $Version
PHPMailer::$Version in class.phpmailer.php
Sets the PHPMailer Version number
Method ValidateAddress
PHPMailer::ValidateAddress() in class.phpmailer.php
Check that a string looks roughly like an email address should
w
top
Variable $WordWrap
PHPMailer::$WordWrap in class.phpmailer.php
Sets word wrapping on the body of the message to a given number of characters.
Method WrapText
PHPMailer::WrapText() in class.phpmailer.php
Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
a b c d e f g h i l m p q r s t u v w _