Mailmark2DCodetext

Mailmark2DCodetext class

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

new Mailmark2DCodetext()

Create default instance of Mailmark2DCodetext class.

Methods

Name	Description
getBarcodeType()	Gets barcode type.
getClass_()	Identifies the class of the item. Valid Values: ‘1’ - 1C (Retail) ‘2’ - 2C (Retail) ‘3’ - Economy (Retail) ‘5’ - Deffere
getConstructedCodetext()	Construct codetext from Mailmark data.
getCustomerContent()	Optional space for use by customer. Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 character
getCustomerContentEncodeMode()	Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.
getDataMatrixType()	2D Mailmark Type defines size of Data Matrix barcode.
getDestinationPostCodeAndDPS()	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of charac
getInformationTypeID()	Identifies the Royal Mail Mailmark barcode payload for each product type. Valid Values: ‘0’ - Domestic Sorted & Unsorted
getItemID()	Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be un
getReturnToSenderPostCode()	Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.
getRTSFlag()	Flag which indicates what level of Return to Sender service is being requested.
getSupplyChainID()	Identifies the unique group of customers involved in the mailing. Max value: 9999999.
getUPUCountryID()	Identifies the UPU Country ID.Max length: 4 characters.
getVersionID()	Identifies the barcode version as relevant to each Information Type ID. Valid Values: Currently ‘1’. ‘0’ & ‘2’ to ‘9’ an
initFromString(constructedCodetext)	Initializes Mailmark data from constructed codetext.
setClass_(value)	Identifies the class of the item. Valid Values: ‘1’ - 1C (Retail) ‘2’ - 2C (Retail) ‘3’ - Economy (Retail) ‘5’ - Deffere
setCustomerContent(value)	Optional space for use by customer. Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 character
setCustomerContentEncodeMode(value)	Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.
setDataMatrixType(value)	2D Mailmark Type defines size of Data Matrix barcode.
setDestinationPostCodeAndDPS(value)	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of charac
setInformationTypeID(value)	Identifies the Royal Mail Mailmark barcode payload for each product type. Valid Values: ‘0’ - Domestic Sorted & Unsorted
setItemID(value)	Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be un
setReturnToSenderPostCode(value)	Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.
setRTSFlag()	Flag which indicates what level of Return to Sender service is being requested.
setSupplyChainID(value)	Identifies the unique group of customers involved in the mailing. Max value: 9999999.
setUPUCountryID(value)	Identifies the UPU Country ID.Max length: 4 characters.
setVersionID(value)	Identifies the barcode version as relevant to each Information Type ID. Valid Values: Currently ‘1’. ‘0’ & ‘2’ to ‘9’ an

getBarcodeType()

Gets barcode type.

Returns: Barcode type.

getClass_()

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)

Returns: class of the item

getConstructedCodetext()

Construct codetext from Mailmark data.

Returns: Constructed codetext

getCustomerContent()

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

Returns: Customer content

getCustomerContentEncodeMode()

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

Returns: Encode mode of Datamatrix barcode.

getDataMatrixType()

2D Mailmark Type defines size of Data Matrix barcode.

Returns: Size of Data Matrix barcode

getDestinationPostCodeAndDPS()

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.

Returns: the Postcode of the Delivery Address with DPS

getInformationTypeID()

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

Returns: Information type ID

getItemID()

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.

Returns: item within the Supply Chain ID

getReturnToSenderPostCode()

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

Returns: Return to Sender Post Code but no DPS

getRTSFlag()

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

Returns: RTS Flag

getSupplyChainID()

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

Returns: Supply chain ID

getUPUCountryID()

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

Returns: Country ID

getVersionID()

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.

Returns: Version ID

initFromString(constructedCodetext)

Initializes Mailmark data from constructed codetext.

Parameter	Description
constructedCodetext	Constructed codetext.

setClass_(value)

Parameter	Description
value	class of the item

setCustomerContent(value)

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

Parameter	Description
value	Customer content

setCustomerContentEncodeMode(value)

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

Parameter	Description
value	Encode mode of Datamatrix barcode.

setDataMatrixType(value)

2D Mailmark Type defines size of Data Matrix barcode.

Parameter	Description
value	Size of Data Matrix barcode

setDestinationPostCodeAndDPS(value)

Parameter	Description
value	the Postcode of the Delivery Address with DPS

setInformationTypeID(value)

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	Description
value	Information type ID

setItemID(value)

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	Description
value	item within the Supply Chain ID

setReturnToSenderPostCode(value)

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

Parameter	Description
value	Return to Sender Post Code but no DPS

setRTSFlag()

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

Returns: RTS Flag

setSupplyChainID(value)

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

Parameter	Description
value	Supply chain ID

setUPUCountryID(value)

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

Parameter	Description
value	Country ID

setVersionID(value)

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	Description
value	Version ID

License MailmarkCodetext