Mailmark2DCodetext

Mailmark2DCodetext class

Namespace: Aspose.Barcode.ComplexBarcode

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code.

Constructors

Name	Description
__construct	Create default instance of Mailmark2DCodetext class.

Methods

Name	Static	Description
construct	Yes
initFromString	No	Initializes Mailmark data from constructed codetext.

Properties

Name	Read/Write	Description
BarcodeType	Read-only	Gets barcode type.
Class_	Read/Write	Identifies the class of the item. Valid Values: “1” - 1C (Retail) “2” - 2C (Retail) “3” - Economy (Retail) “5” - Deffered (Retail) “8” - Premium (Network Access) “9” - Standard (Network Access)
ConstructedCodetext	Read-only	Construct codetext from Mailmark data.
CustomerContent	Read/Write	Optional space for use by customer. Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters
CustomerContentEncodeMode	Read/Write	Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.
DataMatrixType	Read/Write	2D Mailmark Type defines size of Data Matrix barcode.
DestinationPostCodeAndDPS	Read/Write	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format.
InformationTypeID	Read/Write	Identifies the Royal Mail Mailmark barcode payload for each product type. Valid Values: “0” - Domestic Sorted & Unsorted “A” - Online Postage “B” - Franking “C” - Consolidation
ItemID	Read/Write	Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.
RTSFlag	Read/Write	Flag which indicates what level of Return to Sender service is being requested.
ReturnToSenderPostCode	Read/Write	Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.
SupplyChainID	Read/Write	Identifies the unique group of customers involved in the mailing. Max value: 9999999.
UPUCountryID	Read/Write	Identifies the UPU Country ID.Max length: 4 characters.
VersionID	Read/Write	Identifies the barcode version as relevant to each Information Type ID. Valid Values: Currently “1”. “0” & “2” to “9” and “A” to “Z” spare reserved for potential future use.

Mailmark2DCodetext__construct()

Create default instance of Mailmark2DCodetext class.

constructconstruct($complexCodetextDTO) (static)

Parameter	Type	Description
`$complexCodetextDTO`	``

initFromStringinitFromString($constructedCodetext)

Initializes Mailmark data from constructed codetext.

Parameter	Type	Description
`$constructedCodetext`	``

BarcodeType

Access: Read-only

Returns: int Barcode type.

Gets barcode type.

Class_

Access: Read/Write

Returns: string class of the item

Identifies the class of the item. Valid Values: “1” - 1C (Retail) “2” - 2C (Retail) “3” - Economy (Retail) “5” - Deffered (Retail) “8” - Premium (Network Access) “9” - Standard (Network Access)

Parameter	Type	Description
`$value`	`string`

ConstructedCodetext

Access: Read-only

Returns: string Constructed codetext

Construct codetext from Mailmark data.

CustomerContent

Access: Read/Write

Returns: string Customer content

Optional space for use by customer. Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

Parameter	Type	Description
`$value`	`string`

CustomerContentEncodeMode

Access: Read/Write

Returns: int Encode mode of Datamatrix barcode.

Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.

Parameter	Type	Description
`$value`	`int`

DataMatrixType

Access: Read/Write

Returns: int Size of Data Matrix barcode

2D Mailmark Type defines size of Data Matrix barcode.

Parameter	Type	Description
`$value`	`int`

DestinationPostCodeAndDPS

Access: Read/Write

Returns: string the Postcode of the Delivery Address with DPS

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format.

Parameter	Type	Description
`$value`	`string`

InformationTypeID

Access: Read/Write

Returns: string Information type ID

Identifies the Royal Mail Mailmark barcode payload for each product type. Valid Values: “0” - Domestic Sorted & Unsorted “A” - Online Postage “B” - Franking “C” - Consolidation

Parameter	Type	Description
`$value`	`string`

ItemID

Access: Read/Write

Returns: int item within the Supply Chain ID

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

Parameter	Type	Description
`$value`	`int`

RTSFlag

Access: Read/Write

Returns: string RTS Flag

Flag which indicates what level of Return to Sender service is being requested.

Parameter	Type	Description
`$value`	`string`

ReturnToSenderPostCode

Access: Read/Write

Returns: string Return to Sender Post Code but no DPS

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

Parameter	Type	Description
`$value`	`string`

SupplyChainID

Access: Read/Write

Returns: int Supply chain ID

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

Parameter	Type	Description
`$value`	`int`

UPUCountryID

Access: Read/Write

Returns: string Country ID

Identifies the UPU Country ID.Max length: 4 characters.

Parameter	Type	Description
`$value`	`string`

VersionID

Access: Read/Write

Returns: string Version ID

Identifies the barcode version as relevant to each Information Type ID. Valid Values: Currently “1”. “0” & “2” to “9” and “A” to “Z” spare reserved for potential future use.

Parameter	Type	Description
`$value`	`string`