Page Comparison

...

Follow the instructions below to enable notifications for new API versions:

Set the email server configurations in the <API-M_HOME>/repository/conf/output-event-adapters.xml file under the <adapterConfig type="email"> section.

Code Block

 <adapterConfig type="email">
        <!-- Comment mail.smtp.user and mail.smtp.password properties to support connecting SMTP servers which use trust
        based authentication rather username/password authentication -->
        <property key="mail.smtp.from">abcd@gmail.com</property>
        <property key="mail.smtp.user">abcd</property>
        <property key="mail.smtp.password">xxxx</property>
        <property key="mail.smtp.host">smtp.gmail.com</property>
        <property key="mail.smtp.port">587</property>
        <property key="mail.smtp.starttls.enable">true</property>
        <property key="mail.smtp.auth">true</property>
        <!-- Thread Pool Related Properties -->
        <property key="minThread">8</property>
        <property key="maxThread">100</property>
        <property key="keepAliveTimeInMillis">20000</property>
        <property key="jobQueueSize">10000</property>
    </adapterConfig>

Property	Description
mail.smtp.from	Email address which you want to use to send Email.
mail.smtp.user	Email address which used to authenticate the mail server. This can be same as "mail.smtp.from"
mail.smtp.password	Password which used to authenticate the mail server.

Log in to the Management Console and click Main > Resource > Browse.
Browse to the /_system/config/apimgt/applicationdata/tenant-conf.json file and click Edit as Text.

Set the NotificationsEnabled property to true as shown below:

Code Block

language	java

"NotificationsEnabled":"true",
  "Notifications":[{
    "Type":"new_api_version",
    "Notifiers" :[{
      "Class":"org.wso2.carbon.apimgt.impl.notification.NewAPIVersionEmailNotifier",
      "ClaimsRetrieverImplClass":"org.wso2.carbon.apimgt.impl.token.DefaultClaimsRetriever",
      "Title": "Version $2 of $1 Released",
      "Template": " <html> <body> <h3 style=\"color:Black;\">We’re happy to announce the arrival of the next major version $2 of $1 API which is now available in Our API Store.</h3><a href=\"https://localhost:9443/store\">Click here to Visit WSO2 API Store</a></body></html>" 

    }]
  }
  ]

A notification type can have multiple notifier classes that help send multiple notifications. Each notifier has a class attribute containing the full class path. The following properties should be set for the default NewAPIVersionEmailNotifier class:

Property Description

Class The full class path of the notifier class.

ClaimsRetrieverImplClass

Subscriber email addresses are extracted from user claims. The default pack uses the org.wso2.carbon.apimgt.impl.token.DefaultClaimsRetriever class to read the claim values from the user store.

Note

title	Claims

A claim is a piece of information about a particular subject. It can be anything that the subject is owned by or associated with, such as name, group, preferences, etc. Refer Configuring Cliams for more information on how to add new claim mappings

Title The subject of the email.

Template The template of the email body. This can be string values or a valid registry path to a template file.

The following strings are replaced with API specific values in the Title and Template properties.

$1 - API name

$2 - New API version

$3 - API provider email

$4 - API version of the original API

Versions Compared

Old Version 7

New Version 8

Key