--- title: "nuxt-backend/email" description: "Every export of nuxt-backend/email, with its signature and where it is defined." canonical_url: "https://nuxt-backend.dev/docs/reference/api/email" --- # nuxt-backend/email ## Interfaces ### EmailMessage Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) A rendered email. `to` travels with the message because the template knows the recipient: the invitation goes to the invitee, the gift to its recipient. #### Properties
Property Type Defined in
to string src/convex/email-templates.ts
subject string src/convex/email-templates.ts
html? string src/convex/email-templates.ts
text? string src/convex/email-templates.ts
--- ### EmailBrand Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) The app a message is sent for. `url` is `SITE_URL`; `name` is `setupEmail`'s `brand.name`, or the site's host without one. #### Properties
Property Type Defined in
name string src/convex/email-templates.ts
url string src/convex/email-templates.ts
--- ### EmailRenderContext Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) What every template renders with, beside its own data. #### Properties
Property Type Description Defined in
t Translate The package's labels, filled in: t('email.welcome.subject') . src/convex/email-templates.ts
locale string The recipient's locale. English ( 'en' ) until the account says otherwise. src/convex/email-templates.ts
brand EmailBrand - src/convex/email-templates.ts
--- ### OtpEmailData Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Data for the `otp` template. #### Properties
Property Type Description Defined in
email string - src/convex/email-templates.ts
otp string - src/convex/email-templates.ts
type OtpPurpose - src/convex/email-templates.ts
reason? "email-change" Why the code was sent, where its type alone doesn't say: 'email-change' for the email-verification code that confirms the current address at the start of an email change. src/convex/email-templates.ts
--- ### EmailChangedEmailData Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Data for the `emailChanged` template. #### Properties
Property Type Description Defined in
email string The address the account had: the notice goes there. src/convex/email-templates.ts
newEmail string The address it has now, as the person typed it: escape it in HTML ( escapeHtml ). src/convex/email-templates.ts
--- ### WelcomeEmailData Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Data for the `welcome` template. #### Properties
Property Type Description Defined in
email string - src/convex/email-templates.ts
name string The name the person signed up with: their own text, so escape it in HTML ( escapeHtml ). src/convex/email-templates.ts
--- ### DeleteAccountEmailData Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Data for the `deleteAccount` template. #### Properties
Property Type Defined in
email string src/convex/email-templates.ts
url string src/convex/email-templates.ts
--- ### InviteEmailData Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Data for the `invite` template. #### Properties
Property Type Description Defined in
email string - src/convex/email-templates.ts
url string - src/convex/email-templates.ts
inviterName string The inviter's own name: user text, so escape it in HTML ( escapeHtml ). src/convex/email-templates.ts
inviterEmail string - src/convex/email-templates.ts
organizationName string The workspace's name, as a member typed it: escape it in HTML. src/convex/email-templates.ts
role string - src/convex/email-templates.ts
--- ### GiftEmailData Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Data for the `gift` template. It names who sent what and links to the app, nothing more: the purchaser's email and their message stay out of the email, and the link carries no token — the recipient signs in to claim. #### Properties
Property Type Description Defined in
recipientEmail string - src/convex/email-templates.ts
purchaserName? string The sender's name: at most 40 characters with links and domains taken out, but still their own text, so escape it in HTML ( escapeHtml ). src/convex/email-templates.ts
item string What the gift is: the credit pack's product name. src/convex/email-templates.ts
claimUrl string The app URL where the recipient signs in (or up) to receive the gift. src/convex/email-templates.ts
--- ### EmailTemplates Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Every email the package sends, as a template. A template returns the message or a promise of it, so an async renderer (`@vue-email/render`, `@react-email/render`) works as is. #### Properties
Property Type Description Defined in
otp ( data , context ) => | EmailMessage | Promise < EmailMessage > A one-time code: for sign-in, for verifying an address ( email-verification , which also confirms the current address at the start of an email change), and for the new address of an email change ( change-email ). src/convex/email-templates.ts
emailChanged ( data , context ) => | EmailMessage | Promise < EmailMessage > Tells the old address that an email change went through. src/convex/email-templates.ts
welcome ( data , context ) => | EmailMessage | Promise < EmailMessage > Sent once, right after an account is created. src/convex/email-templates.ts
deleteAccount ( data , context ) => | EmailMessage | Promise < EmailMessage > The confirmation link before an account is deleted. src/convex/email-templates.ts
invite ( data , context ) => | EmailMessage | Promise < EmailMessage > A workspace invitation with its accept link. src/convex/email-templates.ts
gift ( data , context ) => | EmailMessage | Promise < EmailMessage > Tells a gift's recipient it is paid and waiting for them. src/convex/email-templates.ts
--- ### EmailComponents Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) The component handle `setupEmail` reads from your generated `components` object: the package's all-in-one `backend` component, whose email functions the app reaches as `components.backend.email.*` (see `src/convex/components/backend/email.ts`). Pass the whole `components` object — the key is picked structurally. #### Properties
Property Type Description Defined in
backend { email : { send : FunctionReference < "mutation" , "internal" , SendEmailOptions , string | null >; status : FunctionReference < "query" , "internal" , { emailId : string ; }, EmailStatus | null >; get : FunctionReference < "query" , "internal" , { emailId : string ; }, EmailRecord | null >; cancel : FunctionReference < "mutation" , "internal" , { emailId : string ; }, null >; cleanup : FunctionReference < "mutation" , "internal" , { olderThanMs? : number ; }, null >; cleanupAbandoned : FunctionReference < "mutation" , "internal" , { olderThanMs? : number ; }, null >; handleWebhook : FunctionReference < "action" , "internal" , { body : string ; headers : Record < string , string >; }, { status : number ; body : string ; type? : string ; }>; inbox : FunctionReference < "query" , "internal" , { address : string ; }, SandboxMessage >; }; webhooks : WebhookLogRefs ; } - src/convex/integrations/email.ts
backend.email { send : FunctionReference < "mutation" , "internal" , SendEmailOptions , string | null >; status : FunctionReference < "query" , "internal" , { emailId : string ; }, EmailStatus | null >; get : FunctionReference < "query" , "internal" , { emailId : string ; }, EmailRecord | null >; cancel : FunctionReference < "mutation" , "internal" , { emailId : string ; }, null >; cleanup : FunctionReference < "mutation" , "internal" , { olderThanMs? : number ; }, null >; cleanupAbandoned : FunctionReference < "mutation" , "internal" , { olderThanMs? : number ; }, null >; handleWebhook : FunctionReference < "action" , "internal" , { body : string ; headers : Record < string , string >; }, { status : number ; body : string ; type? : string ; }>; inbox : FunctionReference < "query" , "internal" , { address : string ; }, SandboxMessage >; } - src/convex/integrations/email.ts
backend.email.send FunctionReference < "mutation" , "internal" , SendEmailOptions , string | null > - src/convex/integrations/email.ts
backend.email.status FunctionReference < "query" , "internal" , { emailId : string ; }, EmailStatus | null > - src/convex/integrations/email.ts
backend.email.get FunctionReference < "query" , "internal" , { emailId : string ; }, EmailRecord | null > - src/convex/integrations/email.ts
backend.email.cancel FunctionReference < "mutation" , "internal" , { emailId : string ; }, null > - src/convex/integrations/email.ts
backend.email.cleanup FunctionReference < "mutation" , "internal" , { olderThanMs? : number ; }, null > Retention pruning of the provider component's email records. src/convex/integrations/email.ts
backend.email.cleanupAbandoned FunctionReference < "mutation" , "internal" , { olderThanMs? : number ; }, null > - src/convex/integrations/email.ts
backend.email.handleWebhook FunctionReference < "action" , "internal" , { body : string ; headers : Record < string , string >; }, { status : number ; body : string ; type? : string ; }> - src/convex/integrations/email.ts
backend.email.inbox FunctionReference < "query" , "internal" , { address : string ; }, SandboxMessage > The sandbox inbox (test mode only). src/convex/integrations/email.ts
backend.webhooks WebhookLogRefs - src/convex/integrations/email.ts
--- ### SandboxMessage Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) A message in a sandbox inbox: what test mode sent to one of the provider's sandbox addresses (`delivered+label@resend.dev`) within the last hour. Part of the experimental sandbox inbox (`useSandboxInbox`, STABILITY.md). #### Properties
Property Type Description Defined in
from string - src/convex/integrations/email.ts
subject string - src/convex/integrations/email.ts
text? string - src/convex/integrations/email.ts
html? string - src/convex/integrations/email.ts
receivedAt number When it was sent, as epoch ms. src/convex/integrations/email.ts
--- ### EmailStatus Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) A sent email's delivery state, as the component `status` query returns it. #### Extended by - [`EmailRecord`](#emailrecord) #### Properties
Property Type Defined in
status string src/convex/integrations/email.ts
errorMessage string | null src/convex/integrations/email.ts
bounced boolean src/convex/integrations/email.ts
complained boolean src/convex/integrations/email.ts
failed boolean src/convex/integrations/email.ts
deliveryDelayed boolean src/convex/integrations/email.ts
opened boolean src/convex/integrations/email.ts
clicked boolean src/convex/integrations/email.ts
--- ### EmailRecord Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) A sent email's record, as the component `get` query returns it. #### Extends - [`EmailStatus`](#emailstatus) #### Properties
Property Type Description Inherited from Defined in
status string - EmailStatus . status src/convex/integrations/email.ts
errorMessage string | null - EmailStatus . errorMessage src/convex/integrations/email.ts
bounced boolean - EmailStatus . bounced src/convex/integrations/email.ts
complained boolean - EmailStatus . complained src/convex/integrations/email.ts
failed boolean - EmailStatus . failed src/convex/integrations/email.ts
deliveryDelayed boolean - EmailStatus . deliveryDelayed src/convex/integrations/email.ts
opened boolean - EmailStatus . opened src/convex/integrations/email.ts
clicked boolean - EmailStatus . clicked src/convex/integrations/email.ts
from string - - src/convex/integrations/email.ts
to string - - src/convex/integrations/email.ts
cc? string - - src/convex/integrations/email.ts
bcc? string - - src/convex/integrations/email.ts
subject? string - - src/convex/integrations/email.ts
replyTo string - - src/convex/integrations/email.ts
html? string - - src/convex/integrations/email.ts
text? string - - src/convex/integrations/email.ts
template? { id : string ; variables? : Record < string , string | number >; } - - src/convex/integrations/email.ts
template.id string - - src/convex/integrations/email.ts
template.variables? Record < string , string | number > - - src/convex/integrations/email.ts
headers? { name : string ; value : string ; } - - src/convex/integrations/email.ts
createdAt number When it was queued, as epoch ms. - src/convex/integrations/email.ts
finalizedAt number When it reached a final state (delivered, bounced, failed, cancelled), as epoch ms — a far-future sentinel while it is still in flight. - src/convex/integrations/email.ts
--- ### EmailEventData Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) `email.*` payload data (documented fields + open for provider additions). #### Indexable ```ts [key: string]: unknown ``` #### Properties
Property Type Defined in
email_id? string src/convex/integrations/email.ts
from? string src/convex/integrations/email.ts
to? string src/convex/integrations/email.ts
subject? string src/convex/integrations/email.ts
created_at? string src/convex/integrations/email.ts
broadcast_id? string src/convex/integrations/email.ts
bounce? { type? : string ; subType? : string ; message? : string ; } src/convex/integrations/email.ts
bounce.type? string src/convex/integrations/email.ts
bounce.subType? string src/convex/integrations/email.ts
bounce.message? string src/convex/integrations/email.ts
--- ### ContactEventData Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) `contact.*` payload data. #### Indexable ```ts [key: string]: unknown ``` #### Properties
Property Type Description Defined in
id? string - src/convex/integrations/email.ts
segment_ids? string The segments the contact belongs to. src/convex/integrations/email.ts
audience_id? string Deprecated The provider still sends it; read segment_ids . src/convex/integrations/email.ts
email? string - src/convex/integrations/email.ts
first_name? string - src/convex/integrations/email.ts
last_name? string - src/convex/integrations/email.ts
unsubscribed? boolean - src/convex/integrations/email.ts
--- ### DomainEventData Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) `domain.*` payload data. #### Indexable ```ts [key: string]: unknown ``` #### Properties
Property Type Defined in
id? string src/convex/integrations/email.ts
name? string src/convex/integrations/email.ts
status? string src/convex/integrations/email.ts
--- ### EmailWebhookEvent Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) A verified provider webhook event, as delivered to the typed handlers. #### Type Parameters
Type Parameter Default type
T extends EmailWebhookEventType EmailWebhookEventType
#### Properties
Property Type Defined in
type T src/convex/integrations/email.ts
created_at? string src/convex/integrations/email.ts
data EventDataFor < T > src/convex/integrations/email.ts
--- ### SetupEmailOptions Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) #### Properties
Property Type Description Defined in
templates? EmailTemplateOverrides Restyle any email the package sends, by template name: otp , welcome , deleteAccount , invite , gift . Each override gets the template's data and its render context, the default included: invite: (data, { byDefault }) => ({ ...byDefault(data), subject: 'Join us' }) . src/convex/integrations/email.ts
brand? { name? : string ; } The app the emails are sent for. name reaches every template as brand.name ; without it, the brand is the host of SITE_URL . The packaged emails sign off with it, linked to SITE_URL . src/convex/integrations/email.ts
brand.name? string - src/convex/integrations/email.ts
events? EmailWebhookEventHandlers React to any verified provider event, keyed by its event name ( 'email.bounced' , 'contact.created' , …). Handlers run after the component has verified the signature and updated delivery status — useEmailStatus already reflects the event. A handler throw answers 500, so the provider redelivers (deliveries are deduped once fully processed). src/convex/integrations/email.ts
onUnknownEvent? ( ctx , event ) => Promise < void > Called for a verified event whose type is outside the known catalog (a provider newer than this package). Acknowledged 202 either way. src/convex/integrations/email.ts
--- ### Email Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) #### Properties
Property Type Description Defined in
api { getEmailStatus : RegisteredQuery < "public" >; getSandboxInbox : RegisteredQuery < "public" >; } Ready-made, client-callable functions to re-export from your backend/email.ts : getEmailStatus (the reactive query behind useEmailStatus ) and getSandboxInbox (behind useSandboxInbox ). src/convex/integrations/email.ts
api.getEmailStatus RegisteredQuery < "public" > - src/convex/integrations/email.ts
api.getSandboxInbox RegisteredQuery < "public" > The messages test mode sent to a sandbox address within the last hour, newest first — for a demo, a preview deployment or an e2e run that has to read a sign-in code without a real mailbox. Public and unauthenticated by design (the visitor is not signed in yet), so knowing an address is enough to read its mail: re-export it only where every account is a throwaway sandbox one. Empty for any other address, and always empty with EMAIL_TEST_MODE=false , which captures nothing. Experimental, with useSandboxInbox (STABILITY.md). src/convex/integrations/email.ts
send ( ctx , options ) => Promise < string | null > Send a transactional email (call from your own gated action/mutation). src/convex/integrations/email.ts
render < Name >( name , data , options? ) => Promise < EmailMessage > Render one of the package's emails, your override or the packaged default, without sending it: what a preview page or a test shows. Resolves once an async override has rendered. src/convex/integrations/email.ts
sendTemplate < Name >( ctx , name , data , options? ) => Promise < string | null > Render one of the package's emails and send it. src/convex/integrations/email.ts
status ( ctx , emailId ) => Promise < EmailStatus | null > Read an email's delivery status. src/convex/integrations/email.ts
cancel ( ctx , emailId ) => Promise < void > Cancel a not-yet-sent email. src/convex/integrations/email.ts
cleanup ( ctx , options? ) => Promise < void > Prune finalized email records (delivered, bounced, cancelled, failed …) older than olderThanMs — default 7 days. Schedules the provider's batched cleanup and returns at once; call it from a cron. Example [backend/crons.ts] crons.daily('prune emails', { hourUTC: 3, minuteUTC: 0 }, internal.email.pruneEmails) // internal.email.pruneEmails: internalMutation(ctx => email.cleanup(ctx, { olderThanMs: 7 * DAY })) src/convex/integrations/email.ts
cleanupAbandoned ( ctx , options? ) => Promise < void > Prune abandoned email records — created more than olderThanMs ago (default 30 days) and never finalized, e.g. because a delivery webhook never arrived. Scheduled like cleanup . src/convex/integrations/email.ts
webhookHandler ( ctx , request ) => Promise < Response > Handle an email-provider event webhook from your app's /email/events HTTP route (inside an httpAction ); returns the Response to send back. src/convex/integrations/email.ts
segments { create : ( payload ) => Promise < unknown >; list : () => Promise < unknown >; remove : ( id ) => Promise < unknown >; addContact : ( payload ) => Promise < unknown >; removeContact : ( payload ) => Promise < unknown >; } Marketing segments — the groups a broadcast is sent to. A contact is one record however many segments it sits in: put it in one at creation ( contacts.add({ email, segments: [{ id }] }) ) or later with addContact . src/convex/integrations/email.ts
segments.create ( payload ) => Promise < unknown > - src/convex/integrations/email.ts
segments.list () => Promise < unknown > - src/convex/integrations/email.ts
segments.remove ( id ) => Promise < unknown > - src/convex/integrations/email.ts
segments.addContact ( payload ) => Promise < unknown > Put an existing contact ( contactId or email ) in a segment. src/convex/integrations/email.ts
segments.removeContact ( payload ) => Promise < unknown > Take a contact out of a segment; the contact itself stays. src/convex/integrations/email.ts
contacts { add : ( payload ) => Promise < unknown >; list : ( payload ) => Promise < unknown >; update : ( payload ) => Promise < unknown >; remove : ( payload ) => Promise < unknown >; } Marketing contacts: add (subscribe) / list / update / remove (unsubscribe). src/convex/integrations/email.ts
contacts.add ( payload ) => Promise < unknown > - src/convex/integrations/email.ts
contacts.list ( payload ) => Promise < unknown > - src/convex/integrations/email.ts
contacts.update ( payload ) => Promise < unknown > - src/convex/integrations/email.ts
contacts.remove ( payload ) => Promise < unknown > - src/convex/integrations/email.ts
broadcasts { create : ( payload ) => Promise < unknown >; send : ( id , payload? ) => Promise < unknown >; } Marketing broadcasts: create / send (optionally scheduled). src/convex/integrations/email.ts
broadcasts.create ( payload ) => Promise < unknown > - src/convex/integrations/email.ts
broadcasts.send ( id , payload? ) => Promise < unknown > - src/convex/integrations/email.ts
## Type Aliases ### OtpPurpose ```ts type OtpPurpose = "sign-in" | "email-verification" | "forget-password" | "change-email"; ``` Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Which code an OTP email carries; the subject follows it. --- ### EmailTemplateName ```ts type EmailTemplateName = keyof EmailTemplates; ``` Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) A template's name. --- ### EmailTemplateData ```ts type EmailTemplateData = Parameters[0]; ``` Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) The data a template renders from. #### Type Parameters
Type Parameter
Name extends EmailTemplateName
--- ### EmailTemplateOverrides ```ts type EmailTemplateOverrides = { [Name in EmailTemplateName]?: (data: EmailTemplateData, context: EmailRenderContext & { byDefault: (data: EmailTemplateData) => EmailMessage }) => EmailMessage | Promise }; ``` Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Overrides for any template in [EmailTemplates](#emailtemplates). Each gets the same data and context as the default, and the default itself, already bound to that context, so an override can keep the packaged body and change only what it needs: `invite: (data, { byDefault }) => ({ ...byDefault(data), subject: 'Join us' })`. An override may be async; the packaged default never is. --- ### SendEmailOptions ```ts type SendEmailOptions = { to: string | string[]; subject?: string; html?: string; text?: string; from?: string; cc?: string | string[]; bcc?: string | string[]; replyTo?: string[]; headers?: { name: string; value: string; }[]; template?: { id: string; variables?: Record; }; idempotencyKey?: string; }; ``` Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) Options for a transactional send (mirrors the component `send` mutation). #### Properties
Property Type Description Defined in
to string | string - src/convex/integrations/email.ts
subject? string - src/convex/integrations/email.ts
html? string - src/convex/integrations/email.ts
text? string - src/convex/integrations/email.ts
from? string - src/convex/integrations/email.ts
cc? string | string - src/convex/integrations/email.ts
bcc? string | string - src/convex/integrations/email.ts
replyTo? string - src/convex/integrations/email.ts
headers? { name : string ; value : string ; } - src/convex/integrations/email.ts
template? { id : string ; variables? : Record < string , string | number >; } - src/convex/integrations/email.ts
template.id string - src/convex/integrations/email.ts
template.variables? Record < string , string | number > - src/convex/integrations/email.ts
idempotencyKey? string Dedupes the send: a second send with the same key, while the first is still on record, returns the first one's id and delivers nothing. src/convex/integrations/email.ts
--- ### EmailWebhookEventType ```ts type EmailWebhookEventType = typeof ALL_EMAIL_EVENTS[number]; ``` Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) --- ### EmailWebhookEventHandlers ```ts type EmailWebhookEventHandlers = { [K in EmailWebhookEventType]?: (ctx: AnyActionCtx, event: EmailWebhookEvent) => Promise }; ``` Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) Per-event email webhook handlers, keyed by the provider's event names — the complete catalog, uniform with `setupBilling({ events })`. --- ### LabelParams ```ts type LabelParams = Record; ``` Defined in: [src/convex/labels.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/labels.ts) Values a label interpolates. `count` also picks the plural form. --- ### Translate ```ts type Translate = (key, params?) => string; ``` Defined in: [src/convex/labels.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/labels.ts) Resolve a label by its dotted key and fill it in. #### Parameters
Parameter Type
key string
params? LabelParams
#### Returns `string` ## Variables ### ALL_EMAIL_EVENTS ```ts const ALL_EMAIL_EVENTS: readonly ["email.sent", "email.delivered", "email.delivery_delayed", "email.bounced", "email.complained", "email.opened", "email.clicked", "email.failed", "email.scheduled", "email.received", "email.suppressed", "contact.created", "contact.updated", "contact.deleted", "domain.created", "domain.updated", "domain.deleted"]; ``` Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) The provider's full webhook event catalog: every transactional delivery state, plus the contact and domain events the marketing surface (segments/contacts/broadcasts) generates. Broadcast sends surface as `email.*` events carrying a `broadcast_id`. ## Functions ### escapeHtml() ```ts function escapeHtml(value): string; ``` Defined in: [src/convex/email-templates.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/email-templates.ts) Escape text for HTML: `&`, `<`, `>`, `"` and `'`. Every packaged template runs each value through it; an override that writes its own HTML should do the same with anything a user typed (a name, a workspace name, a gift sender's name), or that user can put markup into an email your domain sends. #### Parameters
Parameter Type
value string
#### Returns `string` #### Example ```ts gift: (data, { byDefault }) => ({ ...byDefault(data), html: `

From ${escapeHtml(data.purchaserName ?? 'someone')}

` }) ``` --- ### setupEmail() ```ts function setupEmail(components, options?): Email; ``` Defined in: [src/convex/integrations/email.ts](https://github.com/qruto/nuxt-backend/blob/main/src/convex/integrations/email.ts) App-facing email helper over the `backend` component's email module: both **transactional** email (send / status / cancel + webhook) and **marketing** email (segments / contacts / broadcasts via the provider SDK). It also holds the templates of every email the package sends: `setupAuth` and `setupBilling` take this instance as their `email` option and send through it, so an override here restyles all of them. Both use the required `EMAIL_API_KEY` env var. While it's missing (e.g. a mid-configuration preview), transactional `send` logs instead of delivering. #### Parameters
Parameter Type
components EmailComponents
options? SetupEmailOptions
#### Returns [`Email`](#email-6) #### Example ```ts import { setupEmail } from 'nuxt-backend/email' import { components } from './_generated/api' export const email = setupEmail(components, { templates: { invite: (data, { byDefault }) => ({ ...byDefault(data), subject: 'Join the team' }) }, }) export const { getEmailStatus } = email.api ``` ## Sitemap See the full [sitemap](https://nuxt-backend.dev/sitemap.md) for all pages.