Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About

Our OSGi based producted products may include this SMTP Connector plugin. This article described how for describes what this the plugin is useddoes, how it is configured and how it can be used.

...

Some of our OSGi based main products (like DR) have the possibility to send alerting messagedmessages. These products don’t have its own implementation of SMTP clients. They will use this plugin in order use the centralized funtionality of the SMTP Connector Plugin to do this job.

An applying product are sending a mail by calling the plugin with the topic and the message.

The SMTP plugin do have instances configured for special topics and recipients. It sends the message can use multiple SMTP Instances with different mail server, topic and recipient configurations. Messages are sent to all instances where matching the topic matches. The instances can have multiple recipients.(s) specified in their configuration.

VCS

https://gitlab.kgs-software.com/OSGi/kgs-smtp-connector-plugin.git

Configuration

Global

  • enter Enter the configuration dialogue in the product’s Webconsole via OSGi =-> Configuration =-> Global SMTP Configuration in the menu

  • Display UTC Time: if false it takes local time.

Instance

  • enter config SMTP plugin by : Main => KGS SMTP Connector

    Image Removed
  • then you enter the SMTP connector instance manager

    Image Removed
  • create an instance using the New Instance button

  • enter the instance by using the configure button (rack-wheel icon)

    Image Removed
  • fill the formNavigat to ‘Main' -> 'KGS SMTP Connector’ in the Webconsole menu to find the SMTP Connector configuration UI

    Image Added
  • After clicking ‘Instance manager’ on the left side, you should see the list of configured SMTP instances

    Image Added
  • You can create new instances using the ‘New Instance’ button on the right. Upon entering a name and pressing the ‘create’ button the list will show the new instance

  • To open the configuration dialog for an instance click the gear icon in the instance’s row

    Image Added
  • The configuration parameters are as follows

Config item

meaning

default

StartAutomaticallyno

meaning<not applicable>

SMTPHost

the The SMTP server hostserver’s hostname

SMTPUsername

SMTP sender. An email address.username

SMTPPassword

SMTP password. Required if TLS is used.

Email From

an email address which is the ordinatorThe address used in the E-Mail’s From field
(info) from plugin v. 1.0.3

EmailReceipient(s)

a A comma separated list of email receipients for this instance. For complete format please consult https://javaee.github.io/javamail/docs/api/javax/mail/internet/InternetAddress.html#parse-java.lang.String-

Topic(s)

the A comma separated list of matching topics the instance should receive messages for this instance

SMTPSecurity

none | TLS

none

UseAuthentication

only used if TLS is used

false

Topics

Using plugins may have defined fixed topics. Oher Some Products using the SMPT Connector Plugin use fixed topic names to send messages to. Others may have configurable topics. Please refer to the using plugin documentation of the Product in question.

Further Links