Tcl Library Source Code

Documentation
Login


[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

NAME

pop3d::dbox - Simple mailbox database for pop3d

Table Of Contents

SYNOPSIS

package require Tcl 8.5 9
package require pop3d::dbox ?1.0.3?

::pop3d::dbox::new ?dbName?
dbName option ?arg arg ...?
dbName destroy
dbName base base
dbName add mbox
dbName remove mbox
dbName move old new
dbName list
dbName exists mbox
dbName locked mbox
dbName lock mbox
dbName unlock mbox
dbName stat mbox
dbName size mbox ?msgId?
dbName dele mbox msgList
storageCmd get mbox msgId

DESCRIPTION

The package pop3d::dbox provides simple/basic mailbox management facilities. Each mailbox object manages a single base directory whose subdirectories represent the managed mailboxes. Mails in a mailbox are represented by files in a mailbox directory, where each of these files contains a single mail, both headers and body, in RFC 822 (http://www.rfc-editor.org/rfc/rfc822.txt) conformant format.

Any mailbox object following the interface described below can be used in conjunction with the pop3 server core provided by the package pop3d. It is especially possible to directly use the objects created by this package in the storage callback of pop3 servers following the same interface as servers created by the package pop3d.

The command dbName may be used to invoke various operations on the database. It has the following general form:

The following commands are possible for database objects:

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category pop3d of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

KEYWORDS

internet, network, pop3, protocol, rfc 822

CATEGORY

Networking

COPYRIGHT

Copyright © 2002 Andreas Kupries