interface GetMailServiceInterface

Interface for the GetMailService class.

Methods

array
generateMailList(array $mailData, string $type = 'page')

Generate a rendered list of emails.

array|bool
getMail(int $limit = 10, array $fields = [])

Get the users mails.

array|bool
getUnreadMail(int $limit = 5, array $fields = [])

Get the users unread mails.

Details

at line 55
array generateMailList(array $mailData, string $type = 'page')

Generate a rendered list of emails.

Parameters

array $mailData

The mail data to process.

string $type

The type of output we need so we can differentiate between pages/blocks.

Return Value

array

The render array with the list of mails.

at line 25
array|bool getMail(int $limit = 10, array $fields = [])

Get the users mails.

Parameters

int $limit

The number of mails to get.

array $fields

The fields we want to get. If empty all fields will be returned.

Return Value

array|bool

The list of mails or FALSE if no mails.

Exceptions

TempStoreException
IdentityProviderException
GraphException

at line 42
array|bool getUnreadMail(int $limit = 5, array $fields = [])

Get the users unread mails.

Parameters

int $limit

The number of mails to get.

array $fields

The fields we want to get. If empty all fields will be returned.

Return Value

array|bool

The list of mails or FALSE if no mails.

Exceptions

TempStoreException
IdentityProviderException
GraphException