Configure email

By default, the developer portal sends emails in response to certain events. For example, when a new app developer registers on the portal, the portal automatically sends an account verification email to the registered email address.

Configure the following email settings for all email notifications originating from the portal:

Configure an SMTP server

When email notifications are sent to app developers, the Apigee corporate email server is used by default. For example, no-reply@apigee.com.

Alternatively, you can configure the SMTP server for the email notifications originating from the portal. For example, no-reply@mycompany.com.

To configure the SMTP server:

  1. Select Publish > Portals and select your portal.
  2. Select Settings in the drop-down menu in the top navigation bar.
    Alternatively, click Settings on the portal landing page.
  3. Click the SMTP tab.
  4. Configure the SMTP server settings:

    Setting Description
    Server URL Host URL of the SMTP server.
    From Email Email address used as the sender.
    SMTP Username User name for the SMTP account.
    SMTP Password Password for the SMTP account.
    Use Secure Connection? Select to use a secure connection to the SMTP server.
    Auth Type Authorization type. Valid values include: SSL or TLS. Leave this field blank for no authorization.
    Port Port number for the SMTP server. The following ports are supported:
    • 465 (SSL)
    • 587 (TLS)
    • 25 (open, no authorization)
  5. Click Save.

Configure email notifications

A set of email templates is provided by default that can be used to notify app developers when they create or reset the password for their portal account. The email notification confirms the intended action and provides a secure link to enable developers to validate and complete the action.

You can configure the contents of the email templates summarized in the following table.

Email template Trigger Description
Account Verification App developer creates a new account Provides a secure link to verify account creation and to establish an authenticated session. The link expires in 10 minutes.
Reset Password App developer requests password reset Provides secure link to reset password. The link expires in 10 minutes.

When configuring the contents of the email templates, you can insert one or more of the following variables which will be substituted when the email notification is sent.

Variable Description Supported email templates
{{firstName}} First name All templates
{{lastName}} Last name All templates
{{email}} Email address All templates
{{hostName}} Host name
Example: www.acme.com
All templates
{{verifyLink}} Verify login link Account Verification
{{siteUrl}} Portal domain name; custom domain name is used, if defined
Example: https://www.acme.com
Account Verification
{{resetLink}} Reset login link Reset Password

To configure the email templates:

  1. Select Publish > Portals and select your portal.
  2. Select Settings in the drop-down menu in the top navigation bar.
    Alternatively, click Settings on the portal landing page.
  3. Click the Email tab.
  4. Modify the Subject Line, Body, or HTML Body for an email template.

    Note: You can use any of the variables defined in the table above in your content.

  5. Optionally, test your email template changes:
    a. Click Send test email.
    b. Enter an email address in the field provided.
    c. Click Send.
    d. Review the email received.
    Note: Variables specified in the email template will not be substituted during testing.

  6. Click Save.

  7. Repeat steps 4 through 6 to modify another email template, if required.