API Documentation
Back to top  

EmailReaderInterface

Extends

Interface EmailReaderInterface

category

System
package

Email
subpackage

Interfaces

Methods

Filter email records with provided keyword string.

filter(string $p_keyword, array $limit = array(), array $order = array()) : \EmailCollection

Arguments

$p_keyword

string

String to be used for filtering the email records.

$limit

array

(optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 )

$order

array

(optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' )

Response

\EmailCollection

Returns a collection containing the email records.

Get email records filtered by conditions.

get(array $conditions = array(), array $limit = array(), array $order = array()) : \EmailCollection

Arguments

$conditions

array

(optional) Contains conditions with column => value pairs.

$limit

array

(optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 )

$order

array

(optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' )

Response

\EmailCollection

Returns a collection containing the email records.

Get the current count of the email records in the database.

getRecordCount(string $p_filterKeyword = '') : integer

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.

Throws
\InvalidArgumentException

If the provided argument is not a string.

Arguments

$p_filterKeyword

string

(optional) If provided the records will be filtered.

Response

integer

Returns the row number of the email table.