INTERFACE between ratatosk library and the interface

The full text of the legal notice is contained in the file called COPYRIGHT, included with this distribution.

This file documents the tcl entities which the ratatosk C-library defines. It also defines which tcl-functions the C-library expects the interface to provide.

COMMANDS AND ENTITIES PROVIDED BY THE LIBRARY

TCL COMMANDS THE LIBRARY EXPECTS THE INTERFACE TO PROVIDE

RatLog level message duration

Delivers a message from the library to the interface. The message is a string and level is a number with the following meaning:

0	babble messages from library, doesn't have to be shown
1	parse error, should probably be shown in some situations
2	informative message, should be displayed
3	warning messages, should be displayed
4	error, should be acknowledged by the user
5	fatal, the application is about to die

The duration is an optional argument and can have a value of "time" or "explicit". If the value is explicit the a handle will be returned, and this handle can then be used in a call to RatClearLog

RatFormatDate year month day hour min sec

This command gets a date expressed as numbers and is expected to return a string.

RatWantSave

This command should ask the user if he wants to save an outgoing message. If the answer is no nothing is returned. If the answer is yes a the answer must look like one of these: {file } or {dbase }.

RatLogin host trial user prot port

The host mentioned in the arguments requires an username and password for this user. The trial argiument says how many tries we already have done. The user is the user we should try to log in as and prot is the protocol we are going to use. Finally port is the portnumber we will contact the remote host at. The routine should return a list of three elements {user passwd store} when store is a boolean indicating if we should store the password on disk or not.

RatDSNRecieve subject action recipient id A DSN has arrived for the mentioned message and recipient. Please notify the user.

UpdateDSN

Gets called from the library when new DSN(s) arrive.