Introducing the all-new TIBCO Community site!

For current users, please click "Sign In" to reset your password and access the enhanced features. If you're a first-time visitor, we extend a warm welcome—click "Sign Up" to become a part of the TIBCO Community!

If you're seeking alternative community sites, explore ibi, Jaspersoft, and Spotfire.

Jump to content
  • Configure Email Notifications in TIBCO Mashery®


    Manoj Chaurasia

    Table of Contents

    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:

    EventDescription
    New Comment and Forum TopicsNotification to email recipient when a new comment or forum topic is posted on the site
    New Member RegistrationConfirmation email to the new member when registering for a portal account
    New Application CreatedNotification to administrative staff when a member creates a new application
    New Key IssuedNotification to the requestor and to administrative staff containing the generated API key

    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.

       

      portal.png.999f3fc9c6b67855df7dbbbff94964cb.png

    3. Then click Notifications.

       

      notifications_0.png.d4988a43a7be0cafc4e4a7d50bbbddca.png

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

       

      emails_0.png.b2587123e7ee5d9823ec0a6e97c31542.png

    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:

       

       

      NotificationFieldDescription
      New Member RegistrationFrom EmailAddress from which emails are sent. See Before You Begin above.
       From NameWithin the email, the name that appears in the 'From' address field
       Bcc EmailAdditional email address(es) to send a blind copy of the notification
       SubjectSubject field in the email notification
       BodyText you wish to appear in the body of the email notification
      New Key IssuedFrom EmailAddress from which emails are sent. See Before You Begin above.
       From NameWithin the email, the name that appears in the 'From' address field
       Bcc EmailAdditional email address(es) to send a blind copy of the notification
       SubjectSubject field in the email notification
       BodyText 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.

    emailvars.png.72c573c12044a05e83b5ed3a52e25e7f.png

     

     

     

    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

    User Feedback

    Recommended Comments

    There are no comments to display.


×
×
  • Create New...