EmailReaderInterface
in
Interface EmailReaderInterface
Tags
Table of Contents
- filter() : EmailCollection
- Filter email records with provided keyword string.
- get() : EmailCollection
- Get email records filtered by conditions.
- getRecordCount() : int
- Get the current count of the email records in the database.
Methods
filter()
Filter email records with provided keyword string.
public
filter(string $p_keyword[, array<string|int, mixed> $limit = [] ][, array<string|int, mixed> $order = [] ]) : EmailCollection
Parameters
- $p_keyword : string
-
String to be used for filtering the email records.
- $limit : array<string|int, mixed> = []
-
(optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 )
- $order : array<string|int, mixed> = []
-
(optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' )
Return values
EmailCollection —Returns a collection containing the email records.
get()
Get email records filtered by conditions.
public
get([array<string|int, mixed> $conditions = [] ][, array<string|int, mixed> $limit = [] ][, array<string|int, mixed> $order = [] ]) : EmailCollection
Parameters
- $conditions : array<string|int, mixed> = []
-
(optional) Contains conditions with column => value pairs.
- $limit : array<string|int, mixed> = []
-
(optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 )
- $order : array<string|int, mixed> = []
-
(optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' )
Return values
EmailCollection —Returns a collection containing the email records.
getRecordCount()
Get the current count of the email records in the database.
public
getRecordCount([string $p_filterKeyword = '' ]) : int
This method will quickly return the record count of the "emails" table. It must be used when we just need the number and not the data, because the "get" or "find" methods need more time to load and parse the records.
Parameters
- $p_filterKeyword : string = ''
-
(optional) If provided the records will be filtered.
Tags
Return values
int —Returns the row number of the email table.