Horde_Mail_Autoconfig
in package
Object to perform autodetermination of mail configuration parameters.
Tags
Table of Contents
- $_driverlist : array<string|int, mixed>
- Drivers. Shared between all instances.
- $_drivers : array<string|int, mixed>
- Driver list.
- __construct() : mixed
- Constructor.
- _getConfig() : mixed
- Determine autoconfiguration details.
- getDrivers() : array<string|int, mixed>
- Load the list of drivers.
- getMailConfig() : Horde_Mail_Autoconfig_Server
- Determine the configuration for a message storage access server (i.e.
- getMsaConfig() : Horde_Mail_Autoconfig_Server
- Determine the configuration for a message submission agent (MSA).
- _parseEmail() : array<string|int, mixed>
- Parse e-mail input.
Properties
$_driverlist
Drivers. Shared between all instances.
protected
static array<string|int, mixed>
$_driverlist
$_drivers
Driver list.
protected
array<string|int, mixed>
$_drivers
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $opts = array() ]) : mixed
Parameters
- $opts : array<string|int, mixed> = array()
-
Configuration options:
- drivers: (array) Use this list of drivers instead of the default autodetected list of drivers contained in this package.
Return values
mixed —_getConfig()
Determine autoconfiguration details.
public
_getConfig(string $type, string $email, array<string|int, mixed> $opts) : mixed
Parameters
- $type : string
-
The type of driver search to do.
- $email : string
-
An e-mail address.
- $opts : array<string|int, mixed>
-
Options (see getMsaConfig() and getMailConfig()).
Tags
Return values
mixed —See getMsaConfig() and getMailConfig().
getDrivers()
Load the list of drivers.
public
static getDrivers() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMailConfig()
Determine the configuration for a message storage access server (i.e.
public
getMailConfig(string $email[, array<string|int, mixed> $opts = array() ]) : Horde_Mail_Autoconfig_Server
IMAP and/or POP3 server).
Parameters
- $email : string
-
An e-mail address.
- $opts : array<string|int, mixed> = array()
-
Additional options:
- auth: (mixed) If set, will perform additional check to verify that user can authenticate to server. Either a string (password) or a Horde_Smtp_Password object.
- insecure: (boolean) If true and checking authentication, will allow non-secure authentication types.
- no_imap: (boolean) If true, will not autoconfig IMAP servers.
- no_pop3: (boolean) If true, will not autoconfig POP3 servers.
Tags
Return values
Horde_Mail_Autoconfig_Server —The server object to use, or false if no server could be found.
getMsaConfig()
Determine the configuration for a message submission agent (MSA).
public
getMsaConfig(string $email[, array<string|int, mixed> $opts = array() ]) : Horde_Mail_Autoconfig_Server
Parameters
- $email : string
-
An e-mail address.
- $opts : array<string|int, mixed> = array()
-
Additional options:
- auth: (mixed) If set, will perform additional check to verify that user can authenticate to server. Either a string (password) or a Horde_Smtp_Password object.
- insecure: (boolean) If true and checking authentication, will allow non-secure authentication types.
Tags
Return values
Horde_Mail_Autoconfig_Server —The server object to use, or false if no server could be found.
_parseEmail()
Parse e-mail input.
protected
_parseEmail(string $email) : array<string|int, mixed>
Parameters
- $email : string
-
An e-mail address.
Tags
Return values
array<string|int, mixed> —The email object and a list of (sub)domains.