Class isds_envelope¶
Class isds_envelope¶
-
class
isds.
isds_envelope
¶ ISDS envelope.
This class holds the envelope content.
-
dbIDRecipient
¶ Recipient data box identifier (7 characters).
Note: Madatory. Type: string
-
dbIDSender
¶ Sender data box identifier (7 characters).
Note: Special value ‘aaaaaaa’ means sent by ISDS. Type: string
-
dmAcceptanceTime
¶ Message acceptance time.
Note: A copy of the value is returned when read. A copy of the value is stored when written. Type: isds_time
-
dmAllowSubstDelivery
¶ Allow delivery through fiction.
Note: Even if recipient did not read this message the message is considered to be delivered after (currently) 10 days. This is delivery through fiction. This applies only to OVM dbType sender. Type: bool
-
dmAmbiguousRecipient
¶ Recipient has OVM role.
Type: bool
-
dmAnnotation
¶ Subject (title) of the message (max 255 characters).
Note: Mandatory. Type: string
-
dmAttachmentSize
¶ Rounded dize of message documents in kilobytes.
Type: int
-
dmDeliveryTime
¶ Message delivery time.
Note: A copy of the value is returned when read. A copy of the value is stored when written. Type: isds_time
-
dmID
¶ Message identifier.
Note: Message identifiers are integers but are stored as strings. Type: string
-
dmLegalTitleLaw
¶ Number of act mandating authority.
Type: int
-
dmLegalTitlePar
¶ Paragraph of act mandating authority. Czech: odstavec.
Type: string
-
dmLegalTitlePoint
¶ Point of act mandating authority. Czech: písmeno.
Type: string
-
dmLegalTitleSect
¶ Section of act mandating authority. Czech: paragraf.
Type: string
-
dmLegalTitleYear
¶ Year of act issue mandating authority.
Type: int
-
dmMessageStatus
¶ Message state.
Type: isds_message_status
-
dmOVM
¶ OVM sending mode.
Note: Optional. Non-OVM dbType boxes that has dbEffectiveOVM == True MUST select between True (OVM mode) and False (non-OVM mode). Note: Implicit value is True. Type: bool
-
dmOrdinal
¶ Ordinal number in list of incoming/outgoing messages.
Type: int
-
dmPersonalDelivery
¶ If True then only person with higher privileges can read this message.
Type: bool
-
dmPublishOwnID
¶ Allow sender to express his name. It shall be available to recipient using
isds_ctx.isds_get_message_sender()
. Sender type will be always available. Default value is False.Note: Optional. Type: bool
-
dmRecipient
¶ Recipient name (max 100 characters).
Type: string
-
dmRecipientAddress
¶ Recipient postal address (max 100 chracters).
Type: string
-
dmRecipientIdent
¶ Czech: spisová značka příjemce (max 50 characters).
Note: Optional. Type: string
-
dmRecipientOrgUnit
¶ Recipient organisation unit.
Note: Optional. Type: string
-
dmRecipientOrgUnitNum
¶ Recipient organisation unit number.
Note: Optional. Type: int
-
dmRecipientRefNumber
¶ Czech: jednací číslo příjemce (max 50 characters).
Note: Optional. Type: string
-
dmSender
¶ Sender name (max 100 characters).
Type: string
-
dmSenderAddress
¶ Sender postal address (max 100 characters).
Type: string
-
dmSenderIdent
¶ Czech: spisová značka odesílatele (max 50 characters).
Note: Optional. Type: string
-
dmSenderOrgUnit
¶ Sender organisation unit.
Note: Optional. Type: string
-
dmSenderOrgUnitNum
¶ Sender organisation unit number.
Note: Optional. Type: int
-
dmSenderRefNumber
¶ Czech: jednací číslo odesílatele (max 50 characters).
Note: Optional. Type: string
-
dmSenderType
¶ Approximate sender data box type.
Type: int
-
dmToHands
¶ Person in recipient organisation.
Note: Optional. Type: string
-
dmType
¶ Message type (commercial subtypes or government message):
Note: The length is exactly 1 UTF-8 character. Type: string - Use these input values (when sending a message):
- ‘I’ - commercial message offering the payment of the response (initiatory message); then it’s necessary to define
dmSenderRefNumber
. - ‘K’ - commercial message paid by sender if this message
- ‘O’ - commercial response paid by sender of initiatory message; it’s necessary to copy value from
dmSenderRefNumber
of initiatory message todmRecipientRefNumber
of the response message - ‘V’ - non-commercial government message
- ‘I’ - commercial message offering the payment of the response (initiatory message); then it’s necessary to define
Default value while sending may is undefined which has the same meaning as ‘V’.
- Output values (when retrieving a message):
- ‘A’ - subsidized initiatory commercial message which can pay a response
- ‘B’ - subsidized initiatory commercial message which has already paid the response
- ‘C’ - subsidized initiatory commercial message where the response offer has expired
- ‘D’ - externally subsidized commercial message
- ‘E’ - commercial message prepaid by a stamp
- ‘G’ - commercial message paid by a sponsor
- ‘I’
- ‘K’
- ‘O’
- ‘V’
- ‘X’ - initiatory commercial message where the response offer has expired
- ‘Y’ - initiatory commercial message which has already paid the response
- ‘Z’ - limitedly subsidized commercial message
-
events
¶ List of events.
Note: A copy of the value is returned when read. A copy of the value is stored when written. Type: list of isds_event
-
hash
¶ Message hash.
Note: A copy of the value is returned when read. A copy of the value is stored when written. Type: isds_hash
-
timestamp
¶ Envelope time stamp.
Note: A copy of the value is returned when read. A copy of the value is stored when written. Note: You may also use the bytes type when storing the value. Type: bytearray
-