Configure Email Notifications in TIBCO Mashery®

Table of Contents

• Introduction
• Before You Begin
• SMTP Authentication
• Setting Up Email Notifications
• Email Variables

Introduction

You can configure email notifications in TIBCO Mashery^® to be sent when specific events occur. Notifications can be sent for each of the following events:

Before You Begin

Before you configure your email notifications, you must decide what should be the "from" email account and email name.

The "from" email is the address from which all emails generated by the developer portal will be sent. This must be a valid email address and must be able to receive and accept an authentication email.

Mashery typically suggests using the formats:

• Email account - noreply@<customername>.com, for example noreply@Mashery.com
• Email name - <customername> API, for example Mashery API

SMTP Authentication

In order to allow emails to be sent without being blocked by spam filters, Mashery uses an authenticated SMTP service.

To configure for SMTP authentication:

1. Notify Mashery of your chosen email account and email name.
2. Mashery inputs your new email account, and sends a confirmation email from AuthSMTP.
3. Open the confirmation email, and click the link within. This enables the AuthSMTP service for your email account.
4. If appropriate, add authSMTP.com to your SPF records.
5. If you have Sender Policy Framework (SPF) in your domain, you must add authSMTP.com to your SPF record. To check this, use the following command line:

    dig -t TXT YOURDOMAIN | grep 'spf'

    

   You should see output similar to the following:

    YOURDOMAIN. 3600 IN TXT "v=spf1 ptr ip4:74.205.62.0/24 ip4:64.13.137.192/27 ip4:75.34.104.100 a:authsmtp.com -all" 

Setting Up Email Notifications

To configure/manage email notifications there are two sections that need to be configured. First is a list of Notification email address that will be informed when an event occurs:

1. Click the Dashboard link in the upper right corner of your Portal website.
2. Click the Manage dropdown and select Portal.

    

   

3. Then click Notifications.

    

   

4. For the events you wish to configure emails for, enter a comma separated list of addresses.

    

   

For New Member and New Key registrations we can also control some of the email content/format.

1. Navigate to the Emails "Tab".
2. Enter the necessary information:

    

    

   Notification	Field	Description
   New Member Registration	From Email	Address from which emails are sent. See Before You Begin above.
   	From Name	Within the email, the name that appears in the 'From' address field
   	Bcc Email	Additional email address(es) to send a blind copy of the notification
   	Subject	Subject field in the email notification
   	Body	Text you wish to appear in the body of the email notification
   New Key Issued	From Email	Address from which emails are sent. See Before You Begin above.
   	From Name	Within the email, the name that appears in the 'From' address field
   	Bcc Email	Additional email address(es) to send a blind copy of the notification
   	Subject	Subject field in the email notification
   	Body	Text you wish to appear in the body of the email notification

Email Variables

Within the Emails tab you can use various runtime variables to customize the output. For example we are setting a subject header using the recipents moniker.

Use the list below of available variables to help customize your notification.

Available variables are:

• member_email
• member_first_name
• member_last_name
• member_handle
• member_moniker
• member_uri
• member_blog
• member_im
• member_imsvc
• member_phone
• member_company
• member_address1
• member_address2
• member_city_or_town
• member_state_province_abbr
• member_zip_code
• member_country_code
• api_key - developer key
• api_moniker - name of the Service as defined in the dashboard, for example "Mashery API"
• area_subj - portal name entered in the Settings -> Portal Setup page
• registered_app - application name the developer just registered