phpDocumentor

EmailDeleter
in package
implements EmailDeleterInterface

Class EmailDeleter

Deletes email records from the database.

Tags
category

System

subpackage

Repository

Interfaces, Classes and Traits

EmailDeleterInterface
Interface EmailDeleterInterface

Table of Contents

$db  : CI_DB_query_builder
Query builder.
__construct()  : mixed
Class Constructor
delete()  : mixed
Removes a record from the database.
deleteEmailsByEmailAddress()  : mixed
Removes all emails from the data base that have the given email address as sender or recipient.
deleteOldEmailsByDate()  : mixed
Removes all emails from the database that have creation date below the give date.

Properties

Methods

__construct()

Class Constructor

public __construct(CI_DB_query_builder $db) : mixed
Parameters
$db : CI_DB_query_builder

Query builder.

Return values
mixed —

delete()

Removes a record from the database.

public delete(EmailInterface $email) : mixed

This method will delete all the email relevant entities from the database. It will not throw an exception if the given record is not found.

Parameters
$email : EmailInterface

E-Mail.

Return values
mixed —

deleteEmailsByEmailAddress()

Removes all emails from the data base that have the given email address as sender or recipient.

public deleteEmailsByEmailAddress(CustomerEmail $email) : mixed
Parameters
$email : CustomerEmail

E-Mail address.

Return values
mixed —

deleteOldEmailsByDate()

Removes all emails from the database that have creation date below the give date.

public deleteOldEmailsByDate(DateTime $date) : mixed
Parameters
$date : DateTime
Return values
mixed —

Search results