Fat-Free Framework
3.1.0 API Reference
|
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) | |
__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=FALSE) | |
Detailed Description
SMTP plug-in.
Constructor & Destructor Documentation
SMTP::__construct | ( | $host, | |
$port, | |||
$scheme, | |||
$user, | |||
$pw | |||
) |
Instantiate class
- Parameters
-
$host string $port int $scheme string $user string $pw string
Member Function Documentation
SMTP::attach | ( | $file) |
Add e-mail attachment
- Returns
- NULL
- Parameters
-
$file
SMTP::clear | ( | $key) |
Remove header
- Returns
- NULL
- Parameters
-
$key string
|
protected |
Send SMTP command and record server response
- Returns
- NULL
- Parameters
-
$cmd string $log bool
SMTP::exists | ( | $key) |
Return TRUE if header exists
- Returns
- bool
- Parameters
-
$key
|
protected |
Fix header
- Returns
- string
- Parameters
-
$key string
SMTP::get | ( | $key) |
Return value of e-mail header
- Returns
- string|NULL
- Parameters
-
$key string
SMTP::log | ( | ) |
Return client-server conversation history
- Returns
- string
SMTP::send | ( | $message) |
Transmit message
- Returns
- bool
- Parameters
-
$message string
SMTP::set | ( | $key, | |
$val | |||
) |
Bind value to e-mail header
- Returns
- string
- Parameters
-
$key string $val string
The documentation for this class was generated from the following file:
- smtp.php
Generated on Mon Aug 19 2013 21:27:51 for Fat-Free Framework by 1.8.4