NAME

OpenXPKI::Server::Notification::SMTP - Notification via SMTP

Description

This class implements a notifier that sends out notification as plain plain text message using Net::SMTP. The templates for the mails are read from the filesystem.

Configuration

    backend:
        class: OpenXPKI::Server::Notification::SMTP
        host: localhost
        helo: my.own.fqdn
        port: 25
        starttls: 0
        username: smtpuser
        password: smtppass
        debug: 0
        use_html: 0
    default:
        to: "[% cert_info.requestor_email %]"
        from: no-reply@openxpki.org
        reply: helpdesk@openxpki.org
        sender: envelope-sender@openxpki.org
        cc: helpdesk@openxpki.org
        prefix: PKI-Request [% meta_wf_id %]
    template:
        dir:   /home/pkiadm/democa/mails/
    message:
        csr_created:
            default:
                template: csr_created_user
                subject: CSR for [% cert_subject %]
            raop:
                template: csr_created_raop  # Suffix .txt is always added!
                to: ra-officer@openxpki.org
                reply: "[% cert_info.requestor_email %]"
                subject: New CSR for [% cert_subject %]

Calling the notifier with "MESSAGE=csr_created" will send out two mails. One to the requestor and one to the ra-officer, both are CC'ed to helpdesk.

Recipients and Headers

to: Must be a single address, can be a template toolkit string.
cc: Can be a single address or a list of address seperated by a single comma. The string is processed by template toolkit and afterwards splitted into a list at the comma, so you can use loop/join to create multiple recipients.
If you directly pass an array, each item is processed using template toolkit but must return a single address.
from: Sets the from address, can be an email adress or a verbose sender name with the email address in angle brackets. Can be a toolkit template.
reply: Similar to from, sets the Reply-To header field.
sender: Sets the Sender field in the header, if not given this defaults to the from address, if you pass the empty string the value is set to the local unix user account running the OpenXPKI service.
prefix: A prefix that is added to each subject line.

Note: The settings To, Cc and Prefix are stored in the workflow on the first message and reused for each subsequent message on the same channel, so you can gurantee that each message in a thread is sent to the same people. All settings from default can be overriden in the local definition. Defaults can be blanked using an empty string.

Sign outgoing mails using SMIME

Outgoing emails can be signed using SMIME, add this section on the top

level:

    smime:
        certificate_key_file: /usr/local/etc/openxpki/local/smime.key
        certificate_file: /usr/local/etc/openxpki/local/smime.crt
        certificate_key_password: secret

Key and certificate must be PEM encoded, password can be omitted if the key is not encrypted. Key/cert can be provided by a PKCS12 file using certificate_p12_file (PKCS12 support requires Crypt::SMIME 0.17!).

NAME

Description

Configuration

Recipients and Headers

Sign outgoing mails using SMIME

Functions

notify

_send_message