Joomla Platform
13.1
Documentation des API du framework Joomla Platform
|
Fonctions membres publiques | |
__construct () | |
Connect ($host, $port=0, $timeout=30, $options=array()) | |
StartTLS () | |
Authenticate ($username, $password, $authtype='LOGIN', $realm='', $workstation='') | |
Connected () | |
Close () | |
Data ($msg_data) | |
Hello ($host= '') | |
Mail ($from) | |
Quit ($close_on_error=true) | |
Recipient ($to) | |
Reset () | |
SendAndMail ($from) | |
Turn () | |
client_send ($data) | |
getError () |
Attributs publics | |
$SMTP_PORT = 25 | |
$CRLF = "\r\n" | |
$do_debug = 0 | |
$Debugoutput = 'echo' | |
$do_verp = false | |
$Timeout = 15 | |
$Timelimit = 30 | |
$Version = '5.2.6' |
Fonctions membres protégées | |
edebug ($str) | |
hmac ($data, $key) | |
SendHello ($hello, $host) | |
get_lines () |
Attributs protégés | |
$smtp_conn | |
$error | |
$helo_rply |
SMTP::__construct | ( | ) |
SMTP::Authenticate | ( | $username, | |
$password, | |||
$authtype = 'LOGIN' , |
|||
$realm = '' , |
|||
$workstation = '' |
|||
) |
Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated. public
string | $username | |
string | $password | |
string | $authtype | |
string | $realm | |
string | $workstation |
Définition à la ligne 272 du fichier smtp.php.
Références client_send(), edebug(), get_lines(), et hmac().
SMTP::client_send | ( | $data | ) |
Sends data to the server
string | $data | public |
Définition à la ligne 1021 du fichier smtp.php.
Références edebug().
Référencé par Authenticate(), Data(), Mail(), Quit(), Recipient(), Reset(), SendAndMail(), SendHello(), et StartTLS().
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
Définition à la ligne 528 du fichier smtp.php.
Référencé par Connected(), et Quit().
SMTP::Connect | ( | $host, | |
$port = 0 , |
|||
$timeout = 30 , |
|||
$options = array() |
|||
) |
Connect to an SMTP server
SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421 public
string | $host | SMTP server IP or host name |
int | $port | The port number to connect to, or use the default port if not specified |
int | $timeout | How long to wait for the connection to open |
array | $options | An array of options compatible with stream_context_create() |
Définition à la ligne 163 du fichier smtp.php.
Références $SMTP_PORT, edebug(), et get_lines().
SMTP::Connected | ( | ) |
Returns true if connected to a server otherwise false public
Définition à la ligne 505 du fichier smtp.php.
Références Close(), et edebug().
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 separated 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
string | $msg_data |
Définition à la ligne 562 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
|
protected |
Outputs debugging info via user-defined method
string | $str |
Définition à la ligne 118 du fichier smtp.php.
Référencé par Authenticate(), client_send(), Connect(), Connected(), Data(), get_lines(), Mail(), Quit(), Recipient(), Reset(), SendAndMail(), SendHello(), StartTLS(), et Turn().
|
protected |
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. protected
Définition à la ligne 1050 du fichier smtp.php.
Références $Timelimit, et edebug().
Référencé par Authenticate(), Connect(), Data(), Mail(), Quit(), Recipient(), Reset(), SendAndMail(), SendHello(), et StartTLS().
SMTP::getError | ( | ) |
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
string | $host |
Définition à la ligne 700 du fichier smtp.php.
Références SendHello().
|
protected |
Works like hash_hmac('md5', $data, $key) in case that function is not available protected
string | $data | |
string | $key |
Définition à la ligne 475 du fichier smtp.php.
Référencé par Authenticate().
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
string | $from |
Définition à la ligne 773 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
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
bool | $close_on_error |
Définition à la ligne 817 du fichier smtp.php.
Références client_send(), Close(), edebug(), et get_lines().
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
string | $to |
Définition à la ligne 871 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
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
Définition à la ligne 914 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
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
string | $from |
Définition à la ligne 962 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
|
protected |
Sends a HELO/EHLO command. protected
string | $hello | |
string | $host |
Définition à la ligne 732 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
Référencé par Hello().
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
Définition à la ligne 225 du fichier smtp.php.
Références client_send(), edebug(), et get_lines().
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
Définition à la ligne 1006 du fichier smtp.php.
Références edebug().
|
protected |
Définition à la ligne 108 du fichier smtp.php.
Référencé par getError().
SMTP::$Timelimit = 30 |
Définition à la ligne 89 du fichier smtp.php.
Référencé par get_lines().