updated manual authored by Martin Straka's avatar Martin Straka
......@@ -69,7 +69,8 @@ The following options (services) are related to actions that should be performed
* *otpcode* - Certificate password | Hardware security code. [Optional] **WARNING: SMS security code not supported now!**
* *certificate* - Path to certificate file (DER, PEM). [Optional] **WARNING: not supported now!**
Return [status]
Return
* [status] - 0 is success, 1 error.
Example:
......@@ -85,7 +86,9 @@ datovka --login "username='xxxxxx',password='yyyyyyyy',certificate='C:\temp\cert
* *dmFromTime* - Delivery time from. Format: YYYY-MM-DD. [Optional] **WARNING: not supported now!**
* *dmToTime* - Delivery time to. Format: YYYY-MM-DD. [Optional] **WARNING: not supported now!**
Return [status, {stdout::list of new message ID}]
Return
* [status] - 0 is success, 1 error.
* newMsgIdList - print to **stdout** list of new message IDs separated by whitespace.
Example:
......@@ -113,7 +116,10 @@ datovka --login "username='xxxxxx',password='yyyyyyyy'" --get-msg-list "dmType='
* *dmPublishOwnID* - Allow sender to express his name shall be available to recipient. Values: {0,1}, default is 0.
* *dmAttachment* - Full path to target files separated by semicolons. NOTE: "Semicolon" is not allowed in attachment path or file name! It can cause failure during parse of parameter string. [Mandatory]
Return [dmID, status]
Return
* [status] - 0 is success, 1 error.
* msgID - print to **stdout** sent message ID.
Example:
......@@ -129,7 +135,12 @@ datovka --login "username='xxxxxx'" --send-msg "dbIDRecipient='yyyyyyy;zzzzzzz',
* *download* - Values: {yes,no,ondemand}. Specifies whether to download the message from ISDS server (no = never download, use from database if present; yes = always download even if does already exist in database; ondemand = download only if doesn't exist in database). Default is ondemand. [Optional]
* *markDownload* - Set message as locally readed. Values: {yes,no}, default is no. [Optional]
Return [msgStruct, status, (ZFO file)]
Return
* [status] - 0 is success, 1 error.
* Insert/update message data in the message database and set message as locally read if it was set.
* Message ZFO file saved to target path if was set.
* All attachment files saved to target path if was set.
Example:
......@@ -142,7 +153,10 @@ datovka --login "username='xxxxxx'" --get-msg "dmID='123456789',dmType='received
* *zfoFile* - Full path where delivery info ZFO file will be saved. If not specified, delivery info will be stored only to database. [Optional]
* *download* - Values: {yes,no,ondemand}. Specifies whether to download the message from ISDS server (no = never download, use from database if present; yes = always download even if does already exist in database; ondemand = download only if doesn't exist in database). Default is ondemand. [Optional]
Return [deliveryStruct, status, (ZFO file)]
Return
* [status] - 0 is success, 1 error.
* Insert/update delivery info data in the message database.
* Delivery info ZFO file saved to target path if was set.
Example:
......@@ -152,7 +166,9 @@ datovka --login "username='xxxxxx',password='yyyyyyyy'" --get-delivery-info "dmI
**--get-user-info**
Return [userInfoStruct, status]
Return
* [status] - 0 is success, 1 error.
* Insert/update user info in the account database.
Example:
......@@ -162,7 +178,9 @@ datovka --login "username='xxxxxx',password='yyyyyyyy',otpcode='zzzzzzz'" --get-
**--get-owner-info**
Return [ownerInfoStruct, status]
Return
* [status] - 0 is success, 1 error.
* Insert/update owner info in the account database.
Example:
......@@ -173,7 +191,9 @@ datovka --login "username='xxxxxx',password='yyyyyyyy'" --get-owner-info
**--check-attachment**
Return [msgIDsList, status]
Return
* [status] - 0 is success, 1 error.
* newMsgIdList - print to **stdout** list of message IDs separated by white-space where attachment missing.
Example:
......
......