PHPMailer - PHP email transport class
- -- Located in Program_Root/class.phpmailer.php (line 20) -
- - - - -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.
- - - - - -Sets the Body of the message. This can be either an HTML or text body.
-If HTML then run IsHTML(true).
- - - - - -Sets the CharSet of the message.
- - - - - -Sets the email address that a reading confirmation will be sent.
- - - - - -Sets the Content-type of the message.
- - - - - -Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
- - - - - -Holds the most recent mailer error message.
- - - - - -Sets the From email address for the message.
- - - - - -Sets the From name of the message.
- - - - - -Sets the SMTP HELO of the message (Default is $Hostname).
- - - - - -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").
-Hosts will be tried in order.
- - - - - -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 to send mail: ("mail", "sendmail", or "smtp").
- - - - - -Sets SMTP password.
- - - - - -Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.
- - - - - -Sets the default SMTP server port.
- - - - - -Email priority (1 = High, 3 = Normal, 5 = low).
- - - - - -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.
- - - - - -Sets the path of the sendmail program.
- - - - - -Sets SMTP authentication. Utilizes the Username and Password variables.
- - - - - -Sets SMTP class debugging on or off.
- - - - - -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().
- - - - - -Sets the Subject of the message.
- - - - - -Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
- - - - - -Sets SMTP username.
- - - - - -Holds PHPMailer version.
- - - - - -Sets word wrapping on the body of the message to a given number of characters.
- - - - - -Adds a "To" address.
- -Adds an attachment from a path on the filesystem.
-Returns false if the file could not be found or accessed.
- -Path to the attachment.
Overrides the attachment name.
File encoding (see $Encoding).
File extension (MIME) type.
Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
- -Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
- -Adds a custom header.
- -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".
- -Path to the attachment.
Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
Overrides the attachment name.
File encoding (see $Encoding).
File extension (MIME) type.
Adds a "Reply-to" address.
- -Adds a string or binary attachment (non-filesystem) to the list.
-This method can be used to attach ascii or binary data, such as a BLOB record from a database.
- -String attachment data.
Name of the attachment.
File encoding (see $Encoding).
File extension (MIME) type.
Clears all recipients assigned in the TO array. Returns void.
- -Clears all recipients assigned in the TO, CC and BCC array. Returns void.
- -Clears all previously set filesystem, string, and binary attachments. Returns void.
- -Clears all recipients assigned in the BCC array. Returns void.
- -Clears all recipients assigned in the CC array. Returns void.
- -Clears all custom headers. Returns void.
- -Clears all recipients assigned in the ReplyTo array. Returns void.
- -Returns true if an error occurred.
- -Sets message type to HTML.
- -Sets Mailer to send message using PHP mail() function.
- -Sets Mailer to send message using the qmail MTA.
- -Sets Mailer to send message using the $Sendmail program.
- -Sets Mailer to send message using SMTP.
- -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.
- -Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
- - -Type of language (e.g. Portuguese: "br")
Path to the language file directory
Closes the active SMTP session if one exists.
- -- Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by phpDocumentor 1.2.0 -
-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.
- -- Located in Program_Root/class.smtp.php (line 24) -
- - - - -Initialize the class so that the data is in a known state.
- - -Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
- - -Closes the socket and cleans up the state of the class.
-It is not considered good to use this function without first trying to use QUIT.
- - -Connect to the server specified on the port specified.
-If the port is not specified use the default SMTP_PORT. If tval is specified then a connection will try and be established with the server for that number of seconds. If tval is not specified the default is 30 seconds to try on the connection.
SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421
- - -Issues a data command and sends the msg_data to the server
-finializing the mail transaction. $msg_data is the message that is to be send with the headers. Each header needs to be on a single line followed by a <CRLF> with the message headers and the message body being seperated by and additional <CRLF>.
Implements rfc 821: DATA <CRLF>
SMTP CODE INTERMEDIATE: 354 [data] <CRLF>.<CRLF> SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 552,554,451,452 SMTP CODE FAILURE: 451,554 SMTP CODE ERROR : 500,501,503,421
- - -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.
-Each value in the array returned has the format of: [ <full-name> <sp> ] <path> The definition of <path> is defined in rfc 821
Implements rfc 821: EXPN <SP> <string> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 550 SMTP CODE ERROR : 500,501,502,504,421
- - -Sends the HELO command to the smtp server.
-This makes sure that we and the server are in the same known state.
Implements from rfc 821: HELO <SP> <domain> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 501, 504, 421
- - -Gets help information on the keyword specified. If the keyword
-is not specified then returns generic help, ussually contianing A list of keywords that help is available on. This function returns the results back to the user. It is up to the user to handle the returned data. If an error occurs then false is returned with $this->error set appropiately.
Implements rfc 821: HELP [ <SP> <string> ] <CRLF>
SMTP CODE SUCCESS: 211,214 SMTP CODE ERROR : 500,501,502,504,421
- - -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.
-Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,421
- - -Sends the command NOOP to the SMTP server.
-Implements from rfc 821: NOOP <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 421
- - -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.
-Implements from rfc 821: QUIT <CRLF>
SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500
- - -Sends the command RCPT to the SMTP server with the TO: argument of $to.
-Returns true if the recipient was accepted false if it was rejected.
Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,552,553,450,451,452 SMTP CODE ERROR : 500,501,503,421
- - -Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.
-Implements rfc 821: RSET <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500,501,504,421
- - -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. This command will send the message to the users terminal if they are logged in.
Implements rfc 821: SEND <SP> FROM:<reverse-path> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421
- - -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. This command will send the message to the users terminal if they are logged in and send them an email.
Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421
- - -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. This command will send the message to the users terminal if they are logged in or mail it to them if they are not.
Implements rfc 821: SOML <SP> FROM:<reverse-path> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421
- - -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
-Implements from rfc 821: TURN <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503
- - -Verifies that the name is recognized by the server.
-Returns false if the name could not be verified otherwise the response from the server is returned.
Implements rfc 821: VRFY <SP> <string> <CRLF>
SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,553 SMTP CODE ERROR : 500,501,502,421
- - -- Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by phpDocumentor 1.2.0 -
-| Class | -Description | -
|---|---|
| - PHPMailer - | -- PHPMailer - PHP email transport class - | -
- Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by phpDocumentor 1.2.0 -
-| Class | -Description | -
|---|---|
| - 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. - | -
- Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by phpDocumentor 1.2.0 -
-- Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by phpDocumentor 1.2.0 -
- - \ No newline at end of file diff --git a/phpdoc/elementindex.html b/phpdoc/elementindex.html deleted file mode 100644 index 7f65a767..00000000 --- a/phpdoc/elementindex.html +++ /dev/null @@ -1,734 +0,0 @@ - - - - - -- Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by phpDocumentor 1.2.0 -
- - \ No newline at end of file diff --git a/phpdoc/index.html b/phpdoc/index.html deleted file mode 100644 index f2b2c7aa..00000000 --- a/phpdoc/index.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - -