summaryrefslogtreecommitdiff
path: root/man/bincimapd.9
diff options
context:
space:
mode:
Diffstat (limited to 'man/bincimapd.9')
-rw-r--r--man/bincimapd.9148
1 files changed, 148 insertions, 0 deletions
diff --git a/man/bincimapd.9 b/man/bincimapd.9
new file mode 100644
index 0000000..5e42551
--- /dev/null
+++ b/man/bincimapd.9
@@ -0,0 +1,148 @@
+.TH bincimapd 1
+.SH "NAME"
+bincimapd \- IMAP4rev1 server
+.SH "SYNOPSIS"
+.B bincimap-up [options] -- <authenticator> bincimapd <maildepot>
+
+.B bincimap-up -- SQMAIL/bin/qmail-authuser bincimapd Maildir
+.SH "DESCRIPTION"
+.B bincimapd
+implements the IMAP interface to the user's
+.I <maildepot>
+by name which could be
+.I Maildir++
+or
+.I IMAPdir
+structured.
+Upon invocation
+.B bincimapd
+switches to the home directory available by the user environment
+and performs the commanded IMAP operations on the given
+.IR <maildepot> .
+.SH "CONFIGURATION"
+.B bincimapd
+shares the same environment variables with
+.BR bincimap-up ,
+thus there is no specific configuration required and therefore
+.I [...]
+is usually avoided, except for
+its first unqualified argument containing the name of the
+mailbox depository in which
+.B bincimapd
+should search for folders. If unset, some authenticators like
+.B qmail-authuser
+and
+.B vmailmgr
+will fail. However,
+.B bincimapd
+runs in the environment of the user and honors the
+a specific setting of environment variables to cope
+local preferences.
+.SH "COMPLIANCE"
+.B bincimapd
+conforms partially to IMAP4rev1 (RFCs 3501, 2177 [Idle], 2341 [Namespace],
+2971 [Id]).
+Alphabetic list of supported IMAP commands:
+.IP \[bu] 2
+Append
+.IP \[bu] 2
+Authenticate
+.IP \[bu] 2
+Capability
+.IP \[bu] 2
+Check
+.IP \[bu] 2
+Close
+.IP \[bu] 2
+Copy
+.IP \[bu] 2
+Create
+.IP \[bu] 2
+Delete
+.IP \[bu] 2
+Examine
+.IP \[bu] 2
+Expunge
+.IP \[bu] 2
+Fetch
+.IP \[bu] 2
+Id
+.IP \[bu] 2
+Idle
+.IP \[bu] 2
+List
+.IP \[bu] 2
+Login
+.IP \[bu] 2
+Logout
+.IP \[bu] 2
+Lsub
+.IP \[bu] 2
+Namespace
+.IP \[bu] 2
+Noop
+.IP \[bu] 2
+Rename
+.IP \[bu] 2
+Search
+.IP \[bu] 2
+Select
+.IP \[bu] 2
+Starttls
+.IP \[bu] 2
+Status
+.IP \[bu] 2
+Store
+.IP \[bu] 2
+Subscribe
+.IP \[bu] 2
+Unsubscribe
+.SH "FILES"
+Within every
+.I <maildepot>
+subdirectory
+.B bincimpad
+generates a set of files
+.TP
+.I $HOME/<maildepot>/.../bincimap-uidvalidity
+This file contains a version number, the
+.BR UIDNEXT ,
+and
+.B UIDVALIDITY
+values for the given mailbox.
+.TP
+.I $HOME/<maildepot>/.../bincimap-cache
+This file contains a version number, and it stores the
+.B UID
+values for each message, along with (optionally) some cached
+information.
+
+.RE
+Exception:
+.TP
+.I $HOME/<maildepot>/.subscribed
+All subscribed <mailboxes> are included here.
+.SH "LOGGING"
+After the user login
+.B bincimapd
+displays the
+.IR PID ,
+.IR userid ,
+and
+.I IP address.
+On logout or disconnect
+it provides the
+.IR PID ,
+the number of messages fetched
+.IR Bodies:\ n ,
+and the number of IMAP commands executed
+.IR Statements:\ m .
+.SH "COPYRIGHT"
+Copyright (C) 2002-2005 Andreas Aardal Hanssen, 2023 Erwin Hoffmann
+
+This is free software; see the LICENSE for copying conditions.
+There is NO warranty.
+.SH "SEE ALSO"
+bincimap(1), bincimap-up(1),
+multilog(8), supervise(8), tcpserver(1), sslserver(1),
+qmail-authuser(7)