Element index for package PHPMailer
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
top
a
- $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.
- 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. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
- AddCC
- in file class.phpmailer.php, method PHPMailer::AddCC()
Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
- AddChange
- in file phpmailer_test.php, method phpmailerTest::AddChange()
Adds a change entry.
- 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".
- AddNote
- in file phpmailer_test.php, method phpmailerTest::AddNote()
Adds a simple note to the message.
- 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.
- addTest
- in file phpunit.php, method TestSuite::addTest()
- assert
- in file phpunit.php, method Assert::assert()
- Assert
- in file phpunit.php, class Assert
Class Assert
- assertEquals
- in file phpunit.php, method Assert::assertEquals()
- assertRegexp
- in file phpunit.php, method Assert::assertRegexp()
- 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.
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
- BuildBody
- in file phpmailer_test.php, method phpmailerTest::BuildBody()
Build the body of the message in the appropriate format.
top
c
- $cc
- in file class.phpmailer.php, variable PHPMailer::$cc
- $ChangeLog
- in file phpmailer_test.php, variable phpmailerTest::$ChangeLog
Holds the change log.
- $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.
- $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
- $CustomHeader
- in file class.phpmailer.php, variable PHPMailer::$CustomHeader
- CheckChanges
- in file phpmailer_test.php, method phpmailerTest::CheckChanges()
Check which default settings have been changed for the report.
- 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.
- Connected
- in file class.smtp.php, method SMTP::Connected()
Returns true if connected to a server otherwise false
- countFailures
- in file phpunit.php, method TestResult::countFailures()
- countTestCases
- in file phpunit.php, method TestCase::countTestCases()
- countTestCases
- in file phpunit.php, method TestSuite::countTestCases()
- countTests
- in file phpunit.php, method TestResult::countTests()
- 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.smtp.php
- procedural page class.smtp.php
top
d
- $do_debug
- in file class.smtp.php, variable SMTP::$do_debug
Sets whether debugging is turned on
- Data
- in file class.smtp.php, method SMTP::Data()
Issues a data command and sends the msg_data to the server
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
- $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
- EncodeFile
- in file class.phpmailer.php, method PHPMailer::EncodeFile()
Encodes attachment in requested format. Returns an empty string on failure.
- EncodeHeader
- in file class.phpmailer.php, method PHPMailer::EncodeHeader()
Encode a header string to best 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 quoted-printable.
- EncodeString
- in file class.phpmailer.php, method PHPMailer::EncodeString()
Encodes string to requested format. Returns an empty string on failure.
- EndBoundary
- in file class.phpmailer.php, method PHPMailer::EndBoundary()
Returns the end of a message boundary.
- error
- in file phpunit.php, method TestCase::error()
- Exception
- in file phpunit.php, method Exception::Exception()
- Exception
- in file phpunit.php, class Exception
Class Exception
- Expand
- in file class.smtp.php, method SMTP::Expand()
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.
top
f
- $fExceptions
- in file phpunit.php, variable TestCase::$fExceptions
- $fExceptions
- in file phpunit.php, variable TestFailure::$fExceptions
- $fFailedTestName
- in file phpunit.php, variable TestFailure::$fFailedTestName
- $fFailures
- in file phpunit.php, variable TestResult::$fFailures
- $fName
- in file phpunit.php, variable TestCase::$fName
- $fResult
- in file phpunit.php, variable TestCase::$fResult
- $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.
- $fRunTests
- in file phpunit.php, variable TestResult::$fRunTests
- $fStop
- in file phpunit.php, variable TestResult::$fStop
- $fTests
- in file phpunit.php, variable TestSuite::$fTests
- fail
- in file phpunit.php, method TestCase::fail()
- failed
- in file phpunit.php, method TestCase::failed()
- failNotEquals
- in file phpunit.php, method Assert::failNotEquals()
- FixEOL
- in file class.phpmailer.php, method PHPMailer::FixEOL()
Changes every end of line from CR or LF to CRLF.
top
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 phpmailer_test.php, variable phpmailerTest::$Host
Holds the SMTP mail host.
- $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'.
- 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.
- Help
- in file class.smtp.php, method SMTP::Help()
Gets help information on the keyword specified. If the keyword
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
top
m
- $Mail
- in file phpmailer_test.php, variable phpmailerTest::$Mail
Holds the default phpmailer instance.
- $Mailer
- in file class.phpmailer.php, variable PHPMailer::$Mailer
Method to send mail: ("mail", "sendmail", or "smtp").
- $message
- in file phpunit.php, variable Exception::$message
- $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.
top
top
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.
- report
- in file phpunit.php, method TextTestResult::report()
- 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.
- run
- in file phpunit.php, method TestSuite::run()
- run
- in file phpunit.php, method TestCase::run()
- run
- in file phpunit.php, method TestResult::run()
- run
- in file phpunit.php, method TestRunner::run()
- runBare
- in file phpunit.php, method TestCase::runBare()
- runTest
- in file phpunit.php, method TestCase::runTest()
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.
- $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().
- $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.
- Send
- in file class.smtp.php, method SMTP::Send()
Starts a mail transaction from the email address specified in
- 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.
- SendOrMail
- in file class.smtp.php, method SMTP::SendOrMail()
Starts a mail transaction from the email address specified in
- ServerHostname
- in file class.phpmailer.php, method PHPMailer::ServerHostname()
Returns the server hostname or 'localhost.localdomain' if unknown.
- ServerVar
- in file class.phpmailer.php, method PHPMailer::ServerVar()
Returns the appropriate server variable. Should work with both PHP 4.1.0+ as well as older versions. Returns an empty string if nothing is found.
- SetAddress
- in file phpmailer_test.php, method phpmailerTest::SetAddress()
Adds all of the addresses
- 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.
- SetLanguage
- in file class.phpmailer.php, method PHPMailer::SetLanguage()
Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
- SetMessageType
- in file class.phpmailer.php, method PHPMailer::SetMessageType()
Sets the message type.
- setUp
- in file phpunit.php, method TestCase::setUp()
- setUp
- in file phpmailer_test.php, method phpmailerTest::setUp()
Run before each test is started.
- SetWordWrap
- in file class.phpmailer.php, method PHPMailer::SetWordWrap()
Set the body wrapping.
- shouldStop
- in file phpunit.php, method TestResult::shouldStop()
- 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.
- SMTP
- in file class.smtp.php, method SMTP::SMTP()
Initialize the class so that the data is in a known state.
- 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. Returns false if the operation failed.
- SmtpSend
- in file class.phpmailer.php, method PHPMailer::SmtpSend()
Sends mail via SMTP using PhpSMTP (Author: Chris Ryan). Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
- stop
- in file phpunit.php, method TestResult::stop()
top
t
- $Timeout
- in file class.phpmailer.php, variable PHPMailer::$Timeout
Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
- $to
- in file class.phpmailer.php, variable PHPMailer::$to
- tce_class_mailer.php
- procedural page tce_class_mailer.php
- tearDown
- in file phpunit.php, method TestCase::tearDown()
- tearDown
- in file phpmailer_test.php, method phpmailerTest::tearDown()
Run after each test is completed.
- TestCase
- in file phpunit.php, class TestCase
Class testCase
- TestCase
- in file phpunit.php, method TestCase::TestCase()
- TestFailure
- in file phpunit.php, class TestFailure
Class testFailure
- TestFailure
- in file phpunit.php, method TestFailure::TestFailure()
- TestResult
- in file phpunit.php, class TestResult
Class testResult
- TestResult
- in file phpunit.php, method TestResult::TestResult()
- TestRunner
- in file phpunit.php, class TestRunner
Class TestRunner
- TestSuite
- in file phpunit.php, class TestSuite
Class TestSuite
- TestSuite
- in file phpunit.php, method TestSuite::TestSuite()
- test_AltBody
- in file phpmailer_test.php, method phpmailerTest::test_AltBody()
Simple multipart/alternative test.
- test_AltBody_Attachment
- in file phpmailer_test.php, method phpmailerTest::test_AltBody_Attachment()
Simple HTML and attachment test
- test_DenialOfServiceAttack
- in file phpmailer_test.php, method phpmailerTest::test_DenialOfServiceAttack()
Tests this denial of service attack:
- test_Embedded_Image
- in file phpmailer_test.php, method phpmailerTest::test_Embedded_Image()
An embedded attachment test.
- test_Error
- in file phpmailer_test.php, method phpmailerTest::test_Error()
- test_Html
- in file phpmailer_test.php, method phpmailerTest::test_Html()
Try a plain message.
- test_HTML_Attachment
- in file phpmailer_test.php, method phpmailerTest::test_HTML_Attachment()
Simple HTML and attachment test
- test_Low_Priority
- in file phpmailer_test.php, method phpmailerTest::test_Low_Priority()
Try a plain message.
- test_MultipleSend
- in file phpmailer_test.php, method phpmailerTest::test_MultipleSend()
- test_Multiple_Plain_FileAttachment
- in file phpmailer_test.php, method phpmailerTest::test_Multiple_Plain_FileAttachment()
Simple plain file attachment test.
- test_Multi_Embedded_Image
- in file phpmailer_test.php, method phpmailerTest::test_Multi_Embedded_Image()
An embedded attachment test.
- test_Plain_StringAttachment
- in file phpmailer_test.php, method phpmailerTest::test_Plain_StringAttachment()
Simple plain string attachment test.
- test_Quoted_Printable
- in file phpmailer_test.php, method phpmailerTest::test_Quoted_Printable()
Plain quoted-printable message.
- test_SmtpKeepAlive
- in file phpmailer_test.php, method phpmailerTest::test_SmtpKeepAlive()
- test_WordWrap
- in file phpmailer_test.php, method phpmailerTest::test_WordWrap()
Try a plain message.
- TextLine
- in file class.phpmailer.php, method PHPMailer::TextLine()
Returns a formatted mail line.
- TextTestResult
- in file phpunit.php, class TextTestResult
Class TextTestResult
- TextTestResult
- in file phpunit.php, method TextTestResult::TextTestResult()
- trace
- in file phpunit.php, function trace()
- 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
top
v
- $Version
- in file class.phpmailer.php, variable PHPMailer::$Version
Holds PHPMailer version.
- Verify
- in file class.smtp.php, method SMTP::Verify()
Verifies that the name is recognized by the server.
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
|
|