MessageTag
in package
FinalYes
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
Table of Contents
Properties
- $name : string
- The name of the message tag. The message tag name has to meet the following criteria:
- $value : string
- The value of the message tag. The message tag value has to meet the following criteria:
Methods
- __construct() : mixed
- create() : self
- getName() : string
- getValue() : string
- throwException() : never
Properties
$name
The name of the message tag. The message tag name has to meet the following criteria:
private
string
$name
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
$value
The value of the message tag. The message tag value has to meet the following criteria:
private
string
$value
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
Methods
__construct()
public
__construct(array{Name: string, Value: string} $input) : mixed
Parameters
- $input : array{Name: string, Value: string}
create()
public
static create(array{Name: string, Value: string}|MessageTag $input) : self
Parameters
- $input : array{Name: string, Value: string}|MessageTag
Return values
selfgetName()
public
getName() : string
Return values
stringgetValue()
public
getValue() : string
Return values
stringthrowException()
private
throwException(Throwable $exception) : never
Parameters
- $exception : Throwable