Class PublicEmail

A marketing email

Constructors

constructor

Properties

_from activeDomain? archived? businessUnitId? campaign? campaignName? clonedFrom? content createdAt? createdById? deletedAt? feedbackSurveyId? folderId? id isPublished? isTransactional? jitterSendTime? language? name publishDate? publishedAt? publishedById? rssData? sendOnPublish state stats? subcategory subject subscriptionDetails? testing? to type? updatedAt? updatedById? webversion? workflowNames? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

_from

_from: PublicEmailFromDetails

OptionalactiveDomain

activeDomain?: string

The active domain of the email.

Optionalarchived

archived?: boolean

Determines if the email is archived or not.

OptionalbusinessUnitId

businessUnitId?: string

Optionalcampaign

campaign?: string

The campaign id on the email.

OptionalcampaignName

campaignName?: string

OptionalclonedFrom

clonedFrom?: string

content

content: PublicEmailContent

OptionalcreatedAt

createdAt?: Date

The date and time of the email's creation, in ISO8601 representation.

OptionalcreatedById

createdById?: string

The id of the user who created the email.

OptionaldeletedAt

deletedAt?: Date

OptionalfeedbackSurveyId

feedbackSurveyId?: string

The ID of the feedback survey linked to the email.

OptionalfolderId

folderId?: number

id

id: string

The email ID.

OptionalisPublished

isPublished?: boolean

Returns the published status of the email. This is read only.

OptionalisTransactional

isTransactional?: boolean

Returns whether the email is a transactional email or not. This is read only.

OptionaljitterSendTime

jitterSendTime?: boolean

Optionallanguage

language?: PublicEmailLanguageEnum

name

name: string

The name of the email, as displayed on the email dashboard.

OptionalpublishDate

publishDate?: Date

The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.

OptionalpublishedAt

publishedAt?: Date

The date and time the email was published at, in ISO8601 representation.

OptionalpublishedById

publishedById?: string

OptionalrssData

rssData?: PublicRssEmailDetails

sendOnPublish

sendOnPublish: boolean

Determines whether the email will be sent immediately on publish.

state

state: PublicEmailStateEnum

The email state.

Optionalstats

stats?: EmailStatisticsData

subcategory

subcategory: string

The email subcategory.

subject

subject: string

The subject of the email.

OptionalsubscriptionDetails

subscriptionDetails?: PublicEmailSubscriptionDetails

Optionaltesting

testing?: PublicEmailTestingDetails

to

to: PublicEmailToDetails

Optionaltype

type?: PublicEmailTypeEnum

The email type, this is derived from other properties on the email such as subcategory.

OptionalupdatedAt

updatedAt?: Date

The date and time of the last update to the email, in ISO8601 representation.

OptionalupdatedById

updatedById?: string

The id of the user who last updated the email.

Optionalwebversion

webversion?: PublicWebversionDetails

OptionalworkflowNames

workflowNames?: string[]

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods