Message
Table of Contents
Methods
- buildContact() : array<string|int, mixed>
- checkModules() : Result
- convertTypeToFormatForBinding() : mixed
- entityRecipientsToCollectionForDialog() : ItemCollection
- getAssociatedUser() : mixed
- getEntityRecipients() : Result
- getHeader() : Result
- getMessageBody() : Result
- getNeighbors() : array<string|int, mixed>|null
- getSelectedRecipientsForDialog() : ItemCollection
- getSenderList() : array<string|int, mixed>
- getSignature() : mixed
- getSubjectById() : string
- nameIsEquivalentToEmail() : bool
- In different mail services, if you do not specify the recipient's name, it will be framed differently in the technical header.
- sortRecipientsByType() : array<string|int, mixed>
Methods
buildContact()
public
static buildContact(array<string|int, mixed> $props) : array<string|int, mixed>
Parameters
- $props : array<string|int, mixed>
Return values
array<string|int, mixed>checkModules()
public
static checkModules() : Result
Return values
ResultconvertTypeToFormatForBinding()
public
static convertTypeToFormatForBinding(mixed $type) : mixed
Parameters
- $type : mixed
entityRecipientsToCollectionForDialog()
public
static entityRecipientsToCollectionForDialog([mixed $recipients = [] ][, mixed $sortByType = false ][, string $ownerTypeName = '' ][, int $ownerId = 0 ]) : ItemCollection
Parameters
- $recipients : mixed = []
- $sortByType : mixed = false
- $ownerTypeName : string = ''
- $ownerId : int = 0
Return values
ItemCollectiongetAssociatedUser()
public
static getAssociatedUser(array<string|int, mixed> $activity) : mixed
Parameters
- $activity : array<string|int, mixed>
getEntityRecipients()
public
static getEntityRecipients(int $ownerId, string $ownerTypeName[, bool $uploadRecipients = true ][, bool $uploadSenders = true ][, mixed $inCollectionForDialog = false ]) : Result
Parameters
- $ownerId : int
- $ownerTypeName : string
- $uploadRecipients : bool = true
- $uploadSenders : bool = true
- $inCollectionForDialog : mixed = false
Return values
ResultgetHeader()
public
static getHeader(array<string|int, mixed> $activity[, mixed $showPortalContactNames = true ]) : Result
Parameters
- $activity : array<string|int, mixed>
- $showPortalContactNames : mixed = true
Return values
ResultgetMessageBody()
public
static getMessageBody(mixed $id) : Result
Parameters
- $id : mixed
Return values
ResultgetNeighbors()
public
static getNeighbors(int $ownerId, int $ownerTypeId, int $elementId[, bool $requiredWebUrl = false ]) : array<string|int, mixed>|null
Parameters
- $ownerId : int
- $ownerTypeId : int
- $elementId : int
- $requiredWebUrl : bool = false
Return values
array<string|int, mixed>|nullgetSelectedRecipientsForDialog()
public
static getSelectedRecipientsForDialog(mixed $recipients, string|null $ownerType, int|null $ownerId[, bool $loadIfEmpty = false ]) : ItemCollection
Parameters
- $recipients : mixed
-
These parameters must be passed to search and add related elements in case processing the $recipients param will result in an empty collection:
- $ownerType : string|null
- $ownerId : int|null
- $loadIfEmpty : bool = false
Tags
Return values
ItemCollectiongetSenderList()
public
static getSenderList() : array<string|int, mixed>
Return values
array<string|int, mixed>getSignature()
public
static getSignature(mixed $email, mixed $name) : mixed
Parameters
- $email : mixed
- $name : mixed
getSubjectById()
public
static getSubjectById(int $id) : string
Parameters
- $id : int
Return values
stringnameIsEquivalentToEmail()
In different mail services, if you do not specify the recipient's name, it will be framed differently in the technical header.
public
static nameIsEquivalentToEmail(mixed $name, mixed $email) : bool
To make sure that the recipient's name is not really there, you should check through this function.
Parameters
- $name : mixed
- $email : mixed
Return values
boolsortRecipientsByType()
public
static sortRecipientsByType(mixed $list) : array<string|int, mixed>
Parameters
- $list : mixed