InterfaceSDK v0.2.1

BuiltEmailPayload

Surface types for type-safe template interactions. These are generic types that get specialized by the generated client. Built payload for the outbox pattern. Contains all validated information needed to send later.

import type { BuiltEmailPayload } from '@usepapier/client/base';

Declaration #

surfaces.tsTypeScript
export interface BuiltEmailPayload<TPayload = any> {
    type: "email";
    templateName: string;
    projectName: string;
    to: string | string[];
    subject?: string;
    template?: string;
    data: TPayload;
}

Source: packages/client/src/core/surfaces.ts:12

Members 7

type: "email";

packages/client/src/core/surfaces.ts:13

templateName: string;

packages/client/src/core/surfaces.ts:14

projectName: string;

packages/client/src/core/surfaces.ts:15

to: string | string[];

packages/client/src/core/surfaces.ts:16

subject

Optional
subject?: string;

packages/client/src/core/surfaces.ts:17

template

Optional
template?: string;

packages/client/src/core/surfaces.ts:18

data: TPayload;

packages/client/src/core/surfaces.ts:19

Generated from TypeScript source.d65ea8f71fbf