MailAgentInterface
in
Table of Contents
Methods
- agentSettings() : void
- Provides additional settings for the settings page.
- connect() : bool
- Connects to the mail agent. Not all agents will need to connect.
- disconnect() : bool
- Disconnects to the mail agent. Not all agents will need to disconnect.
- getImplementationClassKeyName() : string
- Gets the class identifier of the current agent implementation.
- getVersion() : string
- Gets the Version of the Agent.
- isConfigured() : bool
- Checks if the agent has been configured for usage.
- isSupported() : bool
- Checks if the requirements for the agent are available.
- send() : bool
- Sends the email via the agent
Methods
agentSettings()
Provides additional settings for the settings page.
public
agentSettings(array<string|int, mixed> &$config_vars) : void
Parameters
- $config_vars : array<string|int, mixed>
-
Current configuration settings, passed by reference. Append to add more.
connect()
Connects to the mail agent. Not all agents will need to connect.
public
connect() : bool
Return values
bool —Whether or not the agent method was connected to.
disconnect()
Disconnects to the mail agent. Not all agents will need to disconnect.
public
disconnect() : bool
Return values
bool —Whether or not the agent method was connected to.
getImplementationClassKeyName()
Gets the class identifier of the current agent implementation.
public
getImplementationClassKeyName() : string
Return values
string —the unique identifier for the current class implementation.
getVersion()
Gets the Version of the Agent.
public
getVersion() : string
Return values
string —the value of $key.
isConfigured()
Checks if the agent has been configured for usage.
public
isConfigured() : bool
Return values
bool —True if the agent is configured, false otherwise.
isSupported()
Checks if the requirements for the agent are available.
public
isSupported() : bool
Return values
bool —True if the agent is supported, false otherwise.
send()
Sends the email via the agent
public
send(string $to, string $subject, string $message, string $headers) : bool
Parameters
- $to : string
- $subject : string
- $message : string
-
Message should be formatted with html/plain text.
- $headers : string
-
Any additional headers.