MailmarkCodetext

MailmarkCodetext class

Module: aspose_barcode.complex_barcode.mailmark_codetext

Inherits: IComplexCodetext

Class for encoding and decoding the text embedded in the 4-state Royal Mailmark code.

Constructors

NameDescription
initInitializes a new instance of the MailmarkCodetext class.

Methods

NameReturn TypeStaticDescription
barcode_typeEncodeTypesNoGets barcode type.
constructed_codetextOptional[str]NoConstruct codetext from Mailmark data.
init_from_stringNoneNoInitializes Mailmark data from constructed codetext.

Properties

NameTypeDescription
class_str“0” - None or Test “1” - 1C (Retail) “2” - 2C (Retail) “3” - 3C (Retail) “4” - Premium (RetailPublishing Mail) (for potential future use) “5” - Deferred (Retail) “6” - Air (Retail) (for potential future use) “7” - Surface (Retail) (for potential future use) “8” - Premium (Network Access) “9” - Standard (Network Access)
destination_post_code_plus_dpsstrThe PC and DP must comply with a PAF format. Nine character string denoting international “XY11 " (note the 5 trailing spaces) or a pattern of characters denoting a domestic sorting code. A domestic sorting code consists of an outward postcode, an inward postcode, and a Delivery Point Suffix.
formatint“0” – None or Test “1” – Letter “2” – Large Letter
item_idintMaximum value is 99999999.
supplychain_idintMaximum values are 99 for Barcode C and 999999 for Barcode L.
version_idintCurrently “1” – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use)

MailmarkCodetext Constructor

__init__(self)

Initializes a new instance of the MailmarkCodetext class.

MailmarkCodetext.barcode_type

barcode_type(self) -> EncodeTypes

Gets barcode type.

Return Type: EncodeTypes — Barcode type.

MailmarkCodetext.constructed_codetext

constructed_codetext(self) -> Optional[str]

Construct codetext from Mailmark data.

Return Type: Optional[str] — Constructed codetext

MailmarkCodetext.init_from_string

init_from_string(self, str constructed_codetext)

Initializes Mailmark data from constructed codetext.

ParameterTypeDescription
constructed_codetextstr

MailmarkCodetext.class_

Type: str

“0” - None or Test “1” - 1C (Retail) “2” - 2C (Retail) “3” - 3C (Retail) “4” - Premium (RetailPublishing Mail) (for potential future use) “5” - Deferred (Retail) “6” - Air (Retail) (for potential future use) “7” - Surface (Retail) (for potential future use) “8” - Premium (Network Access) “9” - Standard (Network Access)

ParameterTypeDescription
valuestr

MailmarkCodetext.destination_post_code_plus_dps

Type: str

The PC and DP must comply with a PAF format. Nine character string denoting international “XY11 " (note the 5 trailing spaces) or a pattern of characters denoting a domestic sorting code. A domestic sorting code consists of an outward postcode, an inward postcode, and a Delivery Point Suffix.

The PC and DP must comply with a PAF format. Nine character string denoting international “XY11 " (note the 5 trailing spaces) or a pattern of characters denoting a domestic sorting code. A domestic sorting code consists of an outward postcode, an inward postcode, and a Delivery Point Suffix.

ParameterTypeDescription
valuestr

MailmarkCodetext.format

Type: int

“0” – None or Test “1” – Letter “2” – Large Letter

“0” – None or Test “1” – LetterN “2” – Large Letter

ParameterTypeDescription
valueint

MailmarkCodetext.item_id

Type: int

Maximum value is 99999999.

Maximum value is 99999999.

ParameterTypeDescription
valueint

MailmarkCodetext.supplychain_id

Type: int

Maximum values are 99 for Barcode C and 999999 for Barcode L.

Maximum values are 99 for Barcode C and 999999 for Barcode L.

ParameterTypeDescription
valueint

MailmarkCodetext.version_id

Type: int

Currently “1” – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use)

Currently “1” – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use)

ParameterTypeDescription
valueint