TransportMail implements iBase, iDuration, iLimitation, iConsent
Class TransportMail
Table of Contents
Interfaces
- iBase
- Interface iBase
- iDuration
- Interface iTransportDuration
- iLimitation
- Interface iLimitable
- iConsent
Constants
- CODE = self::CODE_MAIL
Methods
- __construct() : mixed
- TransportMail constructor.
- end() : void
- End.
- getCode() : string
- Get code.
- getConsentMaxRequests() : int
- get max consent request num
- getDuration() : float
- Get send duration in seconds.
- getLimiters() : array<string|int, iLimiter>
- Get limiters.
- getName() : string
- Get name.
- getSupportedRecipientTypes() : array<string|int, int>
- Get supported recipient types.
- isConsentNeed() : bool
- check if consent Option is turn on
- loadConfiguration() : Configuration
- Load configuration.
- replaceTemplate() : array<string|int, mixed>|string|array<string|int, string>|null
- saveConfiguration() : Result|null
- Save configuration.
- send() : bool
- Send.
- sendConsent() : bool
- send Consent Message to Recipient
- start() : void
- Start.
Constants
CODE
public
mixed
CODE
= self::CODE_MAIL
Methods
__construct()
TransportMail constructor.
public
__construct() : mixed
end()
End.
public
end() : void
getCode()
Get code.
public
getCode() : string
Return values
stringgetConsentMaxRequests()
get max consent request num
public
getConsentMaxRequests() : int
Return values
intgetDuration()
Get send duration in seconds.
public
getDuration([Adapter|null $message = null ]) : float
Parameters
- $message : Adapter|null = null
-
Message.
Return values
floatgetLimiters()
Get limiters.
public
getLimiters([iBase $message = null ]) : array<string|int, iLimiter>
Parameters
- $message : iBase = null
-
Message.
Return values
array<string|int, iLimiter>getName()
Get name.
public
getName() : string
Return values
stringgetSupportedRecipientTypes()
Get supported recipient types.
public
getSupportedRecipientTypes() : array<string|int, int>
Return values
array<string|int, int>isConsentNeed()
check if consent Option is turn on
public
isConsentNeed() : bool
Return values
boolloadConfiguration()
Load configuration.
public
loadConfiguration([string|null $id = null ]) : Configuration
Parameters
- $id : string|null = null
-
ID.
Return values
ConfigurationreplaceTemplate()
public
static replaceTemplate(string|null $str) : array<string|int, mixed>|string|array<string|int, string>|null
Parameters
- $str : string|null
Return values
array<string|int, mixed>|string|array<string|int, string>|nullsaveConfiguration()
Save configuration.
public
saveConfiguration(Configuration $configuration) : Result|null
Parameters
- $configuration : Configuration
-
Configuration.
Return values
Result|nullsend()
Send.
public
send(Adapter $message) : bool
Parameters
- $message : Adapter
-
Message.
Return values
boolsendConsent()
send Consent Message to Recipient
public
sendConsent(Adapter $message, AbstractConsentMessageBuilder $builder) : bool
Parameters
- $message : Adapter
- $builder : AbstractConsentMessageBuilder
Return values
boolstart()
Start.
public
start() : void