1. class
  2. Poweradmin
  3. \
  4. Application
  5. \
  6. Service
  7. \
  8. Mail
  9. \
  10. EmailTemplateService

EmailTemplateService

class EmailTemplateService implements EmailTemplateRendererInterface (View source)

Renders the transactional email templates under templates/emails, with custom overrides, through Twig.

Methods

__construct(ConfigurationInterface $config)

No description

string
render(string $template, array $variables = [])

Render an email template

array
renderNewAccountEmail(string $username, string $password, string $fullname = '')

Render new account email templates

array
renderPasswordResetEmail(string $name, string $resetUrl, int $expireMinutes)

Render password reset email templates

array
renderMfaVerificationEmail(string $verificationCode, int $expiresAt, string|null $timezone = null)

Render MFA verification email templates

array
renderUsernameRecoveryEmail(string $name, array $usernames, string|null $loginUrl)

Render username recovery email templates

array
renderZoneAccessGrantedEmail(string $zoneName, string $recipientName, string $grantedByName, string $grantedByEmail, string $grantedAt, string|null $zoneEditUrl)

Render zone access granted email templates

array
renderZoneAccessRevokedEmail(string $zoneName, string $recipientName, string $revokedByName, string $revokedAt)

Render zone access revoked email templates

array
renderChangeRequestFiledEmail(string $zoneName, int $requestId, string $recipientName, string $requesterName, string $kind, string $comment, string $filedAt, string|null $requestUrl)

Render the "change request filed" email sent to each reviewer of a zone

array
renderChangeRequestDecidedEmail(string $zoneName, int $requestId, string $recipientName, string $status, string $reviewerName, string $reviewComment, string $decidedAt, string|null $requestUrl)

Render the "change request decided" email sent to the requester

bool
hasCustomTemplate(string $template)

Check if a custom template exists

array
getTemplatePaths()

Get available template paths for debugging

Details

at line 43
__construct(ConfigurationInterface $config)

No description

Parameters

ConfigurationInterface $config

at line 93
string render(string $template, array $variables = [])

Render an email template

Parameters

string $template

Template name (e.g., 'new-account.html.twig')
array $variables

Variables to pass to the template

Return Value

string

Rendered template content

Exceptions

SyntaxError

at line 109
array renderNewAccountEmail(string $username, string $password, string $fullname = '')

Render new account email templates

Parameters

string $username
string $password
string $fullname

Return Value

array

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 138
array renderPasswordResetEmail(string $name, string $resetUrl, int $expireMinutes)

Render password reset email templates

Parameters

string $name
string $resetUrl
int $expireMinutes

Return Value

array

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 167
array renderMfaVerificationEmail(string $verificationCode, int $expiresAt, string|null $timezone = null)

Render MFA verification email templates

Parameters

string $verificationCode
int $expiresAt

Unix timestamp the code stops being accepted
string|null $timezone

IANA timezone the expiry is shown in, or the configured default

Return Value

array

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 197
array renderUsernameRecoveryEmail(string $name, array $usernames, string|null $loginUrl)

Render username recovery email templates

Parameters

string $name

User's name
array $usernames

Usernames associated with the email
string|null $loginUrl

URL to the login page, or null to omit the link

Return Value

array

['html' => string, 'text' => string, 'subject' => string]

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 230
array renderZoneAccessGrantedEmail(string $zoneName, string $recipientName, string $grantedByName, string $grantedByEmail, string $grantedAt, string|null $zoneEditUrl)

Render zone access granted email templates

Parameters

string $zoneName

Zone name that access was granted to
string $recipientName

Recipient's full name or username
string $grantedByName

Name of person who granted access
string $grantedByEmail

Email of person who granted access
string $grantedAt

Timestamp of when access was granted
string|null $zoneEditUrl

URL to edit the zone, or null to omit the link

Return Value

array

['html' => string, 'text' => string, 'subject' => string]

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 269
array renderZoneAccessRevokedEmail(string $zoneName, string $recipientName, string $revokedByName, string $revokedAt)

Render zone access revoked email templates

Parameters

string $zoneName

Zone name that access was revoked from
string $recipientName

Recipient's full name or username
string $revokedByName

Name of person who revoked access
string $revokedAt

Timestamp of when access was revoked

Return Value

array

['html' => string, 'text' => string, 'subject' => string]

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 308
array renderChangeRequestFiledEmail(string $zoneName, int $requestId, string $recipientName, string $requesterName, string $kind, string $comment, string $filedAt, string|null $requestUrl)

Render the "change request filed" email sent to each reviewer of a zone

Parameters

string $zoneName

Zone the request targets
int $requestId

Change request ID
string $recipientName

Reviewer's full name or username
string $requesterName

Name of the user who filed the request
string $kind

'records' or 'zone_delete'
string $comment

Requester's comment, may be empty
string $filedAt

Timestamp of when the request was filed
string|null $requestUrl

URL of the review page, or null to omit the link

Return Value

array

['html' => string, 'text' => string, 'subject' => string]

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 352
array renderChangeRequestDecidedEmail(string $zoneName, int $requestId, string $recipientName, string $status, string $reviewerName, string $reviewComment, string $decidedAt, string|null $requestUrl)

Render the "change request decided" email sent to the requester

Parameters

string $zoneName

Zone the request targets
int $requestId

Change request ID
string $recipientName

Requester's full name or username
string $status

'approved', 'rejected' or 'failed'
string $reviewerName

Name of the reviewer, may be empty
string $reviewComment

Reviewer's comment, may be empty
string $decidedAt

Timestamp of the decision
string|null $requestUrl

URL of the review page, or null to omit the link

Return Value

array

['html' => string, 'text' => string, 'subject' => string]

Exceptions

LoaderError
RuntimeError
SyntaxError

at line 407
bool hasCustomTemplate(string $template)

Check if a custom template exists

Parameters

string $template

Return Value

bool

at line 417
array getTemplatePaths()

Get available template paths for debugging

Return Value

array