Horde_Mail_Autoconfig_Driver
in package
Abstract class for implementing a mail configuration lookup driver.
Tags
Table of Contents
- $priority : int
- The priority of this driver. Lower values (0 minimum) indicate higher priority.
- mailSearch() : mixed
- Determine the configuration for a message storage access server.
- msaSearch() : mixed
- Determine the configuration for a message submission agent (MSA).
Properties
$priority
The priority of this driver. Lower values (0 minimum) indicate higher priority.
public
int
$priority
Methods
mailSearch()
Determine the configuration for a message storage access server.
public
abstract mailSearch(array<string|int, mixed> $domains[, array<string|int, mixed> $opts = array() ]) : mixed
Parameters
- $domains : array<string|int, mixed>
-
List of domains to search.
- $opts : array<string|int, mixed> = array()
-
Additional options:
- email: (Horde_Mail_Rfc822_Address) The original e-mail provided.
- no_imap: (boolean) If true, ignore IMAP servers.
- no_pop3: (boolean) If true, ignore POP3 servers.
Tags
Return values
mixed —False if no servers found, or a list of server objects in order of decreasing priority.
msaSearch()
Determine the configuration for a message submission agent (MSA).
public
abstract msaSearch(array<string|int, mixed> $domains[, array<string|int, mixed> $opts = array() ]) : mixed
Parameters
- $domains : array<string|int, mixed>
-
List of domains to search.
- $opts : array<string|int, mixed> = array()
-
Additional options:
- email: (Horde_Mail_Rfc822_Address) The original e-mail provided.
Tags
Return values
mixed —False if no servers found, or a list of server objects in order of decreasing priority.