File: imap.php

package info (click to toggle)
horde2 2.2.8-1sarge3
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,832 kB
  • ctags: 2,897
  • sloc: php: 12,784; sh: 954; sql: 149; makefile: 104; perl: 97; xml: 24; pascal: 6
file content (113 lines) | stat: -rw-r--r-- 3,171 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?php
/*
 * $Horde: horde/lib/Auth/imap.php,v 1.4.2.6 2004/06/24 08:07:07 jan Exp $
 *
 * Copyright 1999-2003 Chuck Hagenbuch <chuck@horde.org>
 * Copyright 1999-2003 Gaudenz Steinlin <gaudenz.steinlin@id.unibe.ch>
 *
 * See the enclosed file COPYING for license information (LGPL). If you
 * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
 */


Horde::functionCheck('imap_open', true,
    'Auth_imap: Required IMAP extension not found.');

/**
 * The Auth_imap class provides an IMAP implementation of the Horde
 * authentication system.
 *
 * Parameters:
 *  'hostspec'      The hostname or IP address of the server.
 *  'protocol'      The connection protocol (e.g. 'imap', 'pop3', 'nntp').
 *  'port'          The server port to which we will connect.
 *  'folder'        The initial folder / mailbox to open.
 *
 * @author  Chuck Hagenbuch <chuck@horde.org>
 * @author  Gaudenz Steinlin <gaudenz.steinlin@id.unibe.ch>
 * @version $Revision: 1.4.2.6 $
 * @since   Horde 1.3
 * @package horde.auth
 */
class Auth_imap extends Auth {

    /**
     * Hash containing connection parameters.
     * @var array $params
     */
    var $params = array();

    /**
     * Constructs a new IMAP authentication object.
     *
     * @param array $params   A hash containing connection parameters.
     */
    function Auth_imap($params = array())
    {
        $this->setParams($params);
    }

    /**
     * Take a hash and build the connection string out of it.
     *
     * @param array $params   A hash specifying an IMAP mailbox.
     */
    function setParams($params)
    {
        if (empty($params['dsn'])) {
            if (isset($params['hostspec'])) {
                $params['dsn'] = '{' . $params['hostspec'];
            } else {
                $params['dsn'] = '{localhost';
            }

            if (isset($params['protocol'])) {
                $params['dsn'] .= '/' . $params['protocol'];
            } else {
                $params['dsn'] .= '/imap';
            }

            if (isset($params['port'])) {
                $params['dsn'] .= ':' . $params['port'] . '}';
            } else {
                $params['dsn'] .= ':143}';
            }

            if (isset($params['folder'])) {
                $params['dsn'] .= $params['folder'];
            }
        }
        $this->params = $params;
    }

    /**
     * Find out if a set of login credentials are valid.
     *
     * @param string $userID       The userID to check.
     * @param array  $credentials  An array of login credentials. For IMAP,
     *                             this must contain a password entry.
     *
     * @return boolean Whether or not the credentials are valid.
     */
    function authenticate($userID, $credentials)
    {
        if (Auth::checkAuth($userID)) {
            return true;
        }

        $imap = @imap_open($this->params['dsn'], $userID,
                           $credentials['password'], OP_HALFOPEN);

        if ($imap) {
            @imap_close($imap);
            Auth::setAuth($userID, $credentials);
            return true;
        }

        @imap_close($imap);

        return false;
    }

}
?>