Class CAS_ProxiedService_Imap

Provides access to a proxy-authenticated IMAP stream

CAS_ProxiedService_Abstract implements CAS_ProxiedService, CAS_ProxiedService_Testable

CAS_ProxiedService_Imap

Package: PhpCAS
Category: Authentication
License: Apache License 2.0
Author: Adam Franco afranco@middlebury.edu
Link: https://wiki.jasig.org/display/CASC/phpCAS
Class: CAS_ProxiedService_Imap
Located at shared/cas/source/CAS/ProxiedService/Imap.php

Methods summary
`public`	# `__construct( string $username )` Constructor. Constructor. Parameters `$username` Username
`public string`	# `getServiceUrl( )` Answer a service identifier (URL) for whom we should fetch a proxy ticket. Answer a service identifier (URL) for whom we should fetch a proxy ticket. Returns string Throws Exception If no service url is available.
`public`	# `setServiceUrl( string $url )` Set the URL of the service to pass to CAS for proxy-ticket retrieval. Set the URL of the service to pass to CAS for proxy-ticket retrieval. Parameters `$url` Url to set Throws `CAS_OutOfSequenceException` If called after the stream has been opened.
`public`	# `setMailbox( string $mailbox )` Set the mailbox to open. See the $mailbox parameter of imap_open(). Set the mailbox to open. See the $mailbox parameter of imap_open(). Parameters `$mailbox` Mailbox to set Throws `CAS_OutOfSequenceException` If called after the stream has been opened.
`public`	# `setOptions( integer $options )` Set the options for opening the stream. See the $options parameter of imap_open(). Set the options for opening the stream. See the $options parameter of imap_open(). Parameters `$options` Options for the stream Throws `CAS_OutOfSequenceException` If called after the stream has been opened.
`public resource`	# `open( )` Open the IMAP stream (similar to imap_open()). Open the IMAP stream (similar to imap_open()). Returns resource Returns an IMAP stream on success Throws `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.
`protected boolean`	# `hasBeenOpened( )` Answer true if our request has been sent yet. Answer true if our request has been sent yet. Returns boolean
`public resource`	# `getStream( )` Answer the IMAP stream Answer the IMAP stream Returns resource
`public string`	# `getImapProxyTicket( )` CAS_Client::serviceMail() needs to return the proxy ticket for some reason, so this method provides access to it. CAS_Client::serviceMail() needs to return the proxy ticket for some reason, so this method provides access to it. Returns string Throws `CAS_OutOfSequenceException` If called before the stream has been opened.

Methods inherited from CAS_ProxiedService_Abstract
`getProxyTicket(), initializeProxyTicket(), setCasClient(), setProxyTicket()`

Properties summary
`private string`	`$_username` The username to send via imap_open. The username to send via imap_open.	#
`private string`	`$_url` The target service url. The target service url.	#
`private string`	`$_mailbox` The mailbox to open. See the $mailbox parameter of imap_open(). The mailbox to open. See the $mailbox parameter of imap_open().	#
`private integer`	`$_options` A bit mask of options to pass to imap_open() as the $options parameter. A bit mask of options to pass to imap_open() as the $options parameter.	# `null`
`private resource`	`$_stream` The IMAP stream The IMAP stream	#

class-CAS_ProxiedService_Imap

Namespaces

Classes

Interfaces

Exceptions

Functions

Class CAS_ProxiedService_Imap

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Returns

Throws

Returns

Returns

Returns

Throws