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 DRtia® Document Router for example) 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 functionality 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 the topic matches. The instances can have multiple recipients.
VCS
https://gitlab.kgs-software.com/OSGi/kgs-smtp-connector-plugin.git
matching the topic(s) specified in their configuration.
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
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 formNavigat to ‘Main' -> 'KGS SMTP Connector’ in the Webconsole menu to find the SMTP Connector configuration UI
After clicking ‘Instance manager’ on the left side, you should see the list of configured SMTP instances
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
The configuration parameters are as follows
Config item | meaning | default | |
|---|---|---|---|
StartAutomaticallyno | meaning<not applicable> | ||
SMTPHost | the SMTP server hostThe SMTP server’s hostname | ||
SMTPPort | The SMTP port is adjustable for TLS | ||
SMTPUsername | SMTP user name. Required is authentification is enabledusername | ||
SMTPPassword | SMTP password. Required is authentification is enabledif TLS is used | ||
Email From | The address used in the E-Mail’s From field | ||
EmailReceipient(s) | a A comma separated list of email receipients for this instance | ||
Topic(s) | the A comma separated list of matching topics the instance should receive messages for this instance | ||
SMTPSecurity | none | TLS | none | |
UseAuthentication | if set to true, SMTPUsernama and SMTPPassword is required to authentificate agains SMTP server | falseonly used if TLS is used | false |
Topics
Some KGS products making use of the SMTP Connector Plugin use fixed topic names to send messages to. Others may have configurable topics. Please refer to the documentation of the product in question.