Mailmark2DCodetext

Mailmark2DCodetext

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

Constructor

new Mailmark2DCodetext()

Create default instance of Mailmark2DCodetext class.
Source:

Methods

getBarcodeType()

Gets barcode type.
Returns:
Type Description
Barcode type.
Source:

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:
Type Description
class of the item
Source:

getConstructedCodetext()

Construct codetext from Mailmark data.
Returns:
Type Description
Constructed codetext
Source:

getCustomerContent()

Optional space for use by customer.

Max length by Type:
Type 7: 6 characters
Type 9: 45 characters
Type 29: 25 characters
Returns:
Type Description
Customer content
Source:

getCustomerContentEncodeMode()

Encode mode of Datamatrix barcode.
Default value: DataMatrixEncodeMode.C40.
Returns:
Type Description
Encode mode of Datamatrix barcode.
Source:

getDataMatrixType()

2D Mailmark Type defines size of Data Matrix barcode.
Returns:
Type Description
Size of Data Matrix barcode
Source:

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:
Type Description
the Postcode of the Delivery Address with DPS
Source:

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:
Type Description
Information type ID
Source:

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:
Type Description
item within the Supply Chain ID
Source:

getRTSFlag()

Flag which indicates what level of Return to Sender service is being requested.
Returns:
Type Description
RTS Flag
Source:

getReturnToSenderPostCode()

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

getSupplyChainID()

Identifies the unique group of customers involved in the mailing.
Max value: 9999999.
Returns:
Type Description
Supply chain ID
Source:

getUPUCountryID()

Identifies the UPU Country ID.Max length: 4 characters.
Returns:
Type Description
Country ID
Source:

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:
Type Description
Version ID
Source:

initFromString(constructedCodetext)

Initializes Mailmark data from constructed codetext.
Parameters:
Name Type Description
constructedCodetext Constructed codetext.
Source:

setClass_(value)

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)
Parameters:
Name Type Description
value class of the item
Source:

setCustomerContent(value)

Optional space for use by customer.

Max length by Type:
Type 7: 6 characters
Type 9: 45 characters
Type 29: 25 characters
Parameters:
Name Type Description
value Customer content
Source:

setCustomerContentEncodeMode(value)

Encode mode of Datamatrix barcode.
Default value: DataMatrixEncodeMode.C40.
Parameters:
Name Type Description
value Encode mode of Datamatrix barcode.
Source:

setDataMatrixType(value)

2D Mailmark Type defines size of Data Matrix barcode.
Parameters:
Name Type Description
value Size of Data Matrix barcode
Source:

setDestinationPostCodeAndDPS(value)

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.
Parameters:
Name Type Description
value the Postcode of the Delivery Address with DPS
Source:

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
Parameters:
Name Type Description
value Information type ID
Source:

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.
Parameters:
Name Type Description
value item within the Supply Chain ID
Source:

setRTSFlag()

Flag which indicates what level of Return to Sender service is being requested.
Returns:
Type Description
RTS Flag
Source:

setReturnToSenderPostCode(value)

Contains the Return to Sender Post Code but no DPS.
The PC(without DPS) must comply with a PAF® format.
Parameters:
Name Type Description
value Return to Sender Post Code but no DPS
Source:

setSupplyChainID(value)

Identifies the unique group of customers involved in the mailing.
Max value: 9999999.
Parameters:
Name Type Description
value Supply chain ID
Source:

setUPUCountryID(value)

Identifies the UPU Country ID.Max length: 4 characters.
Parameters:
Name Type Description
value Country ID
Source:

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.
Parameters:
Name Type Description
value Version ID
Source: