Interface: InvitationMail
Defined in: packages/identity/src/port.ts:189
The words of the mail a realm sends when an account is invited (Keycloak's
execute-actions-email), in one locale, and the names it gives the required actions.
It exists because the provider's stock mail names neither the platform nor the
deployment and reads like phishing (chapter 23, 2026-10-14). The texts are finished
text in the provider's own pattern language, not templates for this package to
fill: on Keycloak they are Java MessageFormat patterns, so a literal apostrophe is
doubled and a literal brace quoted, and {0} is where the provider puts the link.
The caller does any interpolation and escaping before it gets here.
It is realm-wide: every invitation the realm sends uses it, so it must not name one kind of account.
Properties
actions
readonlyactions:Readonly<Partial<Record<RequiredAction,string>>>
Defined in: packages/identity/src/port.ts:201
What each required action is called, in the mail and on the provider's own pages.
html
readonlyhtml:string
Defined in: packages/identity/src/port.ts:199
The HTML body, {0} for the link. Keycloak sanitises it and the spike
N-KC-REALM-OVERRIDES found it decodes entities first, so an escaped < in it may
still become a tag. The template already sets lang and dir by locale.
subject
readonlysubject:string
Defined in: packages/identity/src/port.ts:191
The subject line. Keycloak formats it with no arguments: {0} is not filled here.
text
readonlytext:string
Defined in: packages/identity/src/port.ts:193
The plain-text body, {0} for the link. Line breaks are real newlines.