Mail/Protocol/Smtp/Auth/Plain.php

Show:

inherited

Classes
- \Zend_Mail_Protocol_Smtp_Auth_Plain

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mail
Subpackage: Protocol
Version: $Id: Plain.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Mail_Protocol_Smtp_Auth_Plain
jump to top

Package: Zend\Mail\Protocol

Performs PLAIN authentication

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

Parent(s): \Zend_Mail_Protocol_Smtp < \Zend_Mail_Protocol_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                EOL
                = "\r\n"

inherited

Mail default EOL string

Inherited from: \Zend_Mail_Protocol_Abstract::EOL \Zend_Mail_Protocol_Smtp::EOL

Inherited_from: \Zend_Mail_Protocol_Abstract::EOL
Inherited_from: \Zend_Mail_Protocol_Smtp::EOL

 
                TIMEOUT_CONNECTION
                = 30

inherited

Default timeout in seconds for initiating session

Inherited from: \Zend_Mail_Protocol_Abstract::TIMEOUT_CONNECTION \Zend_Mail_Protocol_Smtp::TIMEOUT_CONNECTION

Inherited_from: \Zend_Mail_Protocol_Abstract::TIMEOUT_CONNECTION
Inherited_from: \Zend_Mail_Protocol_Smtp::TIMEOUT_CONNECTION

Properties

\unknown_type $_auth = false

inherited

Indicates an smtp AUTH has been issued and authenticated

Inherited from: \Zend_Mail_Protocol_Smtp::$$_auth

Default valuefalseDetails

Type: \unknown_type
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_auth

\unknown_type $_data = null

inherited

Indicates that DATA has been issued and sent

Inherited from: \Zend_Mail_Protocol_Smtp::$$_data

Default valuenullDetails

Type: \unknown_type
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_data

\unknown_type $_helo = false

inherited

Indicates the HELO command has been issues

Inherited from: \Zend_Mail_Protocol_Smtp::$$_helo

Default valuefalseDetails

Type: \unknown_type
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_helo

string $_host =

inherited

Hostname or IP address of remote server

Inherited from: \Zend_Mail_Protocol_Abstract::$$_host \Zend_Mail_Protocol_Smtp::$$_host

Details

Type: string
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_host
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_host

array $_log = array()

inherited

Log of mail requests and server responses for a session

Inherited from: \Zend_Mail_Protocol_Abstract::$$_log \Zend_Mail_Protocol_Smtp::$$_log

Default valuearray()Details

Type: array
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_log
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_log

\unknown_type $_mail = false

inherited

Indicates a MAIL command has been issued

Inherited from: \Zend_Mail_Protocol_Smtp::$$_mail

Default valuefalseDetails

Type: \unknown_type
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_mail

integer $_maximumLog = 64

inherited

Maximum of the transaction log

Inherited from: \Zend_Mail_Protocol_Abstract::$$_maximumLog \Zend_Mail_Protocol_Smtp::$$_maximumLog

Default value64Details

Type: integer
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_maximumLog
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_maximumLog

string $_password =

PLAIN password

Details

Type: string

integer $_port =

inherited

Port number of connection

Inherited from: \Zend_Mail_Protocol_Abstract::$$_port \Zend_Mail_Protocol_Smtp::$$_port

Details

Type: integer
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_port
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_port

\unknown_type $_rcpt = false

inherited

Indicates one or more RCTP commands have been issued

Inherited from: \Zend_Mail_Protocol_Smtp::$$_rcpt

Default valuefalseDetails

Type: \unknown_type
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_rcpt

string $_request =

inherited

Last request sent to server

Inherited from: \Zend_Mail_Protocol_Abstract::$$_request \Zend_Mail_Protocol_Smtp::$$_request

Details

Type: string
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_request
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_request

array $_response =

inherited

Array of server responses to last request

Inherited from: \Zend_Mail_Protocol_Abstract::$$_response \Zend_Mail_Protocol_Smtp::$$_response

Details

Type: array
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_response
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_response

string $_secure =

inherited

Indicates that a session is requested to be secure

Inherited from: \Zend_Mail_Protocol_Smtp::$$_secure

Details

Type: string
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_secure

boolean $_sess = false

inherited

Indicates an smtp session has been started by the HELO command

Inherited from: \Zend_Mail_Protocol_Smtp::$$_sess

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_sess

resource $_socket =

inherited

Socket connection resource

Inherited from: \Zend_Mail_Protocol_Abstract::$$_socket \Zend_Mail_Protocol_Smtp::$$_socket

Details

Type: resource
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_socket
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_socket

resource $_template = '%d%s'

inherited

String template for parsing server responses using sscanf (default: 3 digit code and response string)

Inherited from: \Zend_Mail_Protocol_Abstract::$$_template \Zend_Mail_Protocol_Smtp::$$_template

Default value'%d%s'Details

Type: resource
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_template
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_template

string $_transport = 'tcp'

inherited

The transport method for the socket

Inherited from: \Zend_Mail_Protocol_Smtp::$$_transport

Default value'tcp'Details

Type: string
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_transport

string $_username =

PLAIN username

Details

Type: string

\Zend_Validate $_validHost =

inherited

Instance of Zend_Validate to check hostnames

Inherited from: \Zend_Mail_Protocol_Abstract::$$_validHost \Zend_Mail_Protocol_Smtp::$$_validHost

Details

Type: \Zend_Validate
Inherited_from: \Zend_Mail_Protocol_Abstract::$$_validHost
Inherited_from: \Zend_Mail_Protocol_Smtp::$$_validHost

Methods

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

Constructor.

Parameters

Name	Type	Description
$host	string	(Default: 127.0.0.1)
$port	int	(Default: null)
$config	array	Auth-specific parameters

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

__destruct() : void

inherited

Class destructor to cleanup open resources

Inherited from: \Zend_Mail_Protocol_Abstract::__destruct()\Zend_Mail_Protocol_Smtp::__destruct()

_addLog(string $value) : void

inherited

Add the transaction log

Inherited from: \Zend_Mail_Protocol_Abstract::_addLog()\Zend_Mail_Protocol_Smtp::_addLog()

Parameters

Name	Type	Description
$value	string	new transaction

_connect(string $remote) : boolean

inherited

Connect to the server using the supplied transport and target

Inherited from: \Zend_Mail_Protocol_Abstract::_connect()\Zend_Mail_Protocol_Smtp::_connect()

An example $remote string may be 'tcp://mail.example.com:25' or 'ssh://hostname.com:2222'

Parameters

Name	Type	Description
$remote	string	Remote

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_disconnect() : void

inherited

Disconnect from remote host and free resource

Inherited from: \Zend_Mail_Protocol_Abstract::_disconnect()\Zend_Mail_Protocol_Smtp::_disconnect()

_ehlo(string $host) : void

inherited

Send EHLO or HELO depending on capabilities of smtp host

Inherited from: \Zend_Mail_Protocol_Smtp::_ehlo()

Parameters

Name	Type	Description
$host	string	The client hostname or IP address (default: 127.0.0.1)

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_expect(string | array $code, $timeout = null) : string

inherited

Parse server response for successful codes

Inherited from: \Zend_Mail_Protocol_Abstract::_expect()\Zend_Mail_Protocol_Smtp::_expect()

Read the response from the stream and check for expected return code. Throws a Zend_Mail_Protocol_Exception if an unexpected code is returned.

Parameters

Name	Type	Description
$code	string \| array	One or more codes that indicate a successful response
$timeout

Returns

Type	Description
string	Last line of response string

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_receive( $timeout = null) : string

inherited

Get a line from the stream.

Inherited from: \Zend_Mail_Protocol_Abstract::_receive()\Zend_Mail_Protocol_Smtp::_receive()

Parameters

Name	Type	Description
$timeout

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

Details

: integer
Per-request timeout value if applicable

_send(string $request) : integer | boolean

inherited

Send the given request followed by a LINEEND to the server.

Inherited from: \Zend_Mail_Protocol_Abstract::_send()\Zend_Mail_Protocol_Smtp::_send()

Parameters

Name	Type	Description
$request	string

Returns

Type	Description
integer \| boolean	Number of bytes written to remote host

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

_setStreamTimeout(integer $timeout) : boolean

inherited

Set stream timeout

Inherited from: \Zend_Mail_Protocol_Abstract::_setStreamTimeout()\Zend_Mail_Protocol_Smtp::_setStreamTimeout()

Parameters

Name	Type	Description
$timeout	integer

Returns

Type	Description
boolean

_startSession() : void

inherited

Start mail session

Inherited from: \Zend_Mail_Protocol_Smtp::_startSession()

_stopSession() : void

inherited

Stop mail session

Inherited from: \Zend_Mail_Protocol_Smtp::_stopSession()

auth() : void

Perform PLAIN authentication with supplied credentials

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

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

connect() : boolean

inherited

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

Inherited from: \Zend_Mail_Protocol_Smtp::connect()

Concrete adapters for this class will implement their own unique connect scripts, using the _connect() method to create the socket resource.

Returns

Type	Description
boolean

data(string $data) : void

inherited

Issues DATA command

Inherited from: \Zend_Mail_Protocol_Smtp::data()

Parameters

Name	Type	Description
$data	string

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

disconnect() : void

inherited

Closes connection

Inherited from: \Zend_Mail_Protocol_Smtp::disconnect()

getLog() : string

inherited

Retrieve the transaction log

Inherited from: \Zend_Mail_Protocol_Abstract::getLog()\Zend_Mail_Protocol_Smtp::getLog()

Returns

Type	Description
string

getMaximumLog() : int

inherited

Get the maximum log size

Inherited from: \Zend_Mail_Protocol_Abstract::getMaximumLog()\Zend_Mail_Protocol_Smtp::getMaximumLog()

Returns

Type	Description
int	the maximum log size

getRequest() : string

inherited

Retrieve the last client request

Inherited from: \Zend_Mail_Protocol_Abstract::getRequest()\Zend_Mail_Protocol_Smtp::getRequest()

Returns

Type	Description
string

getResponse() : array

inherited

Retrieve the last server response

Inherited from: \Zend_Mail_Protocol_Abstract::getResponse()\Zend_Mail_Protocol_Smtp::getResponse()

Returns

Type	Description
array

helo(string $host = '127.0.0.1') : void

inherited

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

Inherited from: \Zend_Mail_Protocol_Smtp::helo()

Parameters

Name	Type	Description
$host	string	The client hostname or IP address (default: 127.0.0.1)

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

mail(string $from) : void

inherited

Issues MAIL command

Inherited from: \Zend_Mail_Protocol_Smtp::mail()

Parameters

Name	Type	Description
$from	string	Sender mailbox

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

noop() : void

inherited

Issues the NOOP command and validates answer

Inherited from: \Zend_Mail_Protocol_Smtp::noop()

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

quit() : void

inherited

Issues the QUIT command and clears the current session

Inherited from: \Zend_Mail_Protocol_Smtp::quit()

rcpt(string $to) : void

inherited

Issues RCPT command

Inherited from: \Zend_Mail_Protocol_Smtp::rcpt()

Parameters

Name	Type	Description
$to	string	Receiver(s) mailbox

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

resetLog() : void

inherited

Reset the transaction log

Inherited from: \Zend_Mail_Protocol_Abstract::resetLog()\Zend_Mail_Protocol_Smtp::resetLog()

rset() : void

inherited

Issues the RSET command and validates answer

Inherited from: \Zend_Mail_Protocol_Smtp::rset()

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

setMaximumLog(integer $maximumLog) : void

inherited

Set the maximum log size

Inherited from: \Zend_Mail_Protocol_Abstract::setMaximumLog()\Zend_Mail_Protocol_Smtp::setMaximumLog()

Parameters

Name	Type	Description
$maximumLog	integer	Maximum log size

vrfy(string $user) : void

inherited

Issues the VRFY command and validates answer

Inherited from: \Zend_Mail_Protocol_Smtp::vrfy()

Not used by Zend_Mail.

Parameters

Name	Type	Description
$user	string	User Name or eMail to verify

Mail/Protocol/Smtp/Auth/Plain.php

\Zend_Mail_Protocol_Smtp_Auth_Plainjump to top

Constants

Properties

Methods

\Zend_Mail_Protocol_Smtp_Auth_Plain
jump to top