Horde_Mail_Autoconfig_Server_Imap
extends Horde_Mail_Autoconfig_Server
in package
Autoconfigured configuration details for an IMAP server (RFC 3501).
Tags
Table of Contents
- $host : string
- The server hostname (IDN encoded).
- $label : int
- The server label.
- $port : int
- Default IMAP port (RFC 3501 [2.1]).
- $tls : mixed
- TLS connection details.
- $username : string
- The username to use.
- valid() : bool
- Check to see if server can be connected to.
Properties
$host
The server hostname (IDN encoded).
public
string
$host
= \null
$label
The server label.
public
int
$label
= \null
$port
Default IMAP port (RFC 3501 [2.1]).
public
int
$port
= 143
$tls
TLS connection details.
public
mixed
$tls
= \null
'tls' = TLS needed for direct connection to server/port. 'starttls' = Switch to TLS via protocol after connection. false = No TLS connection used.
$username
The username to use.
public
string
$username
= \null
Methods
valid()
Check to see if server can be connected to.
public
valid([array<string|int, mixed> $opts = array() ]) : bool
Parameters
- $opts : array<string|int, mixed> = array()
-
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.
Return values
bool —True if server is valid.