API Documentation
\

\Horde_Mail_Autoconfig_Server_Imap

Autoconfigured configuration details for an IMAP server (RFC 3501).

Summary

Methods
Properties
Constants
valid()
$host
$port
$label
$tls
$username
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$host

$host : string

The server hostname (IDN encoded).

Type

string

$port

$port : integer

Default IMAP port (RFC 3501 [2.1]).

Type

integer

$label

$label : integer

The server label.

Type

integer

$tls

$tls : mixed

TLS connection details.

'tls' = TLS needed for direct connection to server/port. 'starttls' = Switch to TLS via protocol after connection. false = No TLS connection used.

Type

mixed

$username

$username : string

The username to use.

Type

string

Methods

valid()

valid(array  $opts = array()) : boolean

Check to see if server can be connected to.

Parameters

array $opts

Additional options:

  • auth: (mixed) The authentication credentials used to test a successful connection.
  • insecure: (boolean) If true, will attempt insecure authentication.
  • users: (array) A list of usernames to attempt if trying auth. If successful, the username will be stored in $username.

Returns

boolean —

True if server is valid.