API Documentation
\

\Horde_Mail_Autoconfig

Object to perform autodetermination of mail configuration parameters.

Summary

Methods
Properties
Constants
getDrivers()
__construct()
getMsaConfig()
getMailConfig()
_getConfig()
No public properties found
No constants found
_parseEmail()
$_driverlist
$_drivers
N/A
No private methods found
No private properties found
N/A

Properties

$_driverlist

$_driverlist : array

Drivers. Shared between all instances.

Type

array

$_drivers

$_drivers : array

Driver list.

Type

array

Methods

getDrivers()

getDrivers() : array

Load the list of drivers.

Returns

array

__construct()

__construct(array  $opts = array())

Constructor.

Parameters

array $opts

Configuration options:

  • drivers: (array) Use this list of drivers instead of the default autodetected list of drivers contained in this package.

getMsaConfig()

getMsaConfig(string  $email, array  $opts = array()) : \Horde_Mail_Autoconfig_Server

Determine the configuration for a message submission agent (MSA).

Parameters

string $email

An e-mail address.
array $opts

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.

Throws

\Horde_Mail_Autoconfig_Exception

Returns

\Horde_Mail_Autoconfig_Server —

The server object to use, or false if no server could be found.

getMailConfig()

getMailConfig(string  $email, array  $opts = array()) : \Horde_Mail_Autoconfig_Server

Determine the configuration for a message storage access server (i.e.

IMAP and/or POP3 server).

Parameters

string $email

An e-mail address.
array $opts

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.

Throws

\Horde_Mail_Autoconfig_Exception

Returns

\Horde_Mail_Autoconfig_Server —

The server object to use, or false if no server could be found.

_getConfig()

_getConfig(string  $type, string  $email, array  $opts) : mixed

Determine autoconfiguration details.

Parameters

string $type

The type of driver search to do.
string $email

An e-mail address.
array $opts

Options (see getMsaConfig() and getMailConfig()).

Throws

\Horde_Mail_Autoconfig_Exception

Returns

mixed —

See getMsaConfig() and getMailConfig().

_parseEmail()

_parseEmail(string  $email) : array

Parse e-mail input.

Parameters

string $email

An e-mail address.

Throws

\Horde_Mail_Autoconfig_Exception

Returns

array —

The email object and a list of (sub)domains.