About
Our OSGi based producted may include this SMTP Connector plugin. This article described how for what this plugin is used, how it is configured and how it can be used.
Content
Introduction
Some of our OSGi based main products (like DR) have the possibility to send alerting messaged. These products don’t have its own implementation of SMTP clients. They will use this plugin in order 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 to all instances where the topic matches. The instances can have multiple recipients.
VCS
https://gitlab.kgs-software.com/OSGi/kgs-smtp-connector-plugin.git
Configuration
Global
enter the configuration dialogue via OSGi => Configuration => Global SMTP Configuration
Display UTC Time: if false it takes local time.
Instance
enter config SMTP plugin by : Main => KGS SMTP Connector
then you enter the SMTP connector instance manager
create an instance using the New Instance button
enter the instance by using the configure button (rack-wheel icon)
fill the form
Config item | meaning | default |
|---|---|---|
StartAutomatically | no meaning | |
SMTPHost | the SMTP server host | |
SMTPUsername | SMTP sender. An email address. | |
SMTPPassword | SMTP password. Required if TLS is used. | |
EmailReceipient(s) | 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 comma separated list of matching topics for this instance | |
SMTPSecurity | none | TLS | none |
UseAuthentication | only used if TLS is used | false |
Topics
Using plugins may have defined fixed topics. Oher may have configurable topics. Please refer the using plugin documentation.