Google

Superservice">Prev Chapter 6. Schemas Reference Next

Schemas for the msgstore Superservice

DLF Schema for Message Store service

Schema ID: msgstore

Timestamp Field: time

Each DLF records in the msgstore schema represents one command on the server. Not all fields will be meaningful for every type of action.

Fields in the Schema

time

Type: timestamp

Defaults: 0

The timestamp of the event.

localserver

Type: hostname

Defaults: -

The hostname on which the message store is running. In the case of message store proxies, this will be the target server.

client_name

Type: hostname

Defaults: -

The host name of the client related to the event.

client_ip

Type: ip

Defaults: -

The ip address of the client related to the event.

user

Type: string

Defaults: -

The user name of the authenticated user associated with the connection.

protocol

Type: string

Defaults: -

The protocol used to access the message store. This will be usually one of pop or imap.

prot_cmd

Type: string

Defaults: -

The command executed by the client. Defined commands are login, badlogin, select, create, etc.

session

Type: string

Defaults: -

A session identifier used to relate the different records to one sesssion. Session identifier can be reused.

messages_downloaded

Type: int

Defaults: 0

Number of messages downloaded.

bytes_downloaded

Type: bytes

Defaults: -

Number of bytes downloaded messages.

stored_messages

Type: int

Defaults: 0

Number of messages stored on the server.

stored_size

Type: int

Defaults: 0

Size of the messages stored on the server.

session_duration

Type: duration

Defaults: 0

The length of the session.

Note

FIXME: When this field should be defined. On all events or only on the quit event?

status

Type: string

Defaults: -

The status of the event. This includes the error messages or other success information (like an MMP redirection).