qpsmtpd/lib/Qpsmtpd/Constants.pm

package Qpsmtpd::Constants;
use strict;
require Exporter;

my (@common) = qw(OK DECLINED DONE DENY DENYSOFT TRACE DISCARD);

use vars qw($VERSION @ISA @EXPORT);
@ISA    = qw(Exporter);
@EXPORT = @common;

use constant TRACE => 10;

use constant OK       => 900;
use constant DENY     => 901;
use constant DENYSOFT => 902;
use constant DECLINED => 909;
use constant DONE     => 910;
use constant DISCARD  => 920;


1;


=head1 NAME

Qpsmtpd::Constants - Constants for plugins to use

=head1 CONSTANTS

See L<README.plugins> for hook specific information on applicable
constants.

Constants available:

=over 4

=item C<OK>

Return this only from the queue phase to indicate the mail was queued
successfully.

=item C<DENY>

Returning this from a hook causes a 5xx error (hard failure) to be
returned to the connecting client.

=item C<DENYSOFT>

Returning this from a hook causes a 4xx error (temporary failure - try
again later) to be returned to the connecting client.

=item C<DECLINED>

Returning this from a hook implies success, but tells qpsmtpd to go
on to the next plugin.

=item C<DONE>

Returning this from a hook implies success, but tells qpsmtpd to
skip any remaining plugins for this phase.

=item C<DISCARD>

This can only be returned for the DATA phase. It tells qpsmtpd to
return 250 to the client implying delivery success, but silently
drops the email.

=back

=cut