Versions Compared

Key

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


This plugin is no longer maintained. Official support for this implementation ends ended on 5/31/2018.

Version 1.3.2

Table of Contents

Hub Email Extension overview

...

  1. Log in to the Hub.
  2. In the hamburger menu on the left, select Administration.
  3. On the Administration page, select Hub Extensions.
  4. On the Hub Extensions page, select Hub Email Extension.
  5. On the Hub Email Extension page in the Extension Configuration section, complete the following fields:
    1. Mail SMTP Server Host: Type the URL for your email server. For authenticated SMTP servers, the user name and password must be manually configured in the extension.properties file. For more information on configuring a connection to authenticated SMTP servers, refer to JavaMail Configuration on page .
    2. Mail SMTP Server Port: Type the SMTP port number for your email server.
    3. Email From Address: Type the name which is seen by the email recipient as the email sender.
    4. Email Reply To Address: Type the email from address which is seen by the email recipient. This is used as the reply address if the recipient chooses to reply.
    5. Default Subject Line: Type the email subject line. It can be helpful to recipients if you specify Daily digest in the subject line.
    6. Default Logo Image(optional): Type the path to the image to be used for your custom logo that appears in emails. If no custom logo is specified, the default logo image is the Black Duck logo. If only a file name is provided, then the system looks to see if the file exists in the Images folder of the Hub Email Extension. If the full path for the image is provided, the system verifies that the image file exists at the path specified on the system where the extension is running.
  6. Click Save.

By default, all users are opted-in for the email digest. Administrator users can edit the user.configuration.json file to globally opt all users in or out. Users can configure their personal settings to opt-in or opt-out on an individual basis. For more information, refer to Hub Email Extension user configuration.

Hub Email Extension user configuration

...

Note
Because Hub extensions require Cron job settings using Cron expressions and syntax, reference websites and examples are provided in Cron Reference Information for Hub Extensions.

JavaMail configuration

The Hub Email Extension supports JavaMail configuration properties. This is achieved by adding properties to the extension.properties file beginning with the prefix hub.email.javamail.config. This allows an administrator of the extension to configure the full set of JavaMail properties as outlined on the Oracle website:
https://docs.oracle.com/javaee/7/api/javax/mail/package-summary.html
If you are using an authenticated SMTP server, specify the following properties in your extension.properties file to configure the user name and password.

...

Note
After removing the Hub Email Extension, the installation and configuration files remain on your system. Therefore, you can reinstall the Hub Email Extension at any time. For more information, refer to the Hub Email Extension installation section.

Cron reference information for Hub extensions

...

Hub Email Extension Release Notes

Changes in release 1.3.2
  • Compatibility with Hub version 4.5.0.
  • Resolved an issue involving a null pointer error (NPE) on Hub 4.5.0.
  • Resolved an authentication error with Hub 4.5.0.
Changes in release 1.3.0
  • Added support for automatically importing the certificate.
  • Added support for manually importing the certificate.
  • Added support for the always-trust server certificate.
  • Added support for applying Hub proxy settings.
Changes in release 1.2.1
  • Added information about creating email extension-named volumes.
  • Resolved an issue wherein emails may contain duplicated contents if the project has the same vulnerabilities or policies in the same version. 
  • Added a process for restarting the Hub email extension container.
Changes in release 1.2.0
  • Added a Dockerized installation option.
  • Incorporated additional stability enhancements.
Changes in release 1.1.1
  • Addressed an issue with refreshing the user token.
  • Test emails now accept case-sensitive email addresses.
Changes in release 1.1.0
  • Notification emails are now available in real-time as notification events occur.
  • New installation and configuration procedures for both Hub and non-Hub server installations.
Changes in release 1.0.0
  • First release of Black Duck Hub Email Extension.

...