IMAPD(8)

NAME
imapd - Courier-IMAP server

SYNOPSIS
/usr/local/libexec/couriertcpd couriertcpd options /usr/local/sbin/imaplogin [ modules ... ] /usr/local/bin/imapd ./Maildir /usr/local/bin/imapd ./Maildir

DESCRIPTION

imapd is the Courier-IMAP server that provides IMAP access to Maildir mailboxes. Normally you don't have to worry about it, as imapd runs automatically after receiving a network connection, accompanied by the appropriate userid and password.

couriertcpd opens network ports that receive incoming IMAP connections. After an incoming network connections is established, couriertcpd runs the command specified by its first argument, which is imaplogin passing the remaining arguments to imaplogin. imaplogin reads the IMAP login userid and password, then runs the modules specified by its remaining options, which are Courier authentication modules described in the authlib(7) manual page.

The last daisy-chained command is imapd, which is the actual IMAP server, which is started from the logged-in account's home directory. The sole argument to imapd is the pathname to the default IMAP mailbox, which is usually ./Maildir. Some authentication modules are capable of specifying a different filename, by setting the MAILDIR environment variable.

imapd may also be invoked from the shell prompt, in which case it issues a PREAUTH response, then changes the current directory to either its argument, or the contents of the MAILDIR environment variable, then attempts to talk IMAP on standard input and output.

imapd implements IMAP4REV1, as defined by RFC 2060.

FILES AND ENVIRONMENT VARIABLES

AUTH*
    imapd examines several environment variables whose names start with AUTH - these environment variables are set by imaplogin and the authentication modules. Their absence tells imapd that it's running from the command line.

MAILDIR
    MAILDIR - if defined, imapd changes its directory to the one specified by this environment variable. Otherwise imapd changes its directory to the one specified on the command line.

`pwd`/.
    The current directory is assumed to be the main INBOX Maildir.

`pwd`/.folder
    Maildir folders, each one containing their own tmp, new, cur, etc...

Other environment variables are initialized from the /usr/local/etc/courier/imapd and /usr/local/etc/courier/imapd-ssl configuration files. These files are loaded into the environment by the system startup script that runs couriertcpd.

SEE ALSO

authlib(7), userdb(8)