Interface EmailReaderInterface

Interface EmailReaderInterface

Direct known implementers

Package: Email\Interfaces
Category: System
Located at SystemServices/Email/Interfaces/Repository/EmailReaderInterface.inc.php

Methods summary

`public EmailCollection`	# `get( array $conditions = array(), array $limit = array(), array $order = array() )` Get email records filtered by conditions. Get email records filtered by conditions. Parameters `$conditions` (optional) Contains conditions with column => value pairs. `$limit` (optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 ) `$order` (optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' ) Returns `EmailCollection` Returns a collection containing the email records.
`public EmailCollection`	# `filter( string $p_keyword, array $limit = array(), array $order = array() )` Filter email records with provided keyword string. Filter email records with provided keyword string. Parameters `$p_keyword` String to be used for filtering the email records. `$limit` (optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 ) `$order` (optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' ) Returns `EmailCollection` Returns a collection containing the email records.
`public integer`	# `getRecordCount( string $p_filterKeyword = '' )` Get the current count of the email records in the database. Get the current count of the email records in the database. 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` (optional) If provided the records will be filtered. Returns integer Returns the row number of the email table. Throws InvalidArgumentException If the provided argument is not a string.