---

NAME db/user

db/user - lookup existing recipients (users) plugin for the database plugin suite

go top

---

VERSION 2007.1

go top

---

DESCRIPTION

Enable user-level validation of addresses so that qpsmtpd can readily bounce invalid messages at the smtp level.

It does this by looking up the recipient address resp. user and host part of the email address in a database.

The inspiration of this module comes from a mailer setup with qpsmtpd and exim, where exim is used to manage virtual accounts in a database as described on http://flakey.info/mailserver/ or http://www.xmn-berlin.de/~marte/exim/exim4_mysql_amavis_spamassasin.html

go top

---

REQUIREMENTS

db/user requires the plugin db/common to be installed.

It requires the Perl modules

 Qpsmtpd::DSN

It's tested with qpsmtpd 0.32 and MySQL as database.

go top

---

CONFIGURATION

/etc/qpsmtpd/plugins

All other database plugins must follow the basic plugin db/base - e.g.:

 db/base
 db/relay
 db/user
 db/greylist

/etc/qpsmtpd/db_user

Parameter	Example	Optional/Default
email_table	email_table=emailtable
domain_table	domain_table=emailtable
email_address	email_address=
email_user	email_user=local_part
email_domain	email_domain=domain
email_enabled	email_enabled=is_enabled	optional
email_enabled_value	email_enabled_value=yes	optional
domain_domain	domain_domain=domain

How the fields are used

• email_table=table name
  The name of the table to look up the email address.
• domain_table=table name
  The name of the table to look up the domain part of the email address. It can be the same table as email_table but using another field.
• email_address=field name
  
• email_user=field name
  
• email_domain=field name
  These entries tell db/user which database fields to use for the lookup in the table email_table. If the field email_address is given, email_user and email_domain are ignored and vice versa.
• email_enabled=field name
  Optional field of the table email_table to decide, wether the mailbox of the user is temporary disabled or not.
• email_enabled_value=boolean value
  If the field email_enabled is given, email_enabled_value must be given too. Examples for the value are: 1, yes, TRUE etc. depending, how the field is configured in the database.
• domain_domain=field name
  This entry tells db/user which database field to use for the lookup in the table domain_table.

go top

---

CONSTRUCTOR METHODS

init

Call: $self->init ( $qp )

• $qp
  Qpsmtpd object

Called from qpsmtpd on startup.

Calls isa_plugin('db/common') and db/common::init ( $qp ).

go top

db_init_config

Call: $self->db_init_config ( $config_fields, $config_fields_empty, $config_fields_default )

• $config_fields, $config_fields_empty, $config_fields_default
  Empty references to hashes

Called from db/common::init.

Sets the local config hashes. See CONFIGURATION.

go top

db_valid_config

Call: $self->db_valid_config ()

Called from db/common::init.

If the field email_address is given, email_user and email_domain are set to undef and vice versa.

If the field email_enabled is given, email_enabled_value must be present.

If notify_email is given, assures that notify_email and notify_from by calling db/common::db_valid_email.

Calls db/common::db_die on errors.

On errors in db_valid_config qpsmtpd won't start.

go top

---

HOOKS

hook_rcpt

Calls user_email_record and user_domain_record if db/common::db_rec is emtpy.

Returns:

db/common::db_declined	no decision, log entries:
Local address '...@...'	if address belongs to a virtual user of our domain(s).
Foreign address '...@...'	if address is not in our domain(s).
Qpsmtpd::DSN->mbox_disabled	reject the message, log entry/message:
Mailbox '...@...' disabled, not accepting messages	if not email_enabled
Qpsmtpd::DSN->no_such_user	reject the message, log entry/message:
Address '...@...' doesn't exist on this server	if user unknown
db/common::db_denysoft_error	on error.

go top

---

HELPER METHODS

user_email_record

Call: $self->user_email_record ( [ $msg ] )

• $msg
  String

Calls db/common::db_open.

Calls db_error and dies with the optional $msg or DB_ERROR.

go top

user_domain_record

Call: $self->user_domain_record ( [ $msg ] )

• $msg
  String

Calls db/common::db_open.

Calls db_error and dies with the optional $msg or DB_ERROR.

go top

go top

---

CREDITS

Thanks to Ask Bjoern Hansen for qpsmtpd.

http://smtpd.develooper.com/

go top

---

COPYRIGHT

(c) Ernesto 2007, ernesto@dienstleistung-kultur.de

http://dienstleistung-kultur.de/qpsmtpd/

go top

---

LICENCE

As per the qpsmtpd license.

go top