• Home
  • Horde_Mail_Autoconfig

PHP Class Horde_Mail_Autoconfig, horde

Author: Michael Slusarz ([email protected])
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_driverlist array Drivers. Shared between all instances.
$_drivers array Driver list.

Public Methods

Method Description
__construct ( array $opts = [] ) Constructor.
_getConfig ( string $type, string $email, array $opts ) : mixed Determine autoconfiguration details.
getDrivers ( ) : array Load the list of drivers.
getMailConfig ( string $email, array $opts = [] ) : Horde_Mail_Autoconfig_Server Determine the configuration for a message storage access server (i.e.
getMsaConfig ( string $email, array $opts = [] ) : Horde_Mail_Autoconfig_Server Determine the configuration for a message submission agent (MSA).

Protected Methods

Method Description
_parseEmail ( string $email ) : array Parse e-mail input.

Method Details

__construct() public method

Constructor.
public __construct ( array $opts = [] )
$opts array Configuration options: - drivers: (array) Use this list of drivers instead of the default autodetected list of drivers contained in this package.

_getConfig() public method

Determine autoconfiguration details.
public _getConfig ( string $type, string $email, array $opts ) : mixed
$type string The type of driver search to do.
$email string An e-mail address.
$opts array Options (see getMsaConfig() and getMailConfig()).
return mixed See getMsaConfig() and getMailConfig().

_parseEmail() protected method

Parse e-mail input.
protected _parseEmail ( string $email ) : array
$email string An e-mail address.
return array The email object and a list of (sub)domains.

getDrivers() public static method

Load the list of drivers.
public static getDrivers ( ) : array
return array

getMailConfig() public method

IMAP and/or POP3 server).
public getMailConfig ( string $email, array $opts = [] ) : Horde_Mail_Autoconfig_Server
$email string An e-mail address.
$opts 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.
return Horde_Mail_Autoconfig_Server The server object to use, or false if no server could be found.

getMsaConfig() public method

Determine the configuration for a message submission agent (MSA).
public getMsaConfig ( string $email, array $opts = [] ) : Horde_Mail_Autoconfig_Server
$email string An e-mail address.
$opts 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.
return Horde_Mail_Autoconfig_Server The server object to use, or false if no server could be found.

Property Details

$_driverlist protected static property

Drivers. Shared between all instances.
protected static array $_driverlist
return array

$_drivers protected property

Driver list.
protected array $_drivers
return array