[ Index ]

PHP Cross Reference of BackPress

title

Body

[close]

/includes/ -> class.mailer-smtp.php (summary)

PHPMailer - PHP SMTP email transport class NOTE: Designed for use with PHP version 5 and up

Author: Andy Prevost
Author: Marcus Bointon
Author: Jim Jagielski
Copyright: 2004 - 2008 Andy Prevost
Copyright: 2010 - 2012 Jim Jagielski
License: http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
Version: $Id: class.smtp.php 450 2010-06-23 16:46:33Z coolbru $
File Size: 819 lines (25 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SMTP:: (17 methods):
  __construct()
  Connect()
  StartTLS()
  Authenticate()
  Connected()
  Close()
  Data()
  Hello()
  SendHello()
  Mail()
  Quit()
  Recipient()
  Reset()
  SendAndMail()
  Turn()
  getError()
  get_lines()


Class: SMTP  - X-Ref

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.
original author: Chris Ryan

__construct()   X-Ref
Initialize the class so that the data is in a known state.

return: void

Connect($host, $port = 0, $tval = 30)   X-Ref
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
return: bool

StartTLS()   X-Ref
Initiate a TLS communication with the server.

SMTP CODE 220 Ready to start TLS
SMTP CODE 501 Syntax error (no parameters allowed)
SMTP CODE 454 TLS not available due to temporary reason
return: bool success

Authenticate($username, $password)   X-Ref
Performs SMTP authentication.  Must be run after running the
Hello() method.  Returns true if successfully authenticated.

return: bool

Connected()   X-Ref
Returns true if connected to a server otherwise false

return: bool

Close()   X-Ref
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.

return: void

Data($msg_data)   X-Ref
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
return: bool

Hello($host = '')   X-Ref
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
return: bool

SendHello($hello, $host)   X-Ref
Sends a HELO/EHLO command.

return: bool

Mail($from)   X-Ref
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
return: bool

Quit($close_on_error = true)   X-Ref
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
return: bool

Recipient($to)   X-Ref
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
return: bool

Reset()   X-Ref
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
return: bool

SendAndMail($from)   X-Ref
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
return: bool

Turn()   X-Ref
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
return: bool

getError()   X-Ref
Get the current error

return: array

get_lines()   X-Ref
Read in as many lines as possible
either before eof or socket timeout occurs on the operation.
With SMTP we can tell if we have more lines to read if the
4th character is '-' symbol. If it is a space then we don't
need to read anything else.

return: string



Generated: Thu Oct 23 03:58:30 2014 Hosted by follow the white rabbit.