API Documentation

Zend/Mail/Protocol/Pop3.php

Show: inherited
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 license@zend.com 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: Pop3.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Protocol_Pop3

Package: Zend\Mail\Protocol

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  TIMEOUT_CONNECTION = 30

Default timeout in seconds for initiating session

Properties

Propertyprotectednull|resource  $_socket= ''

socket to pop3

Details
Type
nullresource
Propertyprotectednull|string  $_timestamp= ''

greeting timestamp for apop

Details
Type
nullstring
Propertypublicnull|bool  $hasTop= 'null'

saves if server supports top

Default valuenullDetails
Type
nullbool

Methods

methodpublic__construct( string $host = '', int|null $port = null, bool|string $ssl = false ) : void

Public constructor

Parameters
Name Type Description
$host string

hostname or IP address of POP3 server, if given connect() is called

$port int|null

port of POP3 server, null for default (110 or 995 for ssl)

$ssl bool|string

use ssl? 'SSL', 'TLS' or false

Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublic__destruct( ) : void

Public destructor

methodpubliccapa( ) : array

Get capabilities from POP3 server

Returns
Type Description
array list of capabilities
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicconnect( string $host, int|null $port = null, string|bool $ssl = false ) : string

Open connection to POP3 server

Parameters
Name Type Description
$host string

hostname or IP address of POP3 server

$port int|null

of POP3 server, default is 110 (995 for ssl)

$ssl string|bool

use 'SSL', 'TLS' or false

Returns
Type Description
string welcome message
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicdelete(  $msgno ) : null

Make a DELE count to remove a message

Parameters
Name Type Description
$msgno
Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicgetList( int|null $msgno = null ) : int|array

Make LIST call for size of message(s)

Parameters
Name Type Description
$msgno int|null

number of message, null for all

Returns
Type Description
int|array size of given message or list with array(num => size)
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpubliclogin( string $user, string $password,  $tryApop = true ) : void

Login to POP3 server. Can use APOP

Parameters
Name Type Description
$user string

username

$password string

password

$tryApop
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpubliclogout( ) : null

End communication with POP3 server (also closes socket)

Returns
Type Description
null
methodpublicnoop( ) : null

Make a NOOP call, maybe needed for keeping the server happy

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicreadResponse( boolean $multiline = false ) : string

read a response

Parameters
Name Type Description
$multiline boolean

response has multiple lines and should be read until "."

Returns
Type Description
string response
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicrequest( string $request, bool $multiline = false ) : string

Send request and get resposne

Parameters
Name Type Description
$request string

request

$multiline bool

multiline response?

Returns
Type Description
string result from readResponse()
Throws
Exception Description
\Zend_Mail_Protocol_Exception
Details
See
\sendRequest(),  
methodpublicretrieve( int $msgno ) : string

Make a RETR call for retrieving a full message with headers and body

Parameters
Name Type Description
$msgno int

message number

Returns
Type Description
string message
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicretrive( int $msgno ) : string

Make a RETR call for retrieving a full message with headers and body

Parameters
Name Type Description
$msgno int

message number

Returns
Type Description
string message
Throws
Exception Description
\Zend_Mail_Protocol_Exception
Details
Deprecated
since 1.1.0; this method has a typo - please use retrieve()  
methodpublicsendRequest( string $request ) : null

Send a request

Parameters
Name Type Description
$request string

your request without newline

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicstatus( int $messages, int $octets ) : void

Make STAT call for message count and size sum

Parameters
Name Type Description
$messages int

out parameter with count of messages

$octets int

out parameter with size in octects of messages

Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublictop( int $msgno, int $lines = 0, bool $fallback = false ) : string

Make TOP call for getting headers and maybe some body lines This method also sets hasTop - before it it's not known if top is supported

The fallback makes normale RETR call, which retrieves the whole message. Additional lines are not removed.

Parameters
Name Type Description
$msgno int

number of message

$lines int

number of wanted body lines (empty line is inserted after header lines)

$fallback bool

fallback with full retrieve if top is not supported

Returns
Type Description
string message headers with wanted body lines
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicundelete( ) : null

Make RSET call, which rollbacks delete requests

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicuniqueid( int|null $msgno = null ) : string|array

Make UIDL call for getting a uniqueid

Parameters
Name Type Description
$msgno int|null

number of message, null for all

Returns
Type Description
string|array uniqueid of message or list with array(num => uniqueid)
Throws
Exception Description
\Zend_Mail_Protocol_Exception
Documentation was generated by DocBlox 0.15.1.