ApprovedEmail extends BaseEmail
in package

Table of Contents

$booking  : Booking
$customer  : Customer
$defaultHeaderText  : string
$defaultSubject  : string
$description  : string
$id  : string
$isTestMode  : bool
$label  : string
$payment  : Payment|null
$templater  : EmailTemplaterr
$user  : array<string|int, mixed>
__construct()  : mixed
generateSettingsFields()  : mixed
getBooking()  : Booking
getDefaultMessageHeaderText()  : mixed
getDefaultMessageTemplate()  : string
getDefaultSubject()  : mixed
getDeprecatedNotices()  : mixed
getDescription()  : string
getId()  : string
getLabel()  : string
getPayment()  : Payment|null
initStrings()  : mixed
isDisabled()  : bool
isPrevented()  : bool
isTestMode()  : bool
send()  : bool
Send mail.
trigger()  : bool
triggerCustomerRegistration()  : mixed
applyStyles()  : string
Applies styles for mail html.
checkReceiver()  : bool
getAuthor()  : mixed
getMessage()  : string
getMessageContent()  : string
getMessageFooter()  : string
getMessageFooterText()  : string
getMessageHeader()  : string
getMessageHeaderText()  : string
getMessageHeaderTextTemplate()  : mixed
getMessageTemplate()  : string
getOption()  : mixed
getReceiver()  : mixed
getSubject()  : string
getSubjectTemplate()  : string
initDescription()  : mixed
initLabel()  : mixed
log()  : mixed
receiverError()  : string
replaceTags()  : string
setupBooking()  : mixed
setupCustomer()  : mixed
setupPayment()  : mixed

Properties

$booking

protected Booking $booking

$customer

protected Customer $customer

$defaultHeaderText

protected string $defaultHeaderText = ''

$defaultSubject

protected string $defaultSubject = ''

$description

protected string $description = ''

$id

protected string $id

$isTestMode

protected bool $isTestMode = false
Tags
since
3.7.2

$label

protected string $label

$payment

protected Payment|null $payment = null
Tags
since
3.8.6

$templater

protected EmailTemplaterr $templater

$user

protected array<string|int, mixed> $user

Methods

__construct()

public __construct(array<string|int, mixed> $atts, EmailTemplater $templater) : mixed
Parameters
$atts : array<string|int, mixed>
$templater : EmailTemplater
Return values
mixed

generateSettingsFields()

public generateSettingsFields(SettingsTab $tab) : mixed
Parameters
$tab : SettingsTab
Return values
mixed

getBooking()

public getBooking() : Booking
Tags
since
3.8.6
Return values
Booking

getDefaultMessageHeaderText()

public getDefaultMessageHeaderText() : mixed
Return values
mixed

getDefaultMessageTemplate()

public getDefaultMessageTemplate() : string
Return values
string

getDefaultSubject()

public getDefaultSubject() : mixed
Return values
mixed

getDeprecatedNotices()

public getDeprecatedNotices() : mixed
Return values
mixed

getDescription()

public getDescription() : string
Tags
note

available after plugins_loaded

Return values
string

getId()

public getId() : string
Return values
string

getLabel()

public getLabel() : string
Tags
note

available after plugins_loaded

Return values
string

getPayment()

public getPayment() : Payment|null
Tags
since
3.8.6
Return values
Payment|null

initStrings()

public initStrings() : mixed
Return values
mixed

isDisabled()

public isDisabled() : bool
Return values
bool

isPrevented()

public isPrevented() : bool
Tags
since
2.4.1
Return values
bool

isTestMode()

public isTestMode() : bool
Tags
since
3.8.6
Return values
bool

send()

Send mail.

public send() : bool
Tags
since
3.7.2

sends the message to the administrator email address in test mode.

since
3.8.6

added actions "mphb_before_send_mail" and "mphb_after_send_mail".

Return values
bool

trigger()

public trigger(Booking $booking[, array<string|int, mixed> $atts = array() ]) : bool
Parameters
$booking : Booking
$atts : array<string|int, mixed> = array()

Optional.

Tags
since
3.7.2

added new attribute - "test_mode".

Return values
bool

triggerCustomerRegistration()

public triggerCustomerRegistration(Customer $customer, mixed $userAtts[, mixed $atts = array() ][, mixed $booking = null ]) : mixed
Parameters
$customer : Customer
$userAtts : mixed
$atts : mixed = array()
$booking : mixed = null
Return values
mixed

applyStyles()

Applies styles for mail html.

protected applyStyles(string $html) : string
Parameters
$html : string

HTML of mail.

Return values
string

checkReceiver()

protected checkReceiver() : bool
Tags
since
3.8.6
Return values
bool

getAuthor()

protected getAuthor() : mixed
Return values
mixed

getMessage()

protected getMessage() : string
Return values
string

getMessageContent()

protected getMessageContent() : string
Return values
string

getMessageFooter()

protected getMessageFooter() : string
Return values
string

getMessageFooterText()

protected getMessageFooterText() : string
Return values
string

getMessageHeader()

protected getMessageHeader() : string
Return values
string

getMessageHeaderText()

protected getMessageHeaderText() : string
Return values
string

getMessageHeaderTextTemplate()

protected getMessageHeaderTextTemplate() : mixed
Return values
mixed

getMessageTemplate()

protected getMessageTemplate() : string
Return values
string

getOption()

protected getOption(string $name[, string $default = '' ]) : mixed
Parameters
$name : string
$default : string = ''

Optional.

Return values
mixed

getReceiver()

protected abstract getReceiver() : mixed
Return values
mixed

getSubject()

protected getSubject() : string
Return values
string

getSubjectTemplate()

protected getSubjectTemplate() : string
Return values
string

initDescription()

protected initDescription() : mixed
Return values
mixed

initLabel()

protected initLabel() : mixed
Return values
mixed

log()

protected abstract log(mixed $isSended) : mixed
Parameters
$isSended : mixed
Return values
mixed

receiverError()

protected receiverError() : string
Tags
since
3.8.6
Return values
string

replaceTags()

protected replaceTags(string $template) : string
Parameters
$template : string
Return values
string

setupBooking()

protected setupBooking(Booking $booking) : mixed
Parameters
$booking : Booking
Return values
mixed

setupCustomer()

protected setupCustomer(Customer $customer, mixed $userAtts) : mixed
Parameters
$customer : Customer
$userAtts : mixed
Tags
since
4.2.0
Return values
mixed

setupPayment()

protected setupPayment(Payment|null $payment) : mixed
Parameters
$payment : Payment|null
Tags
since
3.8.6
Return values
mixed

Search results