PHPMailer
[ class tree: PHPMailer ] [ index: PHPMailer ] [ all elements ]

Element index for package PHPMailer

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

_

_mime_types
in file class.phpmailer.php, method PHPMailer::_mime_types()
    Gets the MIME type of the embedded or inline image
__construct
in file class.smtp.php, method SMTP::__construct()
    Initialize the class so that the data is in a known state.
__construct
in file class.pop3.php, method POP3::__construct()
    Constructor, sets the initial values
__construct
in file class.phpmailer.php, method PHPMailer::__construct()
    Constructor
top

a

$action_function
in file class.phpmailer.php, variable PHPMailer::$action_function
    Callback Action function name
$all_recipients
in file class.phpmailer.php, variable PHPMailer::$all_recipients
$AltBody
in file class.phpmailer.php, variable PHPMailer::$AltBody
    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
in file class.phpmailer.php, variable PHPMailer::$attachment
AddAddress
in file class.phpmailer.php, method PHPMailer::AddAddress()
    Adds a "To" address.
AddAnAddress
in file class.phpmailer.php, method PHPMailer::AddAnAddress()
    Adds an address to one of the recipient arrays
AddAttachment
in file class.phpmailer.php, method PHPMailer::AddAttachment()
    Adds an attachment from a path on the filesystem.
AddBCC
in file class.phpmailer.php, method PHPMailer::AddBCC()
    Adds a "Bcc" address.
AddCC
in file class.phpmailer.php, method PHPMailer::AddCC()
    Adds a "Cc" address.
AddCustomHeader
in file class.phpmailer.php, method PHPMailer::AddCustomHeader()
    Adds a custom header.
AddEmbeddedImage
in file class.phpmailer.php, method PHPMailer::AddEmbeddedImage()
    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
in file class.phpmailer.php, method PHPMailer::AddrAppend()
    Creates recipient headers.
AddReplyTo
in file class.phpmailer.php, method PHPMailer::AddReplyTo()
    Adds a "Reply-to" address.
AddrFormat
in file class.phpmailer.php, method PHPMailer::AddrFormat()
    Formats an address correctly.
AddStringAttachment
in file class.phpmailer.php, method PHPMailer::AddStringAttachment()
    Adds a string or binary attachment (non-filesystem) to the list.
AttachAll
in file class.phpmailer.php, method PHPMailer::AttachAll()
    Attaches all fs, string, and binary attachments to the message.
Authenticate
in file class.smtp.php, method SMTP::Authenticate()
    Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
Authorise
in file class.pop3.php, method POP3::Authorise()
    Combination of public events - connect, login, disconnect
top

b

$bcc
in file class.phpmailer.php, variable PHPMailer::$bcc
$Body
in file class.phpmailer.php, variable PHPMailer::$Body
    Sets the Body of the message. This can be either an HTML or text body.
$boundary
in file class.phpmailer.php, variable PHPMailer::$boundary
Base64EncodeWrapMB
in file class.phpmailer.php, method PHPMailer::Base64EncodeWrapMB()
    Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
top

c

$cc
in file class.phpmailer.php, variable PHPMailer::$cc
$CharSet
in file class.phpmailer.php, variable PHPMailer::$CharSet
    Sets the CharSet of the message.
$ConfirmReadingTo
in file class.phpmailer.php, variable PHPMailer::$ConfirmReadingTo
    Sets the email address that a reading confirmation will be sent.
$connected
in file class.pop3.php, variable POP3::$connected
$ContentType
in file class.phpmailer.php, variable PHPMailer::$ContentType
    Sets the Content-type of the message.
$CRLF
in file class.smtp.php, variable SMTP::$CRLF
    SMTP reply line ending
$CRLF
in file class.pop3.php, variable POP3::$CRLF
    POP3 Carriage Return + Line Feed
$CustomHeader
in file class.phpmailer.php, variable PHPMailer::$CustomHeader
catchWarning
in file class.pop3.php, method POP3::catchWarning()
    Takes over from PHP for the socket warning handler
checkResponse
in file class.pop3.php, method POP3::checkResponse()
    Checks the POP3 server response for +OK or -ERR
ClearAddresses
in file class.phpmailer.php, method PHPMailer::ClearAddresses()
    Clears all recipients assigned in the TO array. Returns void.
ClearAllRecipients
in file class.phpmailer.php, method PHPMailer::ClearAllRecipients()
    Clears all recipients assigned in the TO, CC and BCC array. Returns void.
ClearAttachments
in file class.phpmailer.php, method PHPMailer::ClearAttachments()
    Clears all previously set filesystem, string, and binary attachments. Returns void.
ClearBCCs
in file class.phpmailer.php, method PHPMailer::ClearBCCs()
    Clears all recipients assigned in the BCC array. Returns void.
ClearCCs
in file class.phpmailer.php, method PHPMailer::ClearCCs()
    Clears all recipients assigned in the CC array. Returns void.
ClearCustomHeaders
in file class.phpmailer.php, method PHPMailer::ClearCustomHeaders()
    Clears all custom headers. Returns void.
ClearReplyTos
in file class.phpmailer.php, method PHPMailer::ClearReplyTos()
    Clears all recipients assigned in the ReplyTo array. Returns void.
Close
in file class.smtp.php, method SMTP::Close()
    Closes the socket and cleans up the state of the class.
Connect
in file class.smtp.php, method SMTP::Connect()
    Connect to the server specified on the port specified.
Connect
in file class.pop3.php, method POP3::Connect()
    Connect to the POP3 server
Connected
in file class.smtp.php, method SMTP::Connected()
    Returns true if connected to a server otherwise false
CreateBody
in file class.phpmailer.php, method PHPMailer::CreateBody()
    Assembles the message body. Returns an empty string on failure.
CreateHeader
in file class.phpmailer.php, method PHPMailer::CreateHeader()
    Assembles message header.
C_mailer
in file tce_class_mailer.php, class C_mailer
    C_mailer - PHPMailer class extension
class.phpmailer.php
procedural page class.phpmailer.php
class.pop3.php
procedural page class.pop3.php
class.smtp.php
procedural page class.smtp.php
top

d

$DKIM_domain
in file class.phpmailer.php, variable PHPMailer::$DKIM_domain
    Used with DKIM DNS Resource Record
$DKIM_identity
in file class.phpmailer.php, variable PHPMailer::$DKIM_identity
    Used with DKIM DNS Resource Record
$DKIM_private
in file class.phpmailer.php, variable PHPMailer::$DKIM_private
    Used with DKIM DNS Resource Record
$DKIM_selector
in file class.phpmailer.php, variable PHPMailer::$DKIM_selector
    Used with DKIM DNS Resource Record
$do_debug
in file class.smtp.php, variable SMTP::$do_debug
    Sets whether debugging is turned on
$do_debug
in file class.pop3.php, variable POP3::$do_debug
    Displaying Debug warnings? (0 = now, 1+ = yes)
$do_verp
in file class.smtp.php, variable SMTP::$do_verp
    Sets VERP use on/off (default is off)
Data
in file class.smtp.php, method SMTP::Data()
    Issues a data command and sends the msg_data to the server
Disconnect
in file class.pop3.php, method POP3::Disconnect()
    Disconnect from the POP3 server
displayErrors
in file class.pop3.php, method POP3::displayErrors()
    If debug is enabled, display the error message array
DKIM_Add
in file class.phpmailer.php, method PHPMailer::DKIM_Add()
    Create the DKIM header, body, as new header
DKIM_BodyC
in file class.phpmailer.php, method PHPMailer::DKIM_BodyC()
    Generate DKIM Canonicalization Body
DKIM_HeaderC
in file class.phpmailer.php, method PHPMailer::DKIM_HeaderC()
    Generate DKIM Canonicalization Header
DKIM_QP
in file class.phpmailer.php, method PHPMailer::DKIM_QP()
    Set the private key file and password to sign the message.
DKIM_Sign
in file class.phpmailer.php, method PHPMailer::DKIM_Sign()
    Generate DKIM signature
doCallback
in file class.phpmailer.php, method PHPMailer::doCallback()
top

e

$Encoding
in file class.phpmailer.php, variable PHPMailer::$Encoding
    Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
$error
in file class.smtp.php, variable SMTP::$error
$error
in file class.pop3.php, variable POP3::$error
$ErrorInfo
in file class.phpmailer.php, variable PHPMailer::$ErrorInfo
    Holds the most recent mailer error message.
$error_count
in file class.phpmailer.php, variable PHPMailer::$error_count
$exceptions
in file class.phpmailer.php, variable PHPMailer::$exceptions
EncodeFile
in file class.phpmailer.php, method PHPMailer::EncodeFile()
    Encodes attachment in requested format.
EncodeHeader
in file class.phpmailer.php, method PHPMailer::EncodeHeader()
    Encode a header string to best (shortest) of Q, B, quoted or none.
EncodeQ
in file class.phpmailer.php, method PHPMailer::EncodeQ()
    Encode string to q encoding.
EncodeQP
in file class.phpmailer.php, method PHPMailer::EncodeQP()
    Encode string to RFC2045 (6.7) quoted-printable format
EncodeQPphp
in file class.phpmailer.php, method PHPMailer::EncodeQPphp()
    Encode string to quoted-printable.
EncodeString
in file class.phpmailer.php, method PHPMailer::EncodeString()
    Encodes string to requested format.
EndBoundary
in file class.phpmailer.php, method PHPMailer::EndBoundary()
    Returns the end of a message boundary.
errorMessage
in file class.phpmailer.php, method phpmailerException::errorMessage()
top

f

$From
in file class.phpmailer.php, variable PHPMailer::$From
    Sets the From email address for the message.
$FromName
in file class.phpmailer.php, variable PHPMailer::$FromName
    Sets the From name of the message.
FixEOL
in file class.phpmailer.php, method PHPMailer::FixEOL()
    Changes every end of line from CR or LF to CRLF.
top

g

GetAttachments
in file class.phpmailer.php, method PHPMailer::GetAttachments()
    Return the current array of attachments
GetBoundary
in file class.phpmailer.php, method PHPMailer::GetBoundary()
    Returns the start of a message boundary.
getError
in file class.smtp.php, method SMTP::getError()
    Get the current error
GetMailMIME
in file class.phpmailer.php, method PHPMailer::GetMailMIME()
    Returns the message MIME.
getResponse
in file class.pop3.php, method POP3::getResponse()
    Get the socket response back.
GetTranslations
in file class.phpmailer.php, method PHPMailer::GetTranslations()
    Return the current array of language strings
get_lines
in file class.smtp.php, method SMTP::get_lines()
    Read in as many lines as possible either before eof or socket timeout occurs on the operation.
top

h

$Helo
in file class.phpmailer.php, variable PHPMailer::$Helo
    Sets the SMTP HELO of the message (Default is $Hostname).
$helo_rply
in file class.smtp.php, variable SMTP::$helo_rply
$Host
in file class.phpmailer.php, variable PHPMailer::$Host
    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
in file class.pop3.php, variable POP3::$host
    POP3 Mail Server
$Hostname
in file class.phpmailer.php, variable PHPMailer::$Hostname
    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
in file class.phpmailer.php, method PHPMailer::HasMultiBytes()
    Checks if a string contains multibyte characters.
HeaderLine
in file class.phpmailer.php, method PHPMailer::HeaderLine()
    Returns a formatted header line.
Hello
in file class.smtp.php, method SMTP::Hello()
    Sends the HELO command to the smtp server.
top

i

InlineImageExists
in file class.phpmailer.php, method PHPMailer::InlineImageExists()
    Returns true if an inline attachment is present.
IsError
in file class.phpmailer.php, method PHPMailer::IsError()
    Returns true if an error occurred.
IsHTML
in file class.phpmailer.php, method PHPMailer::IsHTML()
    Sets message type to HTML.
IsMail
in file class.phpmailer.php, method PHPMailer::IsMail()
    Sets Mailer to send message using PHP mail() function.
IsQmail
in file class.phpmailer.php, method PHPMailer::IsQmail()
    Sets Mailer to send message using the qmail MTA.
IsSendmail
in file class.phpmailer.php, method PHPMailer::IsSendmail()
    Sets Mailer to send message using the $Sendmail program.
IsSMTP
in file class.phpmailer.php, method PHPMailer::IsSMTP()
    Sets Mailer to send message using SMTP.
top

l

$language
in file tce_class_mailer.php, variable C_mailer::$language
    language array
$language
in file class.phpmailer.php, variable PHPMailer::$language
$LE
in file class.phpmailer.php, variable PHPMailer::$LE
    Provides the ability to change the line ending
Lang
in file tce_class_mailer.php, method C_mailer::Lang()
    Returns a message in the appropriate language.
Lang
in file class.phpmailer.php, method PHPMailer::Lang()
    Returns a message in the appropriate language.
Login
in file class.pop3.php, method POP3::Login()
    Login to the POP3 server (does not support APOP yet)
top

m

$Mailer
in file class.phpmailer.php, variable PHPMailer::$Mailer
    Method to send mail: ("mail", "sendmail", or "smtp").
$MessageID
in file class.phpmailer.php, variable PHPMailer::$MessageID
    Sets the message ID to be used in the Message-Id header.
$message_type
in file class.phpmailer.php, variable PHPMailer::$message_type
Mail
in file class.smtp.php, method SMTP::Mail()
    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
in file class.phpmailer.php, method PHPMailer::MailSend()
    Sends mail using the PHP mail() function.
MsgHTML
in file class.phpmailer.php, method PHPMailer::MsgHTML()
    Evaluates the message and returns modifications for inline images and backgrounds
top

p

$Password
in file class.phpmailer.php, variable PHPMailer::$Password
    Sets SMTP password.
$password
in file class.pop3.php, variable POP3::$password
    POP3 Password
$PluginDir
in file class.phpmailer.php, variable PHPMailer::$PluginDir
    Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
$POP3_PORT
in file class.pop3.php, variable POP3::$POP3_PORT
    Default POP3 port
$POP3_TIMEOUT
in file class.pop3.php, variable POP3::$POP3_TIMEOUT
    Default Timeout
$pop_conn
in file class.pop3.php, variable POP3::$pop_conn
$Port
in file class.phpmailer.php, variable PHPMailer::$Port
    Sets the default SMTP server port.
$port
in file class.pop3.php, variable POP3::$port
    POP3 Port
$Priority
in file class.phpmailer.php, variable PHPMailer::$Priority
    Email priority (1 = High, 3 = Normal, 5 = low).
PHPMailer
in file class.phpmailer.php, class PHPMailer
    PHPMailer - PHP email transport class
phpmailerException
in file class.phpmailer.php, class phpmailerException
    PHPMailer Exceptions
POP3
in file class.pop3.php, class POP3
    POP Before SMTP Authentication Class Version 5.0.0
top

q

Quit
in file class.smtp.php, method SMTP::Quit()
    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.
top

r

$ReplyTo
in file class.phpmailer.php, variable PHPMailer::$ReplyTo
Recipient
in file class.smtp.php, method SMTP::Recipient()
    Sends the command RCPT to the SMTP server with the TO: argument of $to.
Reset
in file class.smtp.php, method SMTP::Reset()
    Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.
RFCDate
in file class.phpmailer.php, method PHPMailer::RFCDate()
    Returns the proper RFC 822 formatted date.
top

s

$Sender
in file class.phpmailer.php, variable PHPMailer::$Sender
    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
in file class.phpmailer.php, variable PHPMailer::$Sendmail
    Sets the path of the sendmail program.
$sign_cert_file
in file class.phpmailer.php, variable PHPMailer::$sign_cert_file
$sign_key_file
in file class.phpmailer.php, variable PHPMailer::$sign_key_file
$sign_key_pass
in file class.phpmailer.php, variable PHPMailer::$sign_key_pass
$SingleTo
in file class.phpmailer.php, variable PHPMailer::$SingleTo
    Provides the ability to have the TO field process individual
$SingleToArray
in file class.phpmailer.php, variable PHPMailer::$SingleToArray
    If SingleTo is true, this provides the array to hold the email addresses
$smtp
in file class.phpmailer.php, variable PHPMailer::$smtp
$SMTPAuth
in file class.phpmailer.php, variable PHPMailer::$SMTPAuth
    Sets SMTP authentication. Utilizes the Username and Password variables.
$SMTPDebug
in file class.phpmailer.php, variable PHPMailer::$SMTPDebug
    Sets SMTP class debugging on or off.
$SMTPKeepAlive
in file class.phpmailer.php, variable PHPMailer::$SMTPKeepAlive
    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
in file class.phpmailer.php, variable PHPMailer::$SMTPSecure
    Sets connection prefix.
$smtp_conn
in file class.smtp.php, variable SMTP::$smtp_conn
$SMTP_PORT
in file class.smtp.php, variable SMTP::$SMTP_PORT
    SMTP server port
$Subject
in file class.phpmailer.php, variable PHPMailer::$Subject
    Sets the Subject of the message.
SecureHeader
in file class.phpmailer.php, method PHPMailer::SecureHeader()
    Strips newlines to prevent header injection.
Send
in file class.phpmailer.php, method PHPMailer::Send()
    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
in file class.smtp.php, method SMTP::SendAndMail()
    Starts a mail transaction from the email address specified in
SendHello
in file class.smtp.php, method SMTP::SendHello()
    Sends a HELO/EHLO command.
SendmailSend
in file class.phpmailer.php, method PHPMailer::SendmailSend()
    Sends mail using the $Sendmail program.
sendString
in file class.pop3.php, method POP3::sendString()
    Send a string down the open socket connection to the POP3 server
ServerHostname
in file class.phpmailer.php, method PHPMailer::ServerHostname()
    Returns the server hostname or 'localhost.localdomain' if unknown.
set
in file class.phpmailer.php, method PHPMailer::set()
    Set (or reset) Class Objects (variables)
SetError
in file tce_class_mailer.php, method C_mailer::SetError()
    Replace the default SetError
SetError
in file class.phpmailer.php, method PHPMailer::SetError()
    Adds the error message to the error container.
SetFrom
in file class.phpmailer.php, method PHPMailer::SetFrom()
    Set the From and FromName properties
SetLanguage
in file class.phpmailer.php, method PHPMailer::SetLanguage()
    Sets the language for all class error messages.
SetMessageType
in file class.phpmailer.php, method PHPMailer::SetMessageType()
    Sets the message type.
SetWordWrap
in file class.phpmailer.php, method PHPMailer::SetWordWrap()
    Set the body wrapping.
Sign
in file class.phpmailer.php, method PHPMailer::Sign()
    Set the private key file and password to sign the message.
SMTP
in file class.smtp.php, class SMTP
    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
in file class.phpmailer.php, method PHPMailer::SmtpClose()
    Closes the active SMTP session if one exists.
SmtpConnect
in file class.phpmailer.php, method PHPMailer::SmtpConnect()
    Initiates a connection to an SMTP server.
SmtpSend
in file class.phpmailer.php, method PHPMailer::SmtpSend()
    Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
StartTLS
in file class.smtp.php, method SMTP::StartTLS()
    Initiate a TLS communication with the server.
STOP_CONTINUE
in file class.phpmailer.php, class constant PHPMailer::STOP_CONTINUE
STOP_CRITICAL
in file class.phpmailer.php, class constant PHPMailer::STOP_CRITICAL
STOP_MESSAGE
in file class.phpmailer.php, class constant PHPMailer::STOP_MESSAGE
top

t

$Timeout
in file class.phpmailer.php, variable PHPMailer::$Timeout
    Sets the SMTP server timeout in seconds.
$to
in file class.phpmailer.php, variable PHPMailer::$to
$tval
in file class.pop3.php, variable POP3::$tval
    POP3 Timeout Value
tce_class_mailer.php
procedural page tce_class_mailer.php
TextLine
in file class.phpmailer.php, method PHPMailer::TextLine()
    Returns a formatted mail line.
Turn
in file class.smtp.php, method SMTP::Turn()
    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
top

u

$Username
in file class.phpmailer.php, variable PHPMailer::$Username
    Sets SMTP username.
$username
in file class.pop3.php, variable POP3::$username
    POP3 Username
UTF8CharBoundary
in file class.phpmailer.php, method PHPMailer::UTF8CharBoundary()
    Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
top

v

$Version
in file class.phpmailer.php, variable PHPMailer::$Version
    Sets the PHPMailer Version number
ValidateAddress
in file tce_class_mailer.php, method C_mailer::ValidateAddress()
    Check that a string looks roughly like an email address should (override original ValidateAddress method).
ValidateAddress
in file class.phpmailer.php, method PHPMailer::ValidateAddress()
    Check that a string looks roughly like an email address should
top

w

$WordWrap
in file class.phpmailer.php, variable PHPMailer::$WordWrap
    Sets word wrapping on the body of the message to a given number of characters.
WrapText
in file class.phpmailer.php, method PHPMailer::WrapText()
    Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
top

Documentation generated on Mon, 06 Dec 2010 12:02:59 +0100 by phpDocumentor 1.4.3