Docs For Class smtp

Description

Located in /classes/mail/smtp.class.php (line 33)

Variable Summary

mixed $auth

mixed $authenticated

mixed $body

mixed $connection

mixed $errors

mixed $from

mixed $headers

mixed $helo

mixed $host

mixed $pass

mixed $port

mixed $recipients

mixed $status

mixed $timeout

mixed $user

Method Summary

smtp smtp ([mixed $params = array()])

void auth ()

void &connect ([mixed $params = array()])

void data ()

void ehlo ()

void &get_data ()

void helo ()

void is_connected ()

void mail (mixed $from)

void quit ()

void rcpt (mixed $to)

void rset ()

void send ([mixed $params = array()])

void send_data (mixed $data)

void set (mixed $var, mixed $value)

Variables

mixed $auth (line 47)

mixed $authenticated (line 35)

mixed $body (line 42)

mixed $connection (line 36)

mixed $errors (line 40)

mixed $from (line 43)

mixed $headers (line 38)

mixed $helo (line 46)

mixed $host (line 44)

mixed $pass (line 49)

mixed $port (line 45)

mixed $recipients (line 37)

mixed $status (line 41)

mixed $timeout (line 39)

mixed $user (line 48)

Methods

Constructor smtp (line 67)

Constructor function. Arguments: $params - An assoc array of parameters:

host - The hostname of the smtp server Default: localhost port - The port the smtp server runs on Default: 25 helo - What to send as the HELO command Default: localhost (typically the hostname of the machine this script runs on) auth - Whether to use basic authentication Default: FALSE user - Username for authentication Default: <blank> pass - Password for authentication Default: <blank> timeout - The timeout in seconds for the call Default: 5 to fsockopen()

smtp smtp ([mixed $params = array()])

auth (line 255)

Function to implement AUTH cmd

void auth ()

connect (line 97)

Connect function. This will, when called

statically, create a new smtp object, call the connect function (ie this function) and return it. When not called statically, it will connect to the server and send the HELO command.

void &connect ([mixed $params = array()])

data (line 311)

Function that sends the DATA cmd

void data ()

ehlo (line 202)

Function to implement EHLO cmd

void ehlo ()

get_data (line 352)

Function to get data.

void &get_data ()

helo (line 185)

Function to implement HELO cmd

void helo ()

is_connected (line 330)

Function to determine if this object is connected to the server or not.

void is_connected ()

mail (line 277)

Function that handles the MAIL FROM: cmd

void mail (mixed $from)

quit (line 236)

Function to implement QUIT cmd

void quit ()

rcpt (line 293)

Function that handles the RCPT TO: cmd

void rcpt (mixed $to)

rset (line 219)

Function to implement RSET cmd

void rset ()

send (line 138)

Function which handles sending the mail.

Arguments: $params - Optional assoc array of parameters. Can contain: recipients - Indexed array of recipients from - The from address. (used in MAIL FROM:), this will be the return path headers - Indexed array of headers, one header per array entry body - The body of the email It can also contain any of the parameters from the connect() function

void send ([mixed $params = array()])

send_data (line 339)

Function to send a bit of data

void send_data (mixed $data)

set (line 374)

Sets a variable

void set (mixed $var, mixed $value)