Configure Email Notifications

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

Event Description
New Comment and Forum Topics Notification to email recipient when a new comment or forum topic is posted on the site
New Member Registration Confirmation email to the new member when registering for a portal account
New Application Created Notification to administrative staff when a member creates a new application
New Key Issued Notification 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

Back to top

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.

    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"

Back to top

Setting Up Email Notifications

To configure email notifications:

  1. Click the Dashboard link in the upper right corner of your Portal website.
  2. Click the Settings tab, then click Notifications.

  1. For the events you wish to configure, enter the necessary information:
Notification Field Description
New Comment and Forum Topics Email Email address(es) for all recipients
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

Back to top

Email Variables

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

In the following example, the Subject will be customized to display the recipient's moniker.

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

Back to top

Docs Navigation