[//000000001]: # (pop3d \- Tcl POP3 Server Package) [//000000002]: # (Generated from file 'pop3d\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2002\-2009 Andreas Kupries ) [//000000004]: # (Copyright © 2005 Reinhard Max ) [//000000005]: # (pop3d\(n\) 1\.1\.0 tcllib "Tcl POP3 Server Package")
[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]
# NAME pop3d \- Tcl POP3 server implementation # Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [Options](#section2) - [Authentication](#section3) - [Mailboxes](#section4) - [Secure mail transfer](#section5) - [References](#section6) - [Bugs, Ideas, Feedback](#section7) - [Keywords](#keywords) - [Category](#category) - [Copyright](#copyright) # SYNOPSIS package require Tcl 8\.3 package require pop3d ?1\.1\.0? [__::pop3d::new__ ?*serverName*?](#1) [__serverName__ *option* ?*arg arg \.\.\.*?](#2) [*serverName* __up__](#3) [*serverName* __down__](#4) [*serverName* __destroy__ ?*mode*?](#5) [*serverName* __configure__](#6) [*serverName* __configure__ *\-option*](#7) [*serverName* __configure__ *\-option value*\.\.\.](#8) [*serverName* __cget__ *\-option*](#9) [*serverName* __conn__ list](#10) [*serverName* __conn__ state *id*](#11) [*authCmd* __exists__ *name*](#12) [*authCmd* __lookup__ *name*](#13) [*storageCmd* __dele__ *mbox* *msgList*](#14) [*storageCmd* __lock__ *mbox*](#15) [*storageCmd* __unlock__ *mbox*](#16) [*storageCmd* __size__ *mbox* ?*msgId*?](#17) [*storageCmd* __stat__ *mbox*](#18) [*storageCmd* __get__ *mbox* *msgId*](#19) # DESCRIPTION - __::pop3d::new__ ?*serverName*? This command creates a new server object with an associated global Tcl command whose name is *serverName*\. The command __serverName__ may be used to invoke various operations on the server\. It has the following general form: - __serverName__ *option* ?*arg arg \.\.\.*? *Option* and the *arg*s determine the exact behavior of the command\. A pop3 server can be started on any port the caller has permission for from the operating system\. The default port will be 110, which is the port defined by the standard specified in RFC 1939 \([http://www\.rfc\-editor\.org/rfc/rfc1939\.txt](http://www\.rfc\-editor\.org/rfc/rfc1939\.txt)\)\. After creating, configuring and starting a the server object will listen for and accept connections on that port and handle them according to the POP3 protocol\. *Note:* The server provided by this module will handle only the basic protocol by itself\. For the higher levels of user authentication and handling of the actual mailbox contents callbacks will be invoked\. The following commands are possible for server objects: - *serverName* __up__ After this call the server will listen for connections on its configured port\. - *serverName* __down__ After this call the server will stop listening for connections\. This does not affect existing connections\. - *serverName* __destroy__ ?*mode*? Destroys the server object\. Currently open connections are handled depending on the chosen mode\. The provided *mode*s are: * __kill__ Destroys the server immediately, and forcefully closes all currently open connections\. This is the default mode\. * __defer__ Stops the server from accepting new connections and will actually destroy it only after the last of the currently open connections for the server is closed\. - *serverName* __configure__ Returns a list containing all options and their current values in a format suitable for use by the command __array set__\. The options themselves are described in section [Options](#section2)\. - *serverName* __configure__ *\-option* Returns the current value of the specified option\. This is an alias for the method __cget__\. The options themselves are described in section [Options](#section2)\. - *serverName* __configure__ *\-option value*\.\.\. Sets the specified option to the provided value\. The options themselves are described in section [Options](#section2)\. - *serverName* __cget__ *\-option* Returns the current value of the specified option\. The options themselves are described in section [Options](#section2)\. - *serverName* __conn__ list Returns a list containing the ids of all connections currently open\. - *serverName* __conn__ state *id* Returns a list suitable for \[__array set__\] containing the state of the connection referenced by *id*\. # Options The following options are available to pop3 server objects\. - __\-port__ *port* Defines the *port* to listen on for new connections\. Default is 110\. This option is a bit special\. If *port* is set to "0" the server, or rather the operating system, will select a free port on its own\. When querying __\-port__ the id of this chosen port will be returned\. Changing the port while the server is up will neither change the returned value, nor will it change on which port the server is listening on\. Only after resetting the server via a call to __down__ followed by a call to __up__ will the new port take effect\. It is at that time that the value returned when querying __\-port__ will change too\. - __\-auth__ *command* Defines a *command* prefix to call whenever the authentication of a user is required\. If no such command is specified the server will reject all users\. The interface which has to be provided by the command prefix is described in section [Authentication](#section3)\. - __\-storage__ *command* Defines a *command* prefix to call whenever the handling of mailbox contents is required\. If no such command is specified the server will claim that all mailboxes are empty\. The interface which has to be provided by the command prefix is described in section [Mailboxes](#section4)\. - __\-socket__ *command* Defines a *command* prefix to call for opening the listening socket\. This can be used to make the pop3 server listen on a SSL socket as provided by the __[tls](\.\./\.\./\.\./\.\./index\.md\#tls)__ package, see the command __tls::socket__\. # Authentication Here we describe the interface which has to be provided by the authentication callback so that pop3 servers following the interface of this module are able to use it\. - *authCmd* __exists__ *name* This method is given a user*name* and has to return a boolean value telling whether or not the specified user exists\. - *authCmd* __lookup__ *name* This method is given a user*name* and has to return a two\-element list containing the password for this user and a storage reference, in this order\. The storage reference is passed unchanged to the storage callback, see sections [Options](#section2) and [Mailboxes](#section4) for either the option defining it and or the interface to provide, respectively\. # Mailboxes Here we describe the interface which has to be provided by the storage callback so that pop3 servers following the interface of this module are able to use it\. The *mbox* argument is the storage reference as returned by the __lookup__ method of the authentication command, see section [Authentication](#section3)\. - *storageCmd* __dele__ *mbox* *msgList* Deletes the messages whose numeric ids are contained in the *msgList* from the mailbox specified via *mbox*\. - *storageCmd* __lock__ *mbox* This method locks the specified mailbox for use by a single connection to the server\. This is necessary to prevent havoc if several connections to the same mailbox are open\. The complementary method is __unlock__\. The command will return true if the lock could be set successfully or false if not\. - *storageCmd* __unlock__ *mbox* This is the complementary method to __lock__, it revokes the lock on the specified mailbox\. - *storageCmd* __size__ *mbox* ?*msgId*? Determines the size of the message specified through its id in *msgId*, in bytes, and returns this number\. The command will return the size of the whole maildrop if no message id was specified\. - *storageCmd* __stat__ *mbox* Determines the number of messages in the specified mailbox and returns this number\. - *storageCmd* __get__ *mbox* *msgId* Returns a handle for the specified message\. This handle is a mime token following the interface described in the documentation of package __[mime](\.\./mime/mime\.md)__\. The pop3 server will use the functionality of the mime token to send the mail to the requestor at the other end of a pop3 connection\. # Secure mail transfer The option __\-socket__ \(see [Options](#section2)\) enables users of the package to override how the server opens its listening socket\. The envisioned main use is the specification of the __tls::socket__ command, see package __[tls](\.\./\.\./\.\./\.\./index\.md\#tls)__, to secure the communication\. package require tls tls::init \ ... pop3d::new S -socket tls::socket ... # References 1. [RFC 1939](http://www\.rfc\-editor\.org/rfc/rfc1939\.txt) 1. [RFC 2449](http://www\.rfc\-editor\.org/rfc/rfc2449\.txt) # 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](http://core\.tcl\.tk/tcllib/reportlist)\. 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](\.\./\.\./\.\./\.\./index\.md\#internet), [network](\.\./\.\./\.\./\.\./index\.md\#network), [pop3](\.\./\.\./\.\./\.\./index\.md\#pop3), [protocol](\.\./\.\./\.\./\.\./index\.md\#protocol), [rfc 1939](\.\./\.\./\.\./\.\./index\.md\#rfc\_1939), [secure](\.\./\.\./\.\./\.\./index\.md\#secure), [ssl](\.\./\.\./\.\./\.\./index\.md\#ssl), [tls](\.\./\.\./\.\./\.\./index\.md\#tls) # CATEGORY Networking # COPYRIGHT Copyright © 2002\-2009 Andreas Kupries Copyright © 2005 Reinhard Max