Class UsMailV3Document

US Mail API version 3.0 document data.

Implements

Prediction

Index

Constructors

Properties

isReturnToSender recipientAddresses recipientNames senderAddress senderName

Methods

Constructors

constructor

new UsMailV3Document(
rawPrediction: StringDict,
pageId?: number,
): UsMailV3Document
Parameters
- rawPrediction: StringDict
- OptionalpageId: number
Returns UsMailV3Document
- Defined in src/product/us/usMail/usMailV3Document.ts:25

Properties

isReturnToSender

isReturnToSender: BooleanField

Whether the mailing is marked as return to sender.

recipientAddresses

recipientAddresses: UsMailV3RecipientAddress[] = []

The addresses of the recipients.

recipientNames

recipientNames: StringField[] = []

The names of the recipients.

senderAddress

senderAddress: UsMailV3SenderAddress

The address of the sender.

senderName

senderName: StringField

The name of the sender.

Methods

toString

toString(): string
Default string representation.

Returns string
- Defined in src/product/us/usMail/usMailV3Document.ts:63