Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/auth/cas/CAS/CAS/ProxiedService/ -> Imap.php (source)

[Source view]

Licensed to Jasig under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Jasig licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

Author: Adam Franco <afranco@middlebury.edu>
License: http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
File Size: 281 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CAS_ProxiedService_Imap:: (9 methods):
  __construct()
  getServiceUrl()
  setServiceUrl()
  setMailbox()
  setOptions()
  open()
  hasBeenOpened()
  getStream()
  getImapProxyTicket()


Class: CAS_ProxiedService_Imap  - X-Ref

Provides access to a proxy-authenticated IMAP stream

__construct($username)   X-Ref
Constructor.

param: string $username Username
return: void

getServiceUrl()   X-Ref
Answer a service identifier (URL) for whom we should fetch a proxy ticket.

return: string

setServiceUrl($url)   X-Ref
Set the URL of the service to pass to CAS for proxy-ticket retrieval.

param: string $url Url to set
return: void

setMailbox($mailbox)   X-Ref
Set the mailbox to open. See the $mailbox parameter of imap_open().

param: string $mailbox Mailbox to set
return: void

setOptions($options)   X-Ref
Set the options for opening the stream. See the $options parameter of
imap_open().

param: int $options Options for the stream
return: void

open()   X-Ref
Open the IMAP stream (similar to imap_open()).

return: resource Returns an IMAP stream on success

hasBeenOpened()   X-Ref
Answer true if our request has been sent yet.

return: bool

getStream()   X-Ref
Answer the IMAP stream

return: resource

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

return: string