SmtpSettings
in package
SMTP Settings
Tags
Table of Contents
Methods
- _addSmtpAccount() : mixed
- _getSmtpAccount() : mixed
- Get details of a specified SMTP account
- _isUniqueSmtpAccountName() : bool
- Check for unique SMTP account name
- _updateSmtpAccount() : mixed
- getSmtpAccount() : mixed
- Get details of a SMTP account
- getSmtpAccountMenu() : mixed
- getSmtpAccounts() : array<string|int, mixed>
- Get a list of available SMTP accounts
- getSystemSmtpAccount() : array<string|int, mixed>
- Returns the local configured SMTP account of the current system.
Methods
_addSmtpAccount()
public
static _addSmtpAccount(mixed $arrSmtp) : mixed
Parameters
- $arrSmtp : mixed
Tags
_getSmtpAccount()
Get details of a specified SMTP account
public
static _getSmtpAccount([int $accountId = 0 ][, bool $getPassword = false ]) : mixed
Returns the details of the SMTP account specified by $accountId. If $accountId is either FALSE or not a valid account ID then this method will return FALSE. Only if $getPassword is set to TRUE will the password of the specified SMTP account be returned.
Parameters
- $accountId : int = 0
- $getPassword : bool = false
Tags
Return values
mixed —Array with account details if $accountId is a valid account ID, otherwise FALSE
_isUniqueSmtpAccountName()
Check for unique SMTP account name
public
static _isUniqueSmtpAccountName(string $name[, int $id = 0 ]) : bool
This method checks if the account name specified by $name is unique within the system.
Parameters
- $name : string
- $id : int = 0
-
of a SMTP account
Tags
Return values
bool_updateSmtpAccount()
public
static _updateSmtpAccount(mixed $id, mixed $arrSmtp) : mixed
Parameters
- $id : mixed
- $arrSmtp : mixed
Tags
getSmtpAccount()
Get details of a SMTP account
public
static getSmtpAccount([int $accountId = 0 ][, bool $getPassword = true ]) : mixed
Returns the details of the SMTP account specified by $accountId. If $accountId is either FALSE or not a valid account ID then FALSE will be returned instead.
Parameters
- $accountId : int = 0
-
The ID of the account settings
- $getPassword : bool = true
Tags
Return values
mixed —Array with the details of the requested account on success, false otherwise
getSmtpAccountMenu()
public
static getSmtpAccountMenu(mixed $selectedAccountId, mixed $attrs) : mixed
Parameters
- $selectedAccountId : mixed
- $attrs : mixed
Tags
getSmtpAccounts()
Get a list of available SMTP accounts
public
static getSmtpAccounts() : array<string|int, mixed>
Returns an array with all available SMTP accounts. This includes on the one hand the self defined accounts and on the other hand the local system account defined in the php.ini.
Tags
Return values
array<string|int, mixed> —Array with SMTP accounts
getSystemSmtpAccount()
Returns the local configured SMTP account of the current system.
public
static getSystemSmtpAccount() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array with the SMTP account details