Mail
in package
Mail basic class.
Tags
Table of Contents
- checkInternalMailClient() : bool
- Check if the user has access to the internal mail client.
- checkMailClient() : bool
- Check if the user has access to the mail client.
- getAll() : array<string|int, mixed>
- Get a list of all smtp servers.
- getAttachmentsFromDocument() : array<string|int, mixed>
- Get attachments from document.
- getAttachmentsFromTemplate() : array<string|int, mixed>
- Get attachments email template.
- getDefaultSmtp() : int
- Get default smtp Id.
- getSmtpById() : array<string|int, mixed>
- Get smtp server by id.
- getTemplate() : array<string|int, mixed>
- Get mail template.
- getTemplateIdFromSysName() : int|null
- Get template ID.
- getTemplateList() : array<string|int, mixed>
- Get template list for module.
Methods
checkInternalMailClient()
Check if the user has access to the internal mail client.
public
static checkInternalMailClient() : bool
Return values
bool —checkMailClient()
Check if the user has access to the mail client.
public
static checkMailClient() : bool
Return values
bool —getAll()
Get a list of all smtp servers.
public
static getAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAttachmentsFromDocument()
Get attachments from document.
public
static getAttachmentsFromDocument(int|array<string|int, int> $ids[, mixed $returnOnlyName = true ]) : array<string|int, mixed>
Parameters
- $ids : int|array<string|int, int>
- $returnOnlyName : mixed = true
Return values
array<string|int, mixed> —getAttachmentsFromTemplate()
Get attachments email template.
public
static getAttachmentsFromTemplate(int|string $id) : array<string|int, mixed>
Parameters
- $id : int|string
Return values
array<string|int, mixed> —getDefaultSmtp()
Get default smtp Id.
public
static getDefaultSmtp() : int
Return values
int —getSmtpById()
Get smtp server by id.
public
static getSmtpById(int $smtpId) : array<string|int, mixed>
Parameters
- $smtpId : int
Return values
array<string|int, mixed> —getTemplate()
Get mail template.
public
static getTemplate(int|string $id[, bool $attachments = true ]) : array<string|int, mixed>
Parameters
- $id : int|string
- $attachments : bool = true
Return values
array<string|int, mixed> —getTemplateIdFromSysName()
Get template ID.
public
static getTemplateIdFromSysName(string $name) : int|null
Parameters
- $name : string
Return values
int|null —getTemplateList()
Get template list for module.
public
static getTemplateList([string $moduleName = '' ][, string $type = '' ][, bool $hideSystem = true ][, int|null $userId = null ]) : array<string|int, mixed>
Parameters
- $moduleName : string = ''
- $type : string = ''
- $hideSystem : bool = true
- $userId : int|null = null