Commit 2cb3da7f authored by Jonas S Karlsson's avatar Jonas S Karlsson

Added preliminary documentation for aux-items for supporting importer

and exporter of email to lyskom.
parent 2b34af95
\input texinfo @c -*-texinfo-*-
@c $Id: Protocol-A.texi,v 1.36 1998/10/11 11:50:34 ceder Exp $
@c $Id: Protocol-A.texi,v 1.37 1998/10/11 15:21:32 jsk Exp $
@c %**start of header
@settitle LysKOM Protocol A
......@@ -884,8 +884,87 @@ The data should be the client name, a space, and the client version used
in the @code{set-client-version} call. The server may enforce this
@end table
@item x-author [15] (text)
For imported texts using email gateway. Data is a string with
the (readable) name of the author.
Kom clients should show this field instead of the id of the importing kom-id.
@item x-from [16] (text)
Data is a plain email addres, the From: field from an imported email.
Used by the kom client to construct an email reply to an imported text.
@item x-reply-to [17] (text)
Data is a plain email addres, comes from the Reply-To: field
@item x-to [18] (text)
Data is one email address can be in variable format. Multiple text-items
can be present. The format is the same as is allowed in To: fields in
emails. If the text is imported these are the other receivers as seen in
the email. If the text originates from a kom-person (and thus not an
importer) this field is used in constructing an email, if an exporter
is present.
@item x-cc [19] (text)
Data in the same format as for "x-to". Usage the same but will
be a carbon copy instead.
@item x-date [20] (text)
Data is the send-date of a imported email. Can be in free format, even
if a readable format, such as "YYYY-MM-DD hh:mm:ss", is preferred. Kom
client should display this date as originating date, date of the
imported text entity in kom may be different (and can be shown as
received). In case of the text being exported from kom, this date is set
by the exporter.
@item x-msgid [21] (text)
Data is a string which is the message id from the imported email.
Preferably the importer should only add receivers when importing the
same email more times with the same msg-id. When a text is exported,
the x-msgid is constructed as an email address which contains
the kom text number and server in an unique way.
@item x-inreplyto [22] (text)
Data is a string which stores the message id of texts commented.
For each such text a kom (comment) link should be creaeted by the
importer if these referenced emails previously has been imported.
@item x-misc [23] (text)
Data is a string with the rest of the fields from an imported
email. Is set by the importer. The fields are concatenated with
@item x-allow-filter [24] (conf)
Data is a regexp string which allows a sender (a field in the
email-header) to import the message. Several can exist, it is enough if
one matches (OR) and none dissallows (AND). Can be set by an organizer
of the conference.
The regexp allows ^[]?* as constructs. The importer is required to check these when
adding recipient of an imported text and comply. Example of usage:
"From:**", "From:*jsk*". Tests are not made on the text-body.
However, if the string starts with a "!" the email will be rejected if
the rest matches, even if one of the filter allowed it. Example:
"!From:*aol*", "!Subject:*money*".
@item x-reject-forward [25] (conf)
Data is a string with either an email name on the format
"" or a kom-conference "C:num" number. The mail is
forwarded if it was rejected by "x-import-filter" to this address.
@end table
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment