Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Attributs publics | Fonctions membres privées | Attributs privés
Référence de la classe SMTP

Liste de tous les membres

Fonctions membres publiques

 __construct ()
 Connect ($host, $port=0, $tval=30)
 StartTLS ()
 Authenticate ($username, $password)
 Connected ()
 Close ()
 Data ($msg_data)
 Hello ($host= '')
 Mail ($from)
 Quit ($close_on_error=true)
 Recipient ($to)
 Reset ()
 SendAndMail ($from)
 Turn ()
 getError ()

Attributs publics

 $SMTP_PORT = 25
 $CRLF = "\r\n"
 $do_debug
 $do_verp = false
 $Version = '5.2.1'

Fonctions membres privées

 SendHello ($hello, $host)
 get_lines ()

Attributs privés

 $smtp_conn
 $error
 $helo_rply

Description détaillée

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

Documentation des constructeurs et destructeur

SMTP::__construct ( )

Initialize the class so that the data is in a known state. public

Renvoie:
void

Références null.

Documentation des fonctions membres

SMTP::Authenticate (   $username,
  $password 
)

Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated. public

Renvoie:
bool

Références get_lines().

+ Voici le graphe d'appel pour cette fonction :

SMTP::Close ( )

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. public

Renvoie:
void

Références null.

Référencé par Connected(), et Quit().

+ Voici le graphe des appelants de cette fonction :

SMTP::Connect (   $host,
  $port = 0,
  $tval = 30 
)

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 public

Renvoie:
bool

Références $SMTP_PORT, get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::Connected ( )

Returns true if connected to a server otherwise false public

Renvoie:
bool

Références Close().

+ Voici le graphe d'appel pour cette fonction :

SMTP::Data (   $msg_data)

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 public

Renvoie:
bool

Références $field, get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::get_lines ( )
private

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. private

Renvoie:
string

Références $data.

Référencé par Authenticate(), Connect(), Data(), Mail(), Quit(), Recipient(), Reset(), SendAndMail(), SendHello(), et StartTLS().

+ Voici le graphe des appelants de cette fonction :

SMTP::getError ( )

Get the current error public

Renvoie:
array

Références $error.

SMTP::Hello (   $host = '')

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 public

Renvoie:
bool

Références null, et SendHello().

+ Voici le graphe d'appel pour cette fonction :

SMTP::Mail (   $from)

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 public

Renvoie:
bool

Références get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::Quit (   $close_on_error = true)

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 public

Renvoie:
bool

Références Close(), get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::Recipient (   $to)

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 public

Renvoie:
bool

Références get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::Reset ( )

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 public

Renvoie:
bool

Références get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::SendAndMail (   $from)

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 public

Renvoie:
bool

Références get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

SMTP::SendHello (   $hello,
  $host 
)
private

Sends a HELO/EHLO command. private

Renvoie:
bool

Références get_lines().

Référencé par Hello().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

SMTP::StartTLS ( )

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 public

Renvoie:
bool success

Références get_lines(), et null.

+ Voici le graphe d'appel pour cette fonction :

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

Implements from rfc 821: TURN <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503 public

Renvoie:
bool

Documentation des données membres

SMTP::$CRLF = "\r\n"
SMTP::$do_debug
SMTP::$do_verp = false
SMTP::$error
private

Référencé par getError().

SMTP::$helo_rply
private
SMTP::$smtp_conn
private
SMTP::$SMTP_PORT = 25

Référencé par Connect().

SMTP::$Version = '5.2.1'
La documentation de cette classe a été générée à partir du fichier suivant :