CSOpenSearchEmailComponent
in package
Tags
Table of Contents
- getAc() : string
- Returns a AC.
- getBcc() : string
- Returns a BCC.
- getCc() : string
- Returns a CC.
- getMessage() : string
- Returns a message.
- getPattern() : string
- Returns a pattern for all E-Mail components.
- getSubject() : string
- Returns a subject.
- getTemplatePath() : string
- Returns a template path to a XML File which is used as a template for E-Mail send action.
- isAcVisible() : bool
- Whenever the AC field should be visible or not.
- isBccVisible() : bool
- Whenever the BCC field should be visible or not.
- isCcVisible() : bool
- Whenever the CC field should be visible or not.
- isSubjectRequired() : bool
- Whenever the Subject field is required or not.
- isSubjectVisible() : bool
- Whenever the Subject field should be visible or not.
- setAc() : mixed
- Sets a AC.
- setAcVisible() : mixed
- Sets the visibility of the Ac field.
- setBcc() : mixed
- Sets a BCC.
- setBccVisible() : mixed
- Sets the visibility of the BCC field.
- setCc() : mixed
- Sets a CC.
- setCcVisible() : mixed
- Sets the visibility of the CC field.
- setMessage() : mixed
- Sets a message.
- setPattern() : mixed
- Sets a pattern for all E-Mail components
- setSubject() : mixed
- Sets a subject.
- setSubjectRequired() : mixed
- Sets the Subject field to be required.
- setSubjectVisible() : mixed
- Sets the visibility of the Subject field.
- setTemplatePath() : mixed
- Sets a template path (relative to ADMIN) to a XML File which is used as template for E-Mail send action.
- toArray() : array<string|int, mixed>
- Returns this object casted to an array.
Methods
getAc()
Returns a AC.
public
getAc() : string
Tags
Return values
string —getBcc()
Returns a BCC.
public
getBcc() : string
Tags
Return values
string —getCc()
Returns a CC.
public
getCc() : string
Tags
Return values
string —getMessage()
Returns a message.
public
getMessage() : string
Tags
Return values
string —getPattern()
Returns a pattern for all E-Mail components.
public
getPattern() : string
Tags
Return values
string —getSubject()
Returns a subject.
public
getSubject() : string
Tags
Return values
string —getTemplatePath()
Returns a template path to a XML File which is used as a template for E-Mail send action.
public
getTemplatePath() : string
Tags
Return values
string —isAcVisible()
Whenever the AC field should be visible or not.
public
isAcVisible() : bool
Tags
Return values
bool —isBccVisible()
Whenever the BCC field should be visible or not.
public
isBccVisible() : bool
Tags
Return values
bool —isCcVisible()
Whenever the CC field should be visible or not.
public
isCcVisible() : bool
Tags
Return values
bool —isSubjectRequired()
Whenever the Subject field is required or not.
public
isSubjectRequired() : bool
Tags
Return values
bool —isSubjectVisible()
Whenever the Subject field should be visible or not.
public
isSubjectVisible() : bool
Tags
Return values
bool —setAc()
Sets a AC.
public
setAc(string $sAc) : mixed
Parameters
- $sAc : string
Tags
Return values
mixed —setAcVisible()
Sets the visibility of the Ac field.
public
setAcVisible(bool $bAcVisible) : mixed
Parameters
- $bAcVisible : bool
Tags
Return values
mixed —setBcc()
Sets a BCC.
public
setBcc(string $sBcc) : mixed
Parameters
- $sBcc : string
Tags
Return values
mixed —setBccVisible()
Sets the visibility of the BCC field.
public
setBccVisible(bool $bBccVisible) : mixed
Parameters
- $bBccVisible : bool
Tags
Return values
mixed —setCc()
Sets a CC.
public
setCc(string $sCc) : mixed
Parameters
- $sCc : string
Tags
Return values
mixed —setCcVisible()
Sets the visibility of the CC field.
public
setCcVisible(bool $bCcVisible) : mixed
Parameters
- $bCcVisible : bool
Tags
Return values
mixed —setMessage()
Sets a message.
public
setMessage(string $sMessage) : mixed
Parameters
- $sMessage : string
Tags
Return values
mixed —setPattern()
Sets a pattern for all E-Mail components
public
setPattern(string $sPattern) : mixed
Parameters
- $sPattern : string
Tags
Return values
mixed —setSubject()
Sets a subject.
public
setSubject(string $sSubject) : mixed
Parameters
- $sSubject : string
Tags
Return values
mixed —setSubjectRequired()
Sets the Subject field to be required.
public
setSubjectRequired(bool $bSubjectRequired) : mixed
Parameters
- $bSubjectRequired : bool
Tags
Return values
mixed —setSubjectVisible()
Sets the visibility of the Subject field.
public
setSubjectVisible(bool $bSubjectVisible) : mixed
Parameters
- $bSubjectVisible : bool
Tags
Return values
mixed —setTemplatePath()
Sets a template path (relative to ADMIN) to a XML File which is used as template for E-Mail send action.
public
setTemplatePath(string $TemplateUrl) : mixed
Parameters
- $TemplateUrl : string
Tags
Return values
mixed —toArray()
Returns this object casted to an array.
public
toArray() : array<string|int, mixed>