Inherits IComplexCodetext.

Public Member Functions
None	__init__ (self)
	Create default instance of Mailmark2DCodetext class. More...

EncodeTypes	barcode_type (self)

Optional[str]	class_ (self)
	Identifies the class of the item. More...

None	class_ (self, str value)
	Identifies the class of the item. More...

Optional[str]	constructed_codetext (self)

Optional[str]	customer_content (self)
	Optional space for use by customer. More...

None	customer_content (self, str value)
	Optional space for use by customer. More...

DataMatrixEncodeMode	customer_content_encode_mode (self)
	Encode mode of Datamatrix barcode. More...

None	customer_content_encode_mode (self, DataMatrixEncodeMode value)
	Encode mode of Datamatrix barcode. More...

Mailmark2DType	data_matrix_type (self)
	2D Mailmark Type defines size of Data Matrix barcode. More...

None	data_matrix_type (self, Mailmark2DType value)
	2D Mailmark Type defines size of Data Matrix barcode. More...

Optional[str]	destination_postcode_dps (self)
	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. More...

None	destination_postcode_dps (self, str value)
	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. More...

Optional[str]	information_type_id (self)
	Identifies the Royal Mail Mailmark barcode payload for each product type. More...

None	information_type_id (self, str value)
	Identifies the Royal Mail Mailmark barcode payload for each product type. More...

None	init_from_string (self, str constructed_codetext)

int	item_id (self)
	Every Mailmark barcode is required to carry an ID Max value: 99999999. More...

None	item_id (self, int value)
	Identifies the unique item within the Supply Chain ID. More...

Optional[str]	return_to_sender_postcode (self)
	Contains the Return to Sender Post Code but no DPS. More...

None	return_to_sender_postcode (self, str value)
	Contains the Return to Sender Post Code but no DPS. More...

Optional[str]	rts_flag (self)
	Flag which indicates what level of Return to Sender service is being requested. More...

None	rts_flag (self, str value)
	Flag which indicates what level of Return to Sender service is being requested. More...

int	supply_chain_id (self)
	Identifies the unique group of customers involved in the mailing. More...

None	supply_chain_id (self, int value)
	Identifies the unique group of customers involved in the mailing. More...

Optional[str]	upu_country_id (self)
	Identifies the UPU Country ID.Max length: 4 characters. More...

None	upu_country_id (self, str value)
	Identifies the UPU Country ID.Max length: 4 characters. More...

Optional[str]	version_id (self)
	Identifies the barcode version as relevant to each Information Type ID. More...

None	version_id (self, str value)
	Identifies the barcode version as relevant to each Information Type ID. More...

Public Member Functions inherited from IComplexCodetext
def	__init__ (self, _java_class)

Constructor & Destructor Documentation

◆ init()

None __init__ ( self )

Create default instance of Mailmark2DCodetext class.

Member Function Documentation

◆ barcode_type()

EncodeTypes barcode_type ( self )

Gets barcode type.

Reimplemented from IComplexCodetext.

◆ class_() [1/2]

Optional[str] class_ ( self )

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

◆ class_() [2/2]

None class_	(		self,
		str	value
	)

Identifies the class of the item.

Parameters

value 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

◆ constructed_codetext()

Optional[str] constructed_codetext ( self )

Construct codetext from Mailmark data.

Reimplemented from IComplexCodetext.

◆ customer_content() [1/2]

Optional[str] customer_content ( self )

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

◆ customer_content() [2/2]

None customer_content	(		self,
		str	value
	)

Optional space for use by customer.

Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

Parameters

value Customer content

◆ customer_content_encode_mode() [1/2]

DataMatrixEncodeMode customer_content_encode_mode ( self )

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.C40.

Returns: Encode mode of Datamatrix barcode.

◆ customer_content_encode_mode() [2/2]

None customer_content_encode_mode	(		self,
		DataMatrixEncodeMode	value
	)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.C40.

Parameters

value: Encode mode of Datamatrix barcode.

◆ data_matrix_type() [1/2]

Mailmark2DType data_matrix_type ( self )

2D Mailmark Type defines size of Data Matrix barcode.

Returns: : Size of Data Matrix barcode

◆ data_matrix_type() [2/2]

None data_matrix_type	(		self,
		Mailmark2DType	value
	)

2D Mailmark Type defines size of Data Matrix barcode.

Parameters

value: Size of Data Matrix barcode

◆ destination_postcode_dps() [1/2]

Optional[str] destination_postcode_dps ( self )

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

◆ destination_postcode_dps() [2/2]

None destination_postcode_dps	(		self,
		str	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

value: the Postcode of the Delivery Address with DPS

◆ information_type_id() [1/2]

Optional[str] information_type_id ( self )

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

◆ information_type_id() [2/2]

None information_type_id	(		self,
		str	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

value Information type ID

◆ init_from_string()

None init_from_string	(		self,
		str	constructed_codetext
	)

Initialize Mailmark data from constructed codetext.

Reimplemented from IComplexCodetext.

◆ item_id() [1/2]

int item_id ( self )

Every Mailmark barcode is required to carry an ID Max value: 99999999.

Returns: : item within the Supply Chain ID

◆ item_id() [2/2]

None item_id	(		self,
		int	value
	)

Identifies the unique item within the Supply Chain ID.

Every Mailmark barcode is required to carry an ID Max value: 99999999.

◆ return_to_sender_postcode() [1/2]

Optional[str] return_to_sender_postcode ( self )

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

◆ return_to_sender_postcode() [2/2]

None return_to_sender_postcode	(		self,
		str	value
	)

Contains the Return to Sender Post Code but no DPS.

The PC(without DPS) must comply with a PAF® format.

Parameters

value: Return to Sender Post Code but no DPS

◆ rts_flag() [1/2]

Optional[str] rts_flag ( self )

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

Returns: RTS Flag

◆ rts_flag() [2/2]

None rts_flag	(		self,
		str	value
	)

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

Parameters

value: RTS Flag

◆ supply_chain_id() [1/2]

int supply_chain_id ( self )

Identifies the unique group of customers involved in the mailing.

Max value: 9999999.

Returns: Supply chain ID

◆ supply_chain_id() [2/2]

None supply_chain_id	(		self,
		int	value
	)

Identifies the unique group of customers involved in the mailing.

Max value: 9999999. @param:: value: Supply chain ID

◆ upu_country_id() [1/2]

Optional[str] upu_country_id ( self )

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

Returns: Country ID

◆ upu_country_id() [2/2]

None upu_country_id	(		self,
		str	value
	)

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

Parameters

value Country ID

◆ version_id() [1/2]

Optional[str] version_id ( self )

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

◆ version_id() [2/2]

None version_id	(		self,
		str	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

value Version ID

Public Member Functions

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ barcode_type()

◆ class_() [1/2]

◆ class_() [2/2]

◆ constructed_codetext()

◆ customer_content() [1/2]

◆ customer_content() [2/2]

◆ customer_content_encode_mode() [1/2]

◆ customer_content_encode_mode() [2/2]

◆ data_matrix_type() [1/2]

◆ data_matrix_type() [2/2]

◆ destination_postcode_dps() [1/2]

◆ destination_postcode_dps() [2/2]

◆ information_type_id() [1/2]

◆ information_type_id() [2/2]

◆ init_from_string()

◆ item_id() [1/2]

◆ item_id() [2/2]

◆ return_to_sender_postcode() [1/2]

◆ return_to_sender_postcode() [2/2]

◆ rts_flag() [1/2]

◆ rts_flag() [2/2]

◆ supply_chain_id() [1/2]

◆ supply_chain_id() [2/2]

◆ upu_country_id() [1/2]

◆ upu_country_id() [2/2]

◆ version_id() [1/2]

◆ version_id() [2/2]

◆ init()