.TH s/qmail: qmail-vmailuser 8

.SH "NAME"
qmail-vmailuser \- recipient maildir validation 

.SH "SYNOPSIS"
.B qmail-vmailuser
.I [homedir]
.I [-C]
.SH "DESCRIPTION"
.B qmail-vmailuser
is a maildir verification PAM supporting 
.I VMailMgr 
and 
.I Vpopmail 
users for virtual domains.
Invoked via 
.BR qmail-smtpd 's
recipient mechanism, it checks the
existence of the recipient directory
for the provisioned virtual users in
.IR SQMAIL/control/virtualusers . 

.B qmail-vmailuser
follows 
.BR checkpassword 's
interface specification evaluating the 
SMTP forwarding path (RCPT TO:) taken from 
discriptor 3 with a length of max 128 bytes.

The forwarding path 
.I vuser@domain
is tokenized to determine the 
virtual user in
.I SQMAIL/control/virtualusers
given by
.I domain
in the first step and then validating for
.I vuser
the existance of (v)user's mail directory
in lower case while substituting dots by colons.
.SH "USAGE" 
.B qmail-vmailuser
is called as PAM from
.BR qmail-smtpd 's
control file
.IR SQMAIL/control/recipients :

.EX
  domain|bin/qmail-vmailuser
  *|bin/qmail-vmailuser /homedir -C
.EE

No specific settings are required to support
either 
.I VMailMgr 
or 
.IR Vpopmail , 
except for the 
.I homedir 
and perhaps the option
.I -C
evaluating 
.I vuser 
in case respect mode.
Since
.I homedir 
defaults mostly to
.IR /home ,
this argument can be omitted.
.SH "SECURITY"
For successfull operation
.B qmail-vmailuser
requires to stat
.IR vuser 's
directory though without reading 
it's actual contents. Due to
restrictions given by 
.IR Vpopmail ,
.B qmail-vmailuser
needs to belong to 
.I vpopmail:vchkpw
or gnerally to be
root-owned and 'sticky'.
.SH "RETURN CODES"
If for the provided
.I vuser@domain
the user directory does not exist
.B qmail-vmailuser
exits 1.
If
.B qmail-vmailuser
is misused, it may instead exit 2.
If there is a temporary problem,
.B qmail-vmailuser
exits 111.
In case
.B qmail-vmailuser
can't read
.I SQMAIL/control/recipients
it exits 110.
.SH "SEE ALSO"
addresses(5),
envelopes(5),
qmail-send(8),
qmail-smtpd(8),
qmail-recipients(8),
qmail-authuser(8).