GetMailServiceInterface
in
Interface for the GetMailService class.
Table of Contents
- generateMailList() : array<string|int, mixed>
- Generate a rendered list of emails.
- getMail() : array<string|int, mixed>|bool
- Get the users mails.
- getUnreadMail() : array<string|int, mixed>|bool
- Get the users unread mails.
Methods
generateMailList()
Generate a rendered list of emails.
public
generateMailList(array<string|int, mixed> $mailData[, string $type = 'page' ]) : array<string|int, mixed>
Parameters
- $mailData : array<string|int, mixed>
-
The mail data to process.
- $type : string = 'page'
-
The type of output we need so we can differentiate between pages/blocks.
Return values
array<string|int, mixed> —The render array with the list of mails.
getMail()
Get the users mails.
public
getMail([int $limit = 10 ][, array<string|int, mixed> $fields = [] ]) : array<string|int, mixed>|bool
Parameters
- $limit : int = 10
-
The number of mails to get.
- $fields : array<string|int, mixed> = []
-
The fields we want to get. If empty all fields will be returned.
Tags
Return values
array<string|int, mixed>|bool —The list of mails or FALSE if no mails.
getUnreadMail()
Get the users unread mails.
public
getUnreadMail([int $limit = 5 ][, array<string|int, mixed> $fields = [] ]) : array<string|int, mixed>|bool
Parameters
- $limit : int = 5
-
The number of mails to get.
- $fields : array<string|int, mixed> = []
-
The fields we want to get. If empty all fields will be returned.
Tags
Return values
array<string|int, mixed>|bool —The list of mails or FALSE if no mails.