Field Squared API Services

<back to all web services

DocumentEmailTemplate

Represents the email output configuration for a single document template.

export enum EmailOutputEngine
{
    DefaultHtml = 'DefaultHtml',
    DefaultPdf = 'DefaultPdf',
    Custom = 'Custom',
    Standard = 'Standard',
}

export enum EmailOutputFormat
{
    Embed = 'Embed',
    AttachPdf = 'AttachPdf',
}

/** @description Represents the email output configuration for a single document template. */
export class DocumentEmailTemplate
{
    public Type: string;
    public Workspace: string;
    public Engine: EmailOutputEngine;
    public Format: EmailOutputFormat;
    public PdfTemplate: string;
    public BodyTemplate: string;
    public SubjectTemplate: string;
    public HeaderTemplate: string;
    public FooterTemplate: string;
    public PageSize: string;
    public Orientation: string;
    public Margins: string;

    public constructor(init?: Partial<DocumentEmailTemplate>) { (Object as any).assign(this, init); }
}

TypeScript DocumentEmailTemplate DTOs

POST /{Workspace}/DocumentTemplate/{Type}/Email HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Type: String,
	Workspace: String,
	Engine: DefaultHtml,
	Format: Embed,
	PdfTemplate: String,
	BodyTemplate: String,
	SubjectTemplate: String,
	HeaderTemplate: String,
	FooterTemplate: String,
	PageSize: String,
	Orientation: String,
	Margins: String
}