Wydawca (split by node):   Section:   Chapter:FastBack: configuring   Up: mod_mailutils   FastForward: wydawca.conf   Contents: Table of ContentsIndex: Concept Index

4.15.3.4 module-config for mod_mailutils

When mod_mailutils is used in the notify-event block, the following statements can be used in module-config to configure it:

notify-event {
    module mailutils;
    # module configuration
    module-config {
        # Notify this recipient
        recipient who;

        # Sign message with this key
        gpg-sign key;

        # Text of the notification or identifier of a defined message
        # template
        message text-or-id;
    }
}
mod_mailutils config: recipient who

Determines who should receive the notification. The following values for who are allowed:

read
message

Read recipients from the ‘To’, ‘Cc’ and ‘Bcc’ headers of the message. This is the default.

admin

The system administrator, as defined in admin-address statement (see admin-address).

owner

Administrators of the project for which the files where uploaded. Their addresses are retrieved from the ‘project-owner’ dictionary (see dictionaries).

user

User name of the user who uploaded files.

mod_mailutils config: gpg-sign key

If this statement is present, the message will be signed using the supplied GPG key. The key is looked up in the GPG home directory (see gpg-homedir).

mod_mailutils config: message text-or-id

Define the message text. The argument is either the message text template, or a reference to a template previously defined by a define-message (see templates).

The following macro-variables are expanded in the message texts:

VariableReplaced with
projectProject system name.
urlURL of the distribution site.
spoolName of the spool (see spool).
dirDirectory (relative to the project distribution root) where the files where uploaded.
dest-dirValue of the destination keyword.
source-dirValue of the source keyword.
triplet:distFile name of the main distribution file.
triplet:sigFile name of the detached signature file.
triplet:dirFile name of the directive file.
triplet:ls:fullA full listing of the uploaded triplet8.
triplet:ls:uploadListing of the uploaded files (see below).
triplet:ls:distListing of the main distribution file (see below).
triplet:ls:sigListing of the detached signature file (see below).
triplet:ls:dirListing of the directive file (see below).
userSystem name of the user who uploaded the triplet.
user:nameSystem name of the user who uploaded the triplet.
user:real-nameReal name of the user who uploaded the triplet.
user:emailEmail of the user who uploaded the triplet.
email:adminFull9. email address of the systems administrator, as set by the ‘admin-address’ (see admin-address).
email:ownerFull email address of the project administrator (owner).
email:userFull email address of the user who did the upload. Equivalent to ‘"${user:real-name}" <${user:email}>’.
check:resultCode returned by external checker, in decimal. See check-result, for a detailed description.
check:diagnDiagnostics text returned by external checker. See verification, for a detailed description.

Listings referred to in the table above, are similar to those produced by the ls command, and include information on file permissions, ownership, size and modification date. For example, here is a possible ${triplet:ls:full} listing:

-rw-r--r-- gray users 2707278 2007-09-06 22:14:35 tar-1.18.tar.gz
-rw-r--r-- gray users     189 2007-09-06 22:14:35 tar-1.18.tar.gz.sig
-rw-r--r-- gray user       62 2007-09-06 22:14:35 tar-1.18.tar.gz.directive.asc

The example in the following subsection shows how to configure success notification for the user.

Footnotes

(8)

It is equivalent to:

${triplet:ls:dist}
${triplet:ls:sig}
${triplet:ls:dir}
(9)

Full here means an email address with eventual personal part

Wydawca (split by node):   Section:   Chapter:FastBack: configuring   Up: mod_mailutils   FastForward: wydawca.conf   Contents: Table of ContentsIndex: Concept Index