API Documentation

Mail/Protocol/Smtp.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Protocol
version
$Id: Smtp.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Mail_Protocol_Smtp

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Mail_Protocol_Smtp
jump to top

Extends from
Zend_Mail_Protocol_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Protocol
Properties
$_transport
$_secure
$_sess
$_helo
$_auth
$_mail
$_rcpt
$_data
Methods
__construct
connect
helo
_ehlo
mail
rcpt
data
rset
noop
vrfy
quit
auth
disconnect
_startSession
_stopSession

Description

Smtp implementation of Zend_Mail_Protocol_Abstract

Minimum implementation according to RFC2821: EHLO, MAIL FROM, RCPT TO, DATA, RSET, NOOP, QUIT

Properties

$_auth
jump to class

unknown_type $_auth = 'false'

Indicates an smtp AUTH has been issued and authenticated

Details

$_auth
unknown_type
visibility
protected
default
false
final
false
static
false

$_data
jump to class

unknown_type $_data = 'null'

Indicates that DATA has been issued and sent

Details

$_data
unknown_type
visibility
protected
default
null
final
false
static
false

$_helo
jump to class

unknown_type $_helo = 'false'

Indicates the HELO command has been issues

Details

$_helo
unknown_type
visibility
protected
default
false
final
false
static
false

$_mail
jump to class

unknown_type $_mail = 'false'

Indicates a MAIL command has been issued

Details

$_mail
unknown_type
visibility
protected
default
false
final
false
static
false

$_rcpt
jump to class

unknown_type $_rcpt = 'false'

Indicates one or more RCTP commands have been issued

Details

$_rcpt
unknown_type
visibility
protected
default
false
final
false
static
false

$_secure
jump to class

string $_secure = ''

Indicates that a session is requested to be secure

Details

$_secure
string
visibility
protected
default
final
false
static
false

$_sess
jump to class

boolean $_sess = 'false'

Indicates an smtp session has been started by the HELO command

Details

$_sess
boolean
visibility
protected
default
false
final
false
static
false

$_transport
jump to class

string $_transport = 'tcp'

The transport method for the socket

Details

$_transport
string
visibility
protected
default
tcp
final
false
static
false

Methods

__construct
jump to class

__construct( string $host = 127.0.0.1, integer $port = null, array $config = array ) : void

Constructor.

Arguments
$host
string
$port
integer
$config
array
Details
visibility
public
final
false
static
false
throws

_ehlo
jump to class

_ehlo( string $host ) : void

Send EHLO or HELO depending on capabilities of smtp host

Arguments
$host
string
The client hostname or IP address (default: 127.0.0.1)
Details
visibility
protected
final
false
static
false
throws

_startSession
jump to class

_startSession( ) : void

Start mail session

Details
visibility
protected
final
false
static
false

_stopSession
jump to class

_stopSession( ) : void

Stop mail session

Details
visibility
protected
final
false
static
false

auth
jump to class

auth( ) : void

Default authentication method

This default method is implemented by AUTH adapters to properly authenticate to a remote host.

Details
visibility
public
final
false
static
false
throws

connect
jump to class

connect( ) : boolean

Connect to the server with the parameters given in the constructor.

Output
boolean
Details
visibility
public
final
false
static
false

data
jump to class

data( string $data ) : void

Issues DATA command

Arguments
$data
string
Details
visibility
public
final
false
static
false
throws

disconnect
jump to class

disconnect( ) : void

Closes connection

Details
visibility
public
final
false
static
false

helo
jump to class

helo( string $host = 127.0.0.1 ) : void

Initiate HELO/EHLO sequence and set flag to indicate valid smtp session

Arguments
$host
string
The client hostname or IP address (default: 127.0.0.1)
Details
visibility
public
final
false
static
false
throws

mail
jump to class

mail( string $from ) : void

Issues MAIL command

Arguments
$from
string
Sender mailbox
Details
visibility
public
final
false
static
false
throws

noop
jump to class

noop( ) : void

Issues the NOOP command end validates answer

Not used by Zend_Mail, could be used to keep a connection alive or check if it is still open.

Details
visibility
public
final
false
static
false

quit
jump to class

quit( ) : void

Issues the QUIT command and clears the current session

Details
visibility
public
final
false
static
false

rcpt
jump to class

rcpt( string $to ) : void

Issues RCPT command

Arguments
$to
string
Receiver(s) mailbox
Details
visibility
public
final
false
static
false
throws

rset
jump to class

rset( ) : void

Issues the RSET command end validates answer

Can be used to restore a clean smtp communication state when a transaction has been cancelled or commencing a new transaction.

Details
visibility
public
final
false
static
false

vrfy
jump to class

vrfy( string $user ) : void

Issues the VRFY command end validates answer

Not used by Zend_Mail.

Arguments
$user
string
User Name or eMail to verify
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.