CAS_ProxiedService_Imap Class Reference

Provides access to a proxy-authenticated IMAP stream. More...

Inheritance diagram for CAS_ProxiedService_Imap:

Collaboration diagram for CAS_ProxiedService_Imap:

Public Member Functions
	__construct ($username)
	Constructor. More...
	getServiceUrl ()
	Answer a service identifier (URL) for whom we should fetch a proxy ticket. More...
	setServiceUrl ($url)
	Set the URL of the service to pass to CAS for proxy-ticket retrieval. More...
	setMailbox ($mailbox)
	Set the mailbox to open. More...
	setOptions ($options)
	Set the options for opening the stream. More...
	open ()
	Open the IMAP stream (similar to imap_open()). More...
	getStream ()
	Answer the IMAP stream. More...
	getImapProxyTicket ()
	CAS_Client::serviceMail() needs to return the proxy ticket for some reason, so this method provides access to it. More...
Public Member Functions inherited from CAS_ProxiedService_Abstract
	setProxyTicket ($proxyTicket)
	Register a proxy ticket with the Proxy that it can use when making requests. More...
	setCasClient (CAS_Client $casClient)
	Use a particular CAS_Client->initializeProxiedService() rather than the static phpCAS::initializeProxiedService(). More...
Public Member Functions inherited from CAS_ProxiedService
	getServiceUrl ()
	Answer a service identifier (URL) for whom we should fetch a proxy ticket. More...
	setProxyTicket ($proxyTicket)
	Register a proxy ticket with the ProxiedService that it can use when making requests. More...

Protected Member Functions
	hasBeenOpened ()
	Answer true if our request has been sent yet. More...
Protected Member Functions inherited from CAS_ProxiedService_Abstract
	getProxyTicket ()
	Answer the proxy ticket to be used when making requests. More...
	initializeProxyTicket ()
	Fetch our proxy ticket. More...

Private Attributes
	$_username
	The username to send via imap_open. More...
	$_url
	The target service url. More...
	$_mailbox
	The mailbox to open. More...
	$_options = null
	A bit mask of options to pass to imap_open() as the $options parameter. More...
	$_stream
	The IMAP stream. More...

Detailed Description

Provides access to a proxy-authenticated IMAP stream.

Definition at line 40 of file Imap.php.

Constructor & Destructor Documentation

__construct()

CAS_ProxiedService_Imap::__construct

(

$username

)

Constructor.

Parameters

string

$username

Username

Returns

void

Definition at line 57 of file Imap.php.

    {
        if (!is_string($username) || !strlen($username)) {
            throw new CAS_InvalidArgumentException('Invalid username.');
        }

        $this->_username = $username;
    }

Member Function Documentation

getImapProxyTicket()

CAS_ProxiedService_Imap::getImapProxyTicket

(

)

CAS_Client::serviceMail() needs to return the proxy ticket for some reason, so this method provides access to it.

Returns

string

Exceptions

CAS_OutOfSequenceException

If called before the stream has been opened.

Definition at line 271 of file Imap.php.

    {
        if (!$this->hasBeenOpened()) {
            throw new CAS_OutOfSequenceException(
                'Cannot access errors, stream not opened yet.'
            );
        }
        return $this->getProxyTicket();
    }

getServiceUrl()

CAS_ProxiedService_Imap::getServiceUrl

(

)

Answer a service identifier (URL) for whom we should fetch a proxy ticket.

Returns

string

Exceptions

Exception

If no service url is available.

Definition at line 78 of file Imap.php.

References $_url.

    {
        if (empty($this->_url)) {
            throw new CAS_ProxiedService_Exception(
                'No URL set via ' . get_class($this) . '->getServiceUrl($url).'
            );
        }

        return $this->_url;
    }

getStream()

CAS_ProxiedService_Imap::getStream

(

)

Answer the IMAP stream.

Returns

resource

Definition at line 253 of file Imap.php.

    {
        if (!$this->hasBeenOpened()) {
            throw new CAS_OutOfSequenceException(
                'Cannot access stream, not opened yet.'
            );
        }
        return $this->_stream;
    }

hasBeenOpened()

CAS_ProxiedService_Imap::hasBeenOpened ( )

protected

Answer true if our request has been sent yet.

Returns

bool

Definition at line 233 of file Imap.php.

Referenced by open(), setMailbox(), setOptions(), and setServiceUrl().

    {
        return !empty($this->_stream);
    }

Here is the caller graph for this function:

open()

CAS_ProxiedService_Imap::open

(

)

Open the IMAP stream (similar to imap_open()).

Returns

resource Returns an IMAP stream on success

Exceptions

CAS_OutOfSequenceException	If called multiple times.
CAS_ProxyTicketException	If there is a proxy-ticket failure. The code of the Exception will be one of: PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE PHPCAS_SERVICE_PT_FAILURE
CAS_ProxiedService_Exception	If there is a failure sending the request to the target service.

Definition at line 191 of file Imap.php.

References hasBeenOpened(), CAS_ProxiedService_Abstract\initializeProxyTicket(), phpCAS\trace(), and phpCAS\traceBegin().

    {
        if ($this->hasBeenOpened()) {
            throw new CAS_OutOfSequenceException('Stream already opened.');
        }
        if (empty($this->_mailbox)) {
            throw new CAS_ProxiedService_Exception(
                'You must specify a mailbox via ' . get_class($this)
                . '->setMailbox($mailbox)'
            );
        }

        phpCAS::traceBegin();

        // Get our proxy ticket and append it to our URL.
        $this->initializeProxyTicket();
        phpCAS::trace('opening IMAP mailbox `' . $this->_mailbox . '\'...');
        $this->_stream = @imap_open(
            $this->_mailbox,
            $this->_username,
            $this->getProxyTicket(),
            $this->_options
        );
        if ($this->_stream) {
            phpCAS::trace('ok');
        } else {
            phpCAS::trace('could not open mailbox');
            // @todo add localization integration.
            $message = 'IMAP Error: ' . $this->_url . ' ' . var_export(imap_errors(), true);
            phpCAS::trace($message);
            throw new CAS_ProxiedService_Exception($message);
        }

        phpCAS::traceEnd();
        return $this->_stream;
    }

Here is the call graph for this function:

setMailbox()

CAS_ProxiedService_Imap::setMailbox

(

$mailbox

)

Set the mailbox to open.

See the $mailbox parameter of imap_open().

Parameters

string

$mailbox

Mailbox to set

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the stream has been opened.

Definition at line 130 of file Imap.php.

References hasBeenOpened().

    {
        if ($this->hasBeenOpened()) {
            throw new CAS_OutOfSequenceException(
                'Cannot set the mailbox, stream already opened.'
            );
        }
        if (!is_string($mailbox) || !strlen($mailbox)) {
            throw new CAS_InvalidArgumentException('Invalid mailbox.');
        }

        $this->_mailbox = $mailbox;
    }

Here is the call graph for this function:

setOptions()

CAS_ProxiedService_Imap::setOptions

(

$options

)

Set the options for opening the stream.

See the $options parameter of imap_open().

Parameters

int

$options

Options for the stream

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the stream has been opened.

Definition at line 160 of file Imap.php.

References PHPMailer\PHPMailer\$options, and hasBeenOpened().

    {
        if ($this->hasBeenOpened()) {
            throw new CAS_OutOfSequenceException(
                'Cannot set options, stream already opened.'
            );
        }
        if (!is_int($options)) {
            throw new CAS_InvalidArgumentException('Invalid options.');
        }

        $this->_options = $options;
    }

Here is the call graph for this function:

setServiceUrl()

CAS_ProxiedService_Imap::setServiceUrl

(

$url

)

Set the URL of the service to pass to CAS for proxy-ticket retrieval.

Parameters

string

$url

Url to set

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the stream has been opened.

Definition at line 101 of file Imap.php.

References $url, and hasBeenOpened().

    {
        if ($this->hasBeenOpened()) {
            throw new CAS_OutOfSequenceException(
                'Cannot set the URL, stream already opened.'
            );
        }
        if (!is_string($url) || !strlen($url)) {
            throw new CAS_InvalidArgumentException('Invalid url.');
        }

        $this->_url = $url;
    }

Here is the call graph for this function:

Field Documentation

$_mailbox

string CAS_ProxiedService_Imap::$_mailbox

private

The mailbox to open.

See the $mailbox parameter of imap_open().

Definition at line 120 of file Imap.php.

$_options

int CAS_ProxiedService_Imap::$_options = null

private

A bit mask of options to pass to imap_open() as the $options parameter.

Definition at line 149 of file Imap.php.

$_stream

resource CAS_ProxiedService_Imap::$_stream

private

The IMAP stream.

Definition at line 246 of file Imap.php.

$_url

string CAS_ProxiedService_Imap::$_url

private

The target service url.

Definition at line 70 of file Imap.php.

Referenced by getServiceUrl().

$_username

string CAS_ProxiedService_Imap::$_username

private

The username to send via imap_open.

Definition at line 48 of file Imap.php.

---

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

• Services/CAS/lib/CAS/ProxiedService/Imap.php