@manta-eu/client/shared/email
Reference for @manta-eu/client/shared/email as it is on main.
Type Aliases
EmailGraphql
EmailGraphql = (
document,variables) =>Promise<unknown>
Parameters
document
string
variables
Record<string, unknown>
Returns
Promise<unknown>
EmailStart
EmailStart = {
ok:true;plan:string; } | {error:string;ok:false; }
RealmEmailTerms
RealmEmailTerms =
object
Properties
emailMessageShape
emailMessageShape:
string
renderedFrom
renderedFrom:
string
RenderedEmail
RenderedEmail =
object
Properties
from
from:
string
renderedFrom
renderedFrom:
string
subject
subject:
string
subjectIri
subjectIri:
string
to
to:
string
Functions
renderedEmailNode()
renderedEmailNode(
terms,ActionGraphNode
Parameters
terms
Returns
startRenderedEmail()
startRenderedEmail(
graphql,terms,Promise<EmailStart>
Parameters
graphql
terms
Returns
Promise<EmailStart>
startRenderedEmails()
startRenderedEmails(
graphql,terms,emails):Promise<EmailStart>
Sends every email as one plan; each email’s own outcome is the plan activity that used its subjectIri.
A plan holds at most maxGraphNodes entities, so a caller with more emails splits them into batches.
Parameters
graphql
terms
emails
readonly RenderedEmail[]
Returns
Promise<EmailStart>