Sending emails

Goobi Step Plugin for sending emails within a task.

Overview

Name	Wert
Identifier	intranda_step_sendMail
Repository	https://github.com/intranda/goobi-plugin-step-send-mail
Licence	GPL 2.0 or newer
Last change	25.07.2024 11:19:40

Introduction

This documentation describes the installation, configuration and use of the Step Plugin for sending emails within a task in Goobi workflow. The list of recipients and the text can be configured individually for different steps. All fields from the VariableReplacer are also available. This means that metadata or information on the task, step or project can also be accessed.

Installation

The plugin consists in total of the following files to be installed:

plugin-intranda-step-sendMail-base.jar
plugin_intranda_step_sendMail.xml

The first file must be installed in the following directory:

/opt/digiverso/goobi/plugins/step/plugin-intranda-step-sendMail-base.jar

In addition, there is a configuration file that must be located in the following place:

/opt/digiverso/goobi/plugins/config/plugin_intranda_step_sendMail.xml

Overview and functionality

The plugin is usually executed fully automatically within the workflow. It first determines whether there is a block in the configuration file that has been configured for the current workflow with regard to the project name and work step. If this is the case, the mail is generated and sent to the configured recipients.

This plugin is integrated into the workflow in such a way that it is executed automatically. Manual interaction with the plugin is not necessary. For use within a workflow step, it should be configured as shown in the screenshot below.

Integration of the plugin into the workflow

Configuration

The configuration of the plugin is done via the configuration file plugin_intranda_step_sendMail.xml and can be adjusted during operation. The following is an example configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<config_plugin>
    <!--
        order of configuration is:
        1.) project name and step name matches
        2.) step name matches and project is *
        3.) project name matches and step name is *
        4.) project name and step name are *
    -->
    <config>
        <!-- which projects to use for (can be more then one, otherwise use *) -->
        <project>*</project>
        <step>*</step>
        <!-- mail account -->
        <smtpUser>[e-mail]</smtpUser>
        <smtpPassword>password</smtpPassword>

        <!-- server configuration -->
        <smtpServer>example.com</smtpServer>
        <smtpUseStartTls>false</smtpUseStartTls>
        <smtpUseSsl>true</smtpUseSsl>

        <!-- displayed sender address -->
        <smtpSenderAddress>[e-mail]</smtpSenderAddress>
        <!-- receiver, can be repeated -->
        <receiver>[e-mail]</receiver>
        <receiver>[e-mail]</receiver>

        <!-- message -->
        <messageSubject>subject text</messageSubject>
        <messageBody>body &lt;br /&gt; &lt;h1&gt;with html&lt;/h1&gt;</messageBody>
    </config>
</config_plugin>

Parameter	Explanation
project	This parameter determines for which project the current block <config> should apply. The name of the project is used here. This parameter can occur several times per <config> block.
step	This parameter controls for which workflow steps the block <config> should apply. The name of the workflow step is used here. This parameter can occur several times per <config> block.
<smtpServer>	This parameter sets the SMTP server.
<smtpUseStartTls>	This parameter controls whether the access should run like TLS.
<smtpUseSsl>	This sets whether communication should be encrypted via SSL.
<smtpUser>	Dieser Parameter legt den Nutzernamen fest.
<smtpPassword>	This defines the password to be used.
<smtpSenderAddress>	The field <smtpSenderAddress> defines the displayed sender, which can also be different from the user name.
<receiver>	The field <receiver> can be used multiple times and contains the email addresses of the recipients.
<messageSubject>	This parameter allows the subject to be defined. The use of variables is possible here.
<messageBody>	In <messageBody> the mail itself is defined. Plain text or HTML formatted text can be written here. In addition, access to the Goobi variable system is possible here, so that information on the task, project, properties or metadata can also be used in the mail.