List of all members.
Detailed Description
Provides access to a proxy-authenticated IMAP stream
Definition at line 39 of file Imap.php.
Constructor & Destructor Documentation
CAS_ProxiedService_Imap::__construct |
( |
$ |
username |
) |
|
Constructor.
- Parameters:
-
- Returns:
- void
Definition at line 56 of file Imap.php.
Member Function Documentation
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:
-
Definition at line 228 of file Imap.php.
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 75 of file Imap.php.
CAS_ProxiedService_Imap::getStream |
( |
|
) |
|
Answer the IMAP stream
- Returns:
- resource
Definition at line 214 of file Imap.php.
CAS_ProxiedService_Imap::hasBeenOpened |
( |
|
) |
[protected] |
CAS_ProxiedService_Imap::open |
( |
|
) |
|
CAS_ProxiedService_Imap::setMailbox |
( |
$ |
mailbox |
) |
|
Set the mailbox to open. See the $mailbox parameter of imap_open().
- Parameters:
-
- Returns:
- void
- Exceptions:
-
Definition at line 116 of file Imap.php.
References hasBeenOpened().
CAS_ProxiedService_Imap::setOptions |
( |
$ |
options |
) |
|
Set the options for opening the stream. See the $options parameter of imap_open().
- Parameters:
-
- Returns:
- void
- Exceptions:
-
Definition at line 139 of file Imap.php.
References hasBeenOpened().
CAS_ProxiedService_Imap::setServiceUrl |
( |
$ |
url |
) |
|
Set the URL of the service to pass to CAS for proxy-ticket retrieval.
- Parameters:
-
- Returns:
- void
- Exceptions:
-
Definition at line 93 of file Imap.php.
References hasBeenOpened().
Member Data Documentation
string CAS_ProxiedService_Imap::$_mailbox [private] |
The mailbox to open. See the $mailbox parameter of imap_open().
Definition at line 107 of file Imap.php.
int CAS_ProxiedService_Imap::$_options = NULL [private] |
A bit mask of options to pass to imap_open() as the $options parameter.
Definition at line 130 of file Imap.php.
resource CAS_ProxiedService_Imap::$_stream [private] |
The IMAP stream
Definition at line 207 of file Imap.php.
string CAS_ProxiedService_Imap::$_url [private] |
The target service url.
Definition at line 67 of file Imap.php.
string CAS_ProxiedService_Imap::$_username [private] |
The username to send via imap_open.
Definition at line 48 of file Imap.php.