1pop3d::udb(n) Tcl POP3 Server Package pop3d::udb(n)
2______________________________________________________________________________
6
8 pop3d::udb - Simple user database for pop3d
9
11 package require Tcl 8.2
12 package require pop3d::udb ?1.0.1?
14 ::pop3d::udb::new ?dbName?
16 dbName option ?arg arg ...?
18 dbName destroy
20 dbName add user pwd storage
22 dbName remove user
24 dbName rename user newName
26 dbName lookup user
28 dbName exists user
30 dbName who
32 dbName save ?file?
34 dbName read file
36______________________________________________________________________________
38
40 The package pop3d::udb provides simple in memory databases which can be
41 used in conjunction with the pop3 server core provided by the package
42 pop3d. The databases will use the names of users as keys and associates
43 passwords and storage references with them.
44 Objects created by this package can be directly used in the authentica‐
46 tion callback of pop3 servers following the same interface as servers
47 created by the package pop3d.
48 ::pop3d::udb::new ?dbName?
50 This command creates a new database object with an associated
51 global Tcl command whose name is dbName.
52 The command dbName may be used to invoke various operations on the
54 database. It has the following general form:
55 dbName option ?arg arg ...?
57 Option and the args determine the exact behavior of the command.
58 The following commands are possible for database objects:
60 dbName destroy
62 Destroys the database object.
63 dbName add user pwd storage
65 Add a new user or changes the data of an existing user. Stores
66 password and storage reference for the given user.
67 dbName remove user
69 Removes the specified user from the database.
70 dbName rename user newName
72 Changes the name of the specified user to newName.
73 dbName lookup user
75 Searches the database for the specified user and returns a two-
76 element list containing the associated password and storage ref‐
77 erence, in this order. Throws an error if the user could not be
78 found. This is the interface as expected by the authentication
79 callback of package pop3d.
80 dbName exists user
82 Returns true if the specified user is known to the database,
83 else false.
84 dbName who
86 Returns a list of users known to the database.
87 dbName save ?file?
89 Saves the contents of the database into the given file. If the
90 file is not specified the system will use the path last used in
91 a call to dbName read. The generated file can be read by the
92 read method.
93 dbName read file
95 Reads the specified file and adds the contained user definitions
96 to the database. As the file is actually source'd a safe inter‐
97 preter is employed to safeguard against malicious code. This
98 interpreter knows the add command for adding users and their
99 associated data to this database. This command has the same
100 argument signature as the method add. The path of the file is
101 remembered internally so that it can be used in the next call of
102 dbName save without an argument.
103
105 This document, and the package it describes, will undoubtedly contain
106 bugs and other problems. Please report such in the category pop3d of
107 the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
108 also report any ideas for enhancements you may have for either package
109 and/or documentation.
110 When proposing code changes, please provide unified diffs, i.e the out‐
112 put of diff -u.
113 Note further that attachments are strongly preferred over inlined
115 patches. Attachments can be made by going to the Edit form of the
116 ticket immediately after its creation, and then using the left-most
117 button in the secondary navigation bar.
118
120 internet, network, pop3, protocol
121
123 Networking
124
126 Copyright (c) 2002 Andreas Kupries <andreas_kupries@users.sourceforge.net>
127tcllib 1.0.1 pop3d::udb(n)