UsMailV3Document
extends Prediction
in package
US Mail API version 3.0 document data.
Table of Contents
Properties
- $isReturnToSender : BooleanField
- $recipientAddresses : UsMailV3RecipientAddresses
- $recipientNames : array<string|int, StringField>
- $senderAddress : UsMailV3SenderAddress
- $senderName : StringField
Methods
- __construct() : mixed
- __toString() : string
Properties
$isReturnToSender
public
BooleanField
$isReturnToSender
Whether the mailing is marked as return to sender.
$recipientAddresses
public
UsMailV3RecipientAddresses
$recipientAddresses
The addresses of the recipients.
$recipientNames
public
array<string|int, StringField>
$recipientNames
The names of the recipients.
$senderAddress
public
UsMailV3SenderAddress
$senderAddress
The address of the sender.
$senderName
public
StringField
$senderName
The name of the sender.
Methods
__construct()
public
__construct(array<string|int, mixed> $rawPrediction[, int|null $pageId = null ]) : mixed
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction from HTTP response.
- $pageId : int|null = null
-
Page number for multi pages document.
Tags
__toString()
public
__toString() : string
Return values
string —String representation.