Mail extends SendFacilitator
FinalYes
Table of Contents
Methods
- __construct() : mixed
- addAttachment() : self
- send() : Result
- setAddEmailSignature() : self
- setAdditionalFields() : SendFacilitator
- Set additional fields that will be available in the message (even after its send and delivery).
- setAttachmentStorageType() : self
- setFrom() : self
- setMessageBody() : $this
- Attention! You may need to specify body content type - html, bb code or plain text.
- setMessageBodyContentType() : $this
- setMessageSubject() : self
- setTo() : self
Methods
__construct()
public
__construct(Channel $channel) : mixed
Parameters
- $channel : Channel
addAttachment()
public
addAttachment(int $fileId) : self
Parameters
- $fileId : int
Return values
selfsend()
public
final send() : Result
Return values
ResultsetAddEmailSignature()
public
setAddEmailSignature(bool $addEmailSignature) : self
Parameters
- $addEmailSignature : bool
Return values
selfsetAdditionalFields()
Set additional fields that will be available in the message (even after its send and delivery).
public
setAdditionalFields(array<string|int, mixed> $additionalFields) : SendFacilitator
Use it if you want to get some additional info in 'message sent' and 'message delivered' events.
Parameters
- $additionalFields : array<string|int, mixed>
Return values
SendFacilitatorsetAttachmentStorageType()
public
setAttachmentStorageType(int $storageTypeId) : self
Parameters
- $storageTypeId : int
Return values
selfsetFrom()
public
setFrom(From $from) : self
Parameters
- $from : From
Return values
selfsetMessageBody()
Attention! You may need to specify body content type - html, bb code or plain text.
public
setMessageBody(string $body) : $this
By default, body is considered html.
Parameters
- $body : string
Return values
$thissetMessageBodyContentType()
public
setMessageBodyContentType(int $messageBodyContentType) : $this
Parameters
- $messageBodyContentType : int
-
- constant of \CCrmContentType
Tags
Return values
$thissetMessageSubject()
public
setMessageSubject(string $subject) : self
Parameters
- $subject : string
Return values
selfsetTo()
public
setTo(To $to) : self
Parameters
- $to : To