Julian Mehnle > Courier-Filter-v0.200 > Courier::Config

Download:
courier-filter/Courier-Filter-v0.200.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

Courier::Config - Class providing configuration information for Perl modules related to the Courier MTA

SYNOPSIS ^

    use Courier::Config;
    
    # Courier base configuration:
    my $config_dir          = Courier::Config->config_dir;
    my $runtime_dir         = Courier::Config->runtime_dir;
    my $courier_executable  = Courier::Config->courier_executable;
    my $courier_version     = Courier::Config->courier_version;
    
    # Courier::Filter configuration:
    my $filter_conf_file    = Courier::Config->filter_conf_file;

DESCRIPTION ^

This class provides configuration information for Perl modules related to the Courier MTA, e.g. installation specific file system paths.

Courier base configuration

The following methods provide information about Courier's base configuration:

config_dir: returns string

The base configuration directory of Courier.

runtime_dir: returns string

The directory where Courier keeps the message queue (msgq, msgs, tmp) and courierfilter sockets (filters, allfilters).

courier_executable: returns string

The full path of the Courier daemon executable.

courier_version: returns version

The version number of the Courier installation.

Courier::Filter configuration

The following Courier::Filter configuration information is provided:

filter_conf_file: returns string

The absolute file name of the Courier::Filter courier-filter-perl configuration file.

SEE ALSO ^

For AVAILABILITY, SUPPORT, and LICENSE information, see Courier::Filter::Overview.

AUTHOR ^

Julian Mehnle <julian@mehnle.net>

syntax highlighting: