Fat-Free Framework  3.3.0  Overview Class List Hierarchy
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
SMTP Class Reference

SMTP plug-in. More...

+ Inheritance diagram for SMTP:

Public Member Functions

 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 log ()
 
 attach ($file)
 
 send ($message, $log=TRUE)
 
 __construct ($host, $port, $scheme, $user, $pw)
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 

Public Attributes

 $attachments
 E-mail attachments.
 
 $host
 SMTP host.
 
 $port
 SMTP port.
 
 $scheme
 TLS/SSL.
 
 $user
 User ID.
 
 $pw
 Password.
 
 $socket
 TCP/IP socket.
 
 $log
 Server-client conversation.
 
const E_Header ='%s: header is required'
 
const E_Blank ='Message must not be blank'
 
const E_Attach ='Attachment %s not found'
 

Protected Member Functions

 fixheader ($key)
 
 dialog ($cmd=NULL, $log=TRUE)
 

Protected Attributes

 $headers
 Message properties.
 

Detailed Description

SMTP plug-in.

Constructor & Destructor Documentation

SMTP::__construct (   $host,
  $port,
  $scheme,
  $user,
  $pw 
)

Instantiate class

Parameters
$hoststring
$portint
$schemestring
$userstring
$pwstring

Member Function Documentation

SMTP::attach (   $file)

Add e-mail attachment

Returns
NULL
Parameters
$file
SMTP::clear (   $key)

Remove header

Returns
NULL
Parameters
$keystring
SMTP::dialog (   $cmd = NULL,
  $log = TRUE 
)
protected

Send SMTP command and record server response

Returns
string
Parameters
$cmdstring
$logbool
SMTP::exists (   $key)

Return TRUE if header exists

Returns
bool
Parameters
$key
SMTP::fixheader (   $key)
protected

Fix header

Returns
string
Parameters
$keystring
SMTP::get (   $key)

Return value of e-mail header

Returns
string|NULL
Parameters
$keystring
SMTP::log ( )

Return client-server conversation history

Returns
string
SMTP::send (   $message,
  $log = TRUE 
)

Transmit message

Returns
bool
Parameters
$messagestring
$logbool
SMTP::set (   $key,
  $val 
)

Bind value to e-mail header

Returns
string
Parameters
$keystring
$valstring

The documentation for this class was generated from the following file: