[PHPMailer] element index

Package indexes

All elements
a b c d e f g h i l m n p q r s t u v w x _
_
top
Method _mime_types
PHPMailer::_mime_types() in phpmailer.php
Gets the MIME type of the embedded or inline image
Method __construct
SMTP::__construct() in smtp.php
Initialize the class so that the data is in a known state.
Method __construct
POP3::__construct() in pop3.php
Constructor, sets the initial values
Method __construct
PHPMailer::__construct() in phpmailer.php
Constructor
Method __destruct
PHPMailer::__destruct() in phpmailer.php
Destructor
a
top
Variable $action_function
PHPMailer::$action_function in phpmailer.php
Callback Action function name.
Variable $AllowEmpty
PHPMailer::$AllowEmpty in phpmailer.php
Should we allow sending messages with empty body?
Variable $all_recipients
PHPMailer::$all_recipients in phpmailer.php
Variable $AltBody
PHPMailer::$AltBody in phpmailer.php
The plain-text message body.
Variable $attachment
PHPMailer::$attachment in phpmailer.php
Variable $AuthType
PHPMailer::$AuthType in phpmailer.php
Sets SMTP auth type. Options are LOGIN | PLAIN | NTLM | CRAM-MD5 (default LOGIN)
Method AddAddress
PHPMailer::AddAddress() in phpmailer.php
Adds a "To" address.
Method AddAnAddress
PHPMailer::AddAnAddress() in phpmailer.php
Adds an address to one of the recipient arrays
Method AddAttachment
PHPMailer::AddAttachment() in phpmailer.php
Adds an attachment from a path on the filesystem.
Method AddBCC
PHPMailer::AddBCC() in phpmailer.php
Adds a "Bcc" address.
Method AddCC
PHPMailer::AddCC() in phpmailer.php
Adds a "Cc" address.
Method AddCustomHeader
PHPMailer::AddCustomHeader() in phpmailer.php
Adds a custom header. $name value can be overloaded to contain
Method AddEmbeddedImage
PHPMailer::AddEmbeddedImage() in phpmailer.php
Add an embedded attachment from a file.
Method AddrAppend
PHPMailer::AddrAppend() in phpmailer.php
Creates recipient headers.
Method AddReplyTo
PHPMailer::AddReplyTo() in phpmailer.php
Adds a "Reply-to" address.
Method AddrFormat
PHPMailer::AddrFormat() in phpmailer.php
Formats an address correctly.
Method AddStringAttachment
PHPMailer::AddStringAttachment() in phpmailer.php
Adds a string or binary attachment (non-filesystem) to the list.
Method AddStringEmbeddedImage
PHPMailer::AddStringEmbeddedImage() in phpmailer.php
Add an embedded stringified attachment.
Method AlternativeExists
PHPMailer::AlternativeExists() in phpmailer.php
Does this message have an alternative body set?
Method AttachAll
PHPMailer::AttachAll() in phpmailer.php
Attaches all fs, string, and binary attachments to the message.
Method AttachmentExists
PHPMailer::AttachmentExists() in phpmailer.php
Returns true if an attachment (non-inline) is present.
Method Authenticate
SMTP::Authenticate() in smtp.php
Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
Method Authorise
POP3::Authorise() in pop3.php
Combination of public events - connect, login, disconnect
b
top
Variable $bcc
PHPMailer::$bcc in phpmailer.php
Variable $Body
PHPMailer::$Body in phpmailer.php
An HTML or plain text message body.
Variable $boundary
PHPMailer::$boundary in phpmailer.php
Method Base64EncodeWrapMB
PHPMailer::Base64EncodeWrapMB() in phpmailer.php
Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
c
top
Variable $cc
PHPMailer::$cc in phpmailer.php
Variable $CharSet
PHPMailer::$CharSet in phpmailer.php
Sets the CharSet of the message.
Variable $ConfirmReadingTo
PHPMailer::$ConfirmReadingTo in phpmailer.php
Sets the email address that a reading confirmation will be sent.
Variable $ContentType
PHPMailer::$ContentType in phpmailer.php
Sets the Content-type of the message.
Variable $CRLF
SMTP::$CRLF in smtp.php
SMTP reply line ending (don't change)
Variable $CRLF
POP3::$CRLF in pop3.php
POP3 Carriage Return + Line Feed
Variable $CustomHeader
PHPMailer::$CustomHeader in phpmailer.php
Method ClearAddresses
PHPMailer::ClearAddresses() in phpmailer.php
Clears all recipients assigned in the TO array. Returns void.
Method ClearAllRecipients
PHPMailer::ClearAllRecipients() in phpmailer.php
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Method ClearAttachments
PHPMailer::ClearAttachments() in phpmailer.php
Clears all previously set filesystem, string, and binary attachments. Returns void.
Method ClearBCCs
PHPMailer::ClearBCCs() in phpmailer.php
Clears all recipients assigned in the BCC array. Returns void.
Method ClearCCs
PHPMailer::ClearCCs() in phpmailer.php
Clears all recipients assigned in the CC array. Returns void.
Method ClearCustomHeaders
PHPMailer::ClearCustomHeaders() in phpmailer.php
Clears all custom headers. Returns void.
Method ClearReplyTos
PHPMailer::ClearReplyTos() in phpmailer.php
Clears all recipients assigned in the ReplyTo array. Returns void.
Method client_send
SMTP::client_send() in smtp.php
Sends data to the server
Method Close
SMTP::Close() in smtp.php
Closes the socket and cleans up the state of the class.
Method Connect
POP3::Connect() in pop3.php
Connect to the POP3 server
Method Connect
SMTP::Connect() in smtp.php
Connect to an SMTP server
Method Connected
SMTP::Connected() in smtp.php
Returns true if connected to a server otherwise false
Method CreateBody
PHPMailer::CreateBody() in phpmailer.php
Assembles the message body. Returns an empty string on failure.
Method CreateHeader
PHPMailer::CreateHeader() in phpmailer.php
Assembles message header.
Class Constant CRLF
PHPMailer::CRLF in phpmailer.php
d
top
Variable $Debugoutput
PHPMailer::$Debugoutput in phpmailer.php
Sets the function/method to use for debugging output.
Variable $Debugoutput
SMTP::$Debugoutput in smtp.php
Sets the function/method to use for debugging output.
Variable $DKIM_domain
PHPMailer::$DKIM_domain in phpmailer.php
Used with DKIM Singing
Variable $DKIM_identity
PHPMailer::$DKIM_identity in phpmailer.php
Used with DKIM Signing
Variable $DKIM_passphrase
PHPMailer::$DKIM_passphrase in phpmailer.php
Used with DKIM Signing
Variable $DKIM_private
PHPMailer::$DKIM_private in phpmailer.php
Used with DKIM Signing
Variable $DKIM_selector
PHPMailer::$DKIM_selector in phpmailer.php
Used with DKIM Signing required parameter if DKIM is enabled
Variable $do_debug
POP3::$do_debug in pop3.php
Displaying Debug warnings? (0 = now, 1+ = yes)
Variable $do_debug
SMTP::$do_debug in smtp.php
Debug output level; 0 for no output
Variable $do_verp
SMTP::$do_verp in smtp.php
Sets VERP use on/off (default is off)
Variable $do_verp
PHPMailer::$do_verp in phpmailer.php
Should we generate VERP addresses when sending via SMTP?
Method Data
SMTP::Data() in smtp.php
Issues a data command and sends the msg_data to the server
Method Disconnect
POP3::Disconnect() in pop3.php
Disconnect from the POP3 server
Method DKIM_Add
PHPMailer::DKIM_Add() in phpmailer.php
Create the DKIM header, body, as new header
Method DKIM_BodyC
PHPMailer::DKIM_BodyC() in phpmailer.php
Generate DKIM Canonicalization Body
Method DKIM_HeaderC
PHPMailer::DKIM_HeaderC() in phpmailer.php
Generate DKIM Canonicalization Header
Method DKIM_QP
PHPMailer::DKIM_QP() in phpmailer.php
Set the private key file and password to sign the message.
Method DKIM_Sign
PHPMailer::DKIM_Sign() in phpmailer.php
Generate DKIM signature
Method doCallback
PHPMailer::doCallback() in phpmailer.php
Perform callback
e
top
Variable $Encoding
PHPMailer::$Encoding in phpmailer.php
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Variable $error
SMTP::$error in smtp.php
Variable $ErrorInfo
PHPMailer::$ErrorInfo in phpmailer.php
Holds the most recent mailer error message.
Variable $error_count
PHPMailer::$error_count in phpmailer.php
Variable $exceptions
PHPMailer::$exceptions in phpmailer.php
Method edebug
SMTP::edebug() in smtp.php
Outputs debugging info via user-defined method
Method edebug
PHPMailer::edebug() in phpmailer.php
Outputs debugging info via user-defined method
Method EncodeFile
PHPMailer::EncodeFile() in phpmailer.php
Encodes attachment in requested format.
Method EncodeHeader
PHPMailer::EncodeHeader() in phpmailer.php
Encode a header string to best (shortest) of Q, B, quoted or none.
Method EncodeQ
PHPMailer::EncodeQ() in phpmailer.php
Encode string to q encoding.
Method EncodeQP
PHPMailer::EncodeQP() in phpmailer.php
Encode string to RFC2045 (6.7) quoted-printable format
Method EncodeQPphp
PHPMailer::EncodeQPphp() in phpmailer.php
Wrapper to preserve BC for old QP encoding function that was removed
Method EncodeString
PHPMailer::EncodeString() in phpmailer.php
Encodes string to requested format.
Method EndBoundary
PHPMailer::EndBoundary() in phpmailer.php
Returns the end of a message boundary.
Method errorMessage
phpmailerException::errorMessage() in phpmailer.php
Prettify error message output
f
top
Variable $From
PHPMailer::$From in phpmailer.php
Sets the From email address for the message.
Variable $FromName
PHPMailer::$FromName in phpmailer.php
Sets the From name of the message.
Method filenameToType
PHPMailer::filenameToType() in phpmailer.php
Try to map a file name to a MIME type, default to application/octet-stream
Method FixEOL
PHPMailer::FixEOL() in phpmailer.php
Changes every end of line from CRLF, CR or LF to $this->LE.
g
top
Method GetAttachments
PHPMailer::GetAttachments() in phpmailer.php
Return the current array of attachments
Method GetBoundary
PHPMailer::GetBoundary() in phpmailer.php
Returns the start of a message boundary.
Method getError
SMTP::getError() in smtp.php
Get the current error
Method GetMailMIME
PHPMailer::GetMailMIME() in phpmailer.php
Returns the message MIME.
Method GetSentMIMEMessage
PHPMailer::GetSentMIMEMessage() in phpmailer.php
Returns the MIME message (headers and body). Only really valid post PreSend().
Method GetTranslations
PHPMailer::GetTranslations() in phpmailer.php
Return the current array of language strings
Method get_lines
SMTP::get_lines() in smtp.php
Read in as many lines as possible either before eof or socket timeout occurs on the operation.
h
top
Variable $Helo
PHPMailer::$Helo in phpmailer.php
Sets the SMTP HELO of the message (Default is $Hostname).
Variable $helo_rply
SMTP::$helo_rply in smtp.php
Variable $Host
PHPMailer::$Host in phpmailer.php
Sets the SMTP hosts.
Variable $host
POP3::$host in pop3.php
POP3 Mail Server
Variable $Hostname
PHPMailer::$Hostname in 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 phpmailer.php
Checks if a string contains multibyte characters.
Method HeaderLine
PHPMailer::HeaderLine() in phpmailer.php
Returns a formatted header line.
Method Hello
SMTP::Hello() in smtp.php
Sends the HELO command to the smtp server.
Method hmac
SMTP::hmac() in smtp.php
Works like hash_hmac('md5', $data, $key) in case that function is not available
Method html2text
PHPMailer::html2text() in phpmailer.php
Convert an HTML string into a plain text version
i
top
Variable $Ical
PHPMailer::$Ical in phpmailer.php
An iCal message part body
Method InlineImageExists
PHPMailer::InlineImageExists() in phpmailer.php
Returns true if an inline attachment is present.
Method IsError
PHPMailer::IsError() in phpmailer.php
Returns true if an error occurred.
Method IsHTML
PHPMailer::IsHTML() in phpmailer.php
Sets message type to HTML.
Method IsMail
PHPMailer::IsMail() in phpmailer.php
Sets Mailer to send message using PHP mail() function.
Method IsQmail
PHPMailer::IsQmail() in phpmailer.php
Sets Mailer to send message using the qmail MTA.
Method IsSendmail
PHPMailer::IsSendmail() in phpmailer.php
Sets Mailer to send message using the $Sendmail program.
Method IsSMTP
PHPMailer::IsSMTP() in phpmailer.php
Sets Mailer to send message using SMTP.
l
top
Variable $language
PHPMailer::$language in phpmailer.php
Variable $LE
PHPMailer::$LE in phpmailer.php
Provides the ability to change the generic line ending
Method Lang
PHPMailer::Lang() in phpmailer.php
Returns a message in the appropriate language.
Method Login
POP3::Login() in pop3.php
Login to the POP3 server (does not support APOP yet)
m
top
Variable $Mailer
PHPMailer::$Mailer in phpmailer.php
Method to send mail: ("mail", "sendmail", or "smtp").
Variable $mailHeader
PHPMailer::$mailHeader in phpmailer.php
Stores the extra header list which CreateHeader() doesn't fold in
Variable $MessageDate
PHPMailer::$MessageDate in phpmailer.php
Sets the message Date to be used in the Date header.
Variable $MessageID
PHPMailer::$MessageID in phpmailer.php
Sets the message ID to be used in the Message-Id header.
Variable $message_type
PHPMailer::$message_type in phpmailer.php
Variable $MIMEBody
PHPMailer::$MIMEBody in phpmailer.php
Stores the complete compiled MIME message body.
Variable $MIMEHeader
PHPMailer::$MIMEHeader in phpmailer.php
Stores the complete compiled MIME message headers.
Method Mail
SMTP::Mail() in 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 phpmailer.php
Sends mail using the PHP mail() function.
Method mb_pathinfo
PHPMailer::mb_pathinfo() in phpmailer.php
Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe.
Method MsgHTML
PHPMailer::MsgHTML() in phpmailer.php
Creates a message from an HTML string, making modifications for inline images and backgrounds
n
top
Method NormalizeBreaks
PHPMailer::NormalizeBreaks() in phpmailer.php
Normalize UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format
p
top
Variable $password
POP3::$password in pop3.php
POP3 Password
Variable $Password
PHPMailer::$Password in phpmailer.php
Sets SMTP password.
Variable $PluginDir
PHPMailer::$PluginDir in 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 pop3.php
Default POP3 port
Variable $POP3_TIMEOUT
POP3::$POP3_TIMEOUT in pop3.php
Default Timeout
Variable $port
POP3::$port in pop3.php
POP3 Port
Variable $Port
PHPMailer::$Port in phpmailer.php
Sets the default SMTP server port.
Variable $Priority
PHPMailer::$Priority in phpmailer.php
Email priority (1 = High, 3 = Normal, 5 = low).
Page phpmailer.php
phpmailer.php in phpmailer.php
Page pop3.php
pop3.php in pop3.php
Class PHPMailer
PHPMailer in phpmailer.php
PHP email creation and transport class
Class phpmailerException
phpmailerException in phpmailer.php
Exception handler for PHPMailer
Class POP3
POP3 in pop3.php
PHP POP-Before-SMTP Authentication Class
Method PostSend
PHPMailer::PostSend() in phpmailer.php
Actual Email transport function
Method PreSend
PHPMailer::PreSend() in phpmailer.php
Prep mail by constructing all message entities
q
top
Method Quit
SMTP::Quit() in 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
Variable $Realm
PHPMailer::$Realm in phpmailer.php
Sets SMTP realm.
Variable $ReplyTo
PHPMailer::$ReplyTo in phpmailer.php
Variable $ReturnPath
PHPMailer::$ReturnPath in phpmailer.php
Sets the Return-Path of the message. If empty, it will be set to either From or Sender.
Method Recipient
SMTP::Recipient() in smtp.php
Sends the command RCPT to the SMTP server with the TO: argument of $to.
Method Reset
SMTP::Reset() in 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 phpmailer.php
Returns the proper RFC 822 formatted date.
s
top
Variable $Sender
PHPMailer::$Sender in phpmailer.php
Sets the Sender email (Return-Path) of the message.
Variable $Sendmail
PHPMailer::$Sendmail in phpmailer.php
Sets the path of the sendmail program.
Variable $sign_cert_file
PHPMailer::$sign_cert_file in phpmailer.php
Variable $sign_key_file
PHPMailer::$sign_key_file in phpmailer.php
Variable $sign_key_pass
PHPMailer::$sign_key_pass in phpmailer.php
Variable $SingleTo
PHPMailer::$SingleTo in phpmailer.php
Provides the ability to have the TO field process individual
Variable $SingleToArray
PHPMailer::$SingleToArray in phpmailer.php
If SingleTo is true, this provides the array to hold the email addresses
Variable $smtp
PHPMailer::$smtp in phpmailer.php
Variable $SMTPAuth
PHPMailer::$SMTPAuth in phpmailer.php
Sets SMTP authentication. Utilizes the Username and Password variables.
Variable $SMTPDebug
PHPMailer::$SMTPDebug in phpmailer.php
Sets SMTP class debugging on or off.
Variable $SMTPKeepAlive
PHPMailer::$SMTPKeepAlive in 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 phpmailer.php
Sets connection prefix. Options are "", "ssl" or "tls"
Variable $smtp_conn
SMTP::$smtp_conn in smtp.php
Variable $SMTP_PORT
SMTP::$SMTP_PORT in smtp.php
SMTP server port
Variable $Subject
PHPMailer::$Subject in phpmailer.php
Sets the Subject of the message.
Page smtp.php
smtp.php in smtp.php
Method SecureHeader
PHPMailer::SecureHeader() in phpmailer.php
Strips newlines to prevent header injection.
Method Send
PHPMailer::Send() in 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 smtp.php
Starts a mail transaction from the email address specified in
Method SendHello
SMTP::SendHello() in smtp.php
Sends a HELO/EHLO command.
Method SendmailSend
PHPMailer::SendmailSend() in phpmailer.php
Sends mail using the $Sendmail program.
Method ServerHostname
PHPMailer::ServerHostname() in phpmailer.php
Returns the server hostname or 'localhost.localdomain' if unknown.
Method set
PHPMailer::set() in phpmailer.php
Set (or reset) Class Objects (variables)
Method SetError
PHPMailer::SetError() in phpmailer.php
Adds the error message to the error container.
Method SetFrom
PHPMailer::SetFrom() in phpmailer.php
Set the From and FromName properties
Method SetLanguage
PHPMailer::SetLanguage() in phpmailer.php
Sets the language for all class error messages.
Method SetMessageType
PHPMailer::SetMessageType() in phpmailer.php
Sets the message type.
Method SetWordWrap
PHPMailer::SetWordWrap() in phpmailer.php
Set the body wrapping.
Method Sign
PHPMailer::Sign() in phpmailer.php
Set the private key file and password to sign the message.
Class SMTP
SMTP in smtp.php
PHP RFC821 SMTP client
Method SmtpClose
PHPMailer::SmtpClose() in phpmailer.php
Closes the active SMTP session if one exists.
Method SmtpConnect
PHPMailer::SmtpConnect() in phpmailer.php
Initiates a connection to an SMTP server.
Method SmtpSend
PHPMailer::SmtpSend() in 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 smtp.php
Initiate a TLS communication with the server.
Class Constant STOP_CONTINUE
PHPMailer::STOP_CONTINUE in phpmailer.php
Class Constant STOP_CRITICAL
PHPMailer::STOP_CRITICAL in phpmailer.php
Class Constant STOP_MESSAGE
PHPMailer::STOP_MESSAGE in phpmailer.php
t
top
Variable $Timelimit
SMTP::$Timelimit in smtp.php
Sets the SMTP timelimit value for reads, in seconds
Variable $Timeout
SMTP::$Timeout in smtp.php
Sets the SMTP timeout value for reads, in seconds
Variable $Timeout
PHPMailer::$Timeout in phpmailer.php
Sets the SMTP server timeout in seconds.
Variable $to
PHPMailer::$to in phpmailer.php
Variable $tval
POP3::$tval in pop3.php
POP3 Timeout Value
Method TextLine
PHPMailer::TextLine() in phpmailer.php
Returns a formatted mail line.
Method Turn
SMTP::Turn() in 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 phpmailer.php
Sets SMTP username.
Variable $username
POP3::$username in pop3.php
POP3 Username
Variable $UseSendmailOptions
PHPMailer::$UseSendmailOptions in phpmailer.php
Determine if mail() uses a fully sendmail compatible MTA that
Method UTF8CharBoundary
PHPMailer::UTF8CharBoundary() in phpmailer.php
Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
v
top
Variable $Version
POP3::$Version in pop3.php
Sets the POP3 PHPMailer Version number
Variable $Version
PHPMailer::$Version in phpmailer.php
Sets the PHPMailer Version number
Variable $Version
SMTP::$Version in smtp.php
Sets the SMTP PHPMailer Version number
Method ValidateAddress
PHPMailer::ValidateAddress() in phpmailer.php
Check that a string looks roughly like an email address should
w
top
Variable $WordWrap
PHPMailer::$WordWrap in phpmailer.php
Sets word wrapping on the body of the message to a given number of characters.
Variable $Workstation
PHPMailer::$Workstation in phpmailer.php
Sets SMTP workstation.
Method WrapText
PHPMailer::WrapText() in phpmailer.php
Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
x
top
Variable $XMailer
PHPMailer::$XMailer in phpmailer.php
What to use in the X-Mailer header
a b c d e f g h i l m n p q r s t u v w x _