Documentation

Imap extends Base
in package

Mail imap message class.

Table of Contents

MAIL_TYPE_INTERNAL  = 2
MAIL_TYPE_RECEIVED  = 1
MAIL_TYPE_SENT  = 0
MAIL_TYPES  = [0 => 'Sent', 1 => 'Received', 2 => 'Internal']
Mail types map.
$name  : string
Scanner engine name.
$processData  : array<string|int, mixed>
Process data.
$emailsFieldsCache  : array<string|int, string>
Emails fields cache.
$numberFieldsCache  : array<string|int, string>
Number fields cache.
$value  : array<string|int, mixed>
__construct()  : mixed
Constructor.
findRelatedRecords()  : array<string|int, int>
Find related records.
findRelatedRecordsByEmail()  : array<string|int, int>
Find related records by emails.
findRelatedRecordsBySubject()  : array<string|int, int>
Find related records by subject.
get()  : mixed
Function to get the value for a given key.
getActions()  : array<string|int, mixed>
Get scanner actions.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getCid()  : string
Generation crm unique id.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getEmailsFields()  : array<string|int, mixed>
Get emails fields to search.
getExceptions()  : array<string|int, mixed>
Get exceptions.
getForHtml()  : mixed
Function to get the html encoded value for a given key.
getForSql()  : mixed
Function to get the value if its safe to use for SQL Query (column).
getKeys()  : array<string|int, string>
Function to get keys.
getMailCrmId()  : array<string|int, mixed>
Get mail crm id.
getMailType()  : int
Get mail type.
getRelatedRecords()  : array<string|int, mixed>
Get related records.
getUserId()  : int
Get user id.
has()  : bool
Function to check if the key exists.
initFromRequest()  : void
Initialize with request data.
isEmpty()  : bool
Function to check if the key is empty.
process()  : void
Main function to execute scanner engine actions.
remove()  : mixed
Function to remove the value.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.

Constants

MAIL_TYPE_INTERNAL

public mixed MAIL_TYPE_INTERNAL = 2

MAIL_TYPE_RECEIVED

public mixed MAIL_TYPE_RECEIVED = 1

MAIL_TYPE_SENT

public mixed MAIL_TYPE_SENT = 0

MAIL_TYPES

Mail types map.

public mixed MAIL_TYPES = [0 => 'Sent', 1 => 'Received', 2 => 'Internal']

Properties

$name

Scanner engine name.

public string $name = 'Imap'

$processData

Process data.

public array<string|int, mixed> $processData = []

$emailsFieldsCache

Emails fields cache.

protected array<string|int, string> $emailsFieldsCache = []

$numberFieldsCache

Number fields cache.

protected array<string|int, string> $numberFieldsCache = []

$value

protected array<string|int, mixed> $value

Values

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
$values : array<string|int, mixed> = []
Return values
mixed —

findRelatedRecords()

Find related records.

public findRelatedRecords([bool $onlyId = false ]) : array<string|int, int>
Parameters
$onlyId : bool = false
Return values
array<string|int, int> —

findRelatedRecordsByEmail()

Find related records by emails.

public findRelatedRecordsByEmail() : array<string|int, int>
Return values
array<string|int, int> —

findRelatedRecordsBySubject()

Find related records by subject.

public findRelatedRecordsBySubject() : array<string|int, int>
Return values
array<string|int, int> —

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed —

Value for the given key

getActions()

Get scanner actions.

public getActions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getArray()

Function to get the array values for a given key.

public getArray(string $key[, array<string|int, mixed> $value = [] ]) : array<string|int, mixed>
Parameters
$key : string
$value : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getCid()

Generation crm unique id.

public getCid() : string
Return values
string —

getData()

Function to get all the values of the Object.

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getEmailsFields()

Get emails fields to search.

public getEmailsFields([string|null $searchModuleName = null ]) : array<string|int, mixed>
Parameters
$searchModuleName : string|null = null
Return values
array<string|int, mixed> —

getExceptions()

Get exceptions.

public getExceptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getForHtml()

Function to get the html encoded value for a given key.

public getForHtml(string $key) : mixed
Parameters
$key : string
Return values
mixed —

getForSql()

Function to get the value if its safe to use for SQL Query (column).

public getForSql(string $key[, bool $skipEmtpy = true ]) : mixed
Parameters
$key : string
$skipEmtpy : bool = true

Skip the check if string is empty

Return values
mixed —

Value for the given key

getKeys()

Function to get keys.

public getKeys() : array<string|int, string>
Return values
array<string|int, string> —

getMailCrmId()

Get mail crm id.

public getMailCrmId() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getMailType()

Get mail type.

public getMailType() : int
Return values
int —

getRelatedRecords()

Get related records.

public getRelatedRecords() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUserId()

Get user id.

public getUserId() : int
Return values
int —

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool —

initFromRequest()

Initialize with request data.

public initFromRequest(Request $request) : void
Parameters
$request : Request
Return values
void —

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool —

process()

Main function to execute scanner engine actions.

public process() : void
Return values
void —

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed —

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this —

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results