test: online/login describes returned error code
[libisds.git] / doc / message
blob3cd300077bda0349d4bee10ca0dcef8d1bb7d8ce
1 Message specification
2 =====================
4 Source: Provozní řád ISDS, version 2009-10-30, Page 13
5 Source: Webové služby ISDS pro manipulaci s datovými zprávami, version 2.6
6     (2010-01-18) [DataMessage_ws.pdf]
8 Message ::= Envelope, Content
10 Message format is defined in Appendinx 1, file dmBaseTypes.xsd.
12 Content ::= (Document)+
14 Content involves one or more attachments (= Documents). Allowed Document
15 formats are defined in Appendix 3 of Vyhláška o stanovení podrobností užívání
16 a provozování ISDS.
18 Currently (2009-11-18) allowed formats are (quotation follows):
20     – pdf (Portable Document Format)
21     – PDF/A (Portable Document Format for the Long-term Archiving)
22     – xml (Extensible Markup Language Document); must be valid against
23     free available XML Schema published by recipient
24     – fo/zfo (602XML Filler dokument)
25     – html/htm (Hypertext Markup Language Document)
26     – odt (Open Document Text)
27     – ods (Open Document Spreadsheet)
28     – odp (Open Document Presentation)
29     – txt (plain text)
30     – rtf (Rich Text Format)
31     – doc (MS Word Document)
32     – xls (MS Excel Spreadsheet)
33     – ppt (MS PowerPoint Presentation)
34     – jpg/jpeg/jfif (Joint Photographic Experts Group File Interchange Format)
35     – png (Portable Network Graphics)
36     – tiff (Tagged Image File Format)
37     – gif (Graphics Interchange Format)
38     – mpeg1/mpeg2 (Moving Picture Experts Group Phase 1 / Phase 2)
39     – wav (Waveform Audio Format)
40     – mp2/mp3 (MPEG-1 Audio Layer 2 / Layer 3)
41     – isdoc/isdocx (Information System Document) version 5.2 or higher
43 Document format declaration inside Document and conformace checks change
44 during time. XML Schemas provide attribute for Document MIME type and Document
45 annotation.
47 Attrimbute dmMimeType must present, but may be empty, may contain file name
48 extension, or may contain official MIME type. If MIME type is declared, ISDS
49 checks Document content for conformance to the MIME type.
51 There is MIME type blacklist: application/x-zip-compressed,
52 application/x-msdownload.
54 Attribute dmFileDescr (so called annotation) must present and must containt
55 file name of the Document. Even if dmMimeType exists, ISDS uses THIS attribute
56 to detect Document format (according file name extension) and checks content
57 for format conformance.
59 There is list of allowed file name extensions: pdf, xml, fo, zfo, html, htm,
60 odt, ods, odp, txt, rtf, doc, xls, ppt, jpg, jpeg, jfif, png, tiff, gif, mpeg1
61 mpeg2, wav, mp2, mp3, isdoc, isdocx, cer, crt, der, pk7, p7b, p7c, p7f, p7m,
62 p7s, tst (time stamp).
64 Document ::= Binary_Document | XML_Document
66 Document is Base64 encoded binary format or XML.
68 There exist special Document type, ESS format, that can exist in Content only
69 once.
71 Note: ESS format is special XML language designed as interface between
72 Electronic Document Systems (ESS). It's defined in Appendix 4 of Provozní řád
73 ISDS.
75 Message with `malicious code' will be refused by ISDS.
77 Maximal total size of Documents in a Message is 10 MB. Binary document size is
78 size before encoding into Base64, XML document size is size in bytes as is
79 serialized inside SOAP request.
81 A Message can be addressed to 50 recipients at maximum.
83 Life time of Message:
85     – 90 days for delivered message
86     – unlimited for delivered through fiction messages, however they can be
87     moved to off-line storage after 90 days. User can request to move the
88     Message back into his box (off-line only currently).
90 Deleted messages are stored off-line as Envelope only without Content.
92 Note: Delivery through fiction is currently defined as new unread for more
93 than 10 days after delivery.
96 Digital Signatures
97 ==================
99 Emeded digital signatures are PKCS#7 to avoid expensive XML canonicalization.
102 System messages
103 ===============
105 There exists special message type iniciated by ISDS (i.e. from system, not from
106 other box). Such message has reserved from-box `aaaaaaa' (7 × `a') value and
107 sender type `0' and it contains always document of type HTML. There are
108 following cases defined:
110 1   Outgoing message contained malicious code
111 2   You, administrator, deleted other user
112 3   Outgoing message could not been delivered because recipeient box had been
113     made unaccessible
114 4   Outgoing commercial message has not been accepted by recipient
115 5   User has been added to the box
116 6   User permissions has been changed
119 Commercial messages
120 ===================
122 Users can allow commercial message receiving explicitelly. Commercial message
123 are not considered as accepted by recipient automatically (in opposite to
124 standard messages), recipient must call ConfirmDelivery to move message from
125 state Delivered (4) to state Received (6).
127 User can request to assign permission to send commercial messages. Permission
128 can be assigned by Czech Post. Commecial recipient can not be searched. Sender
129 must know exact box ID.
131 Commercial message can be recognised by @dmType="K" in message envelope. If
132 @dmType is "V" or attribute is missing, message is so called public (i.e.
133 standard noncommercial with acceptence time outs etc.).
136 Message states
137 ==============
139 Value   Meaning
140 1       Message has been put into ISDS
141 2       Message stamped by TSA
142 3       Message included virues, infected document has been removed
143 4       Message delivered (dmDeliveryTime stored)
144 5       Message delivered through fiction (dmAcceptanceTime stored)
145 6       Message delivered by user login or user explicit request (in case of
146         commercial message) (dmAcceptanceTime stored)
147 7       Message has been read by user
148 8       Message could not been delivered (e.g. recipent box has been made
149         unaccessible meantime)
150 9       Message content deleted (thus can not be obtained on-line)
151 10      Message stored into data safe (this is optional commercial service)