Configure email (original version)

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

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 the SMTP server for all email notifications, as described in Configure an SMTP server.
• Configure the contents of the email notifications, as described in Configure email notifications.

Configuring 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. View the list of portals by selecting Publish > Portals.
2. Click the name of your portal to view details.
3. Select Settings in the drop-down menu in the top navigation bar.
   Alternatively, click Settings on the portal landing page.
4. Click the SMTP tab.

5. 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)

6. Click Save.

7. Click Reset Defaults to reset the default values.

Configuring email notifications

A set of email templates is provided by default that are used to notify app developers when they create or log into their portal account. The email notification confirms the intended action and provides a secure link to enable app developers to log in to the portal.

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.
Account Login	App developer logs into account	Confirms action and provides a secure link to establish a logged in session. 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
{{firstName}}	First name
{{lastName}}	Last name
{{loginLink}}	Secure login link
{{siteName}}	Portal domain name (custom domain name is used, if defined)

To configure the email templates:

1. View the list of portals by selecting Publish > Portals.
2. Click the name of your portal to view details.
3. Select Settings in the drop-down menu in the top navigation bar.
   Alternatively, click Settings on the portal landing page.
4. Click the Email tab.

5. 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.

6. Optionally, test your email template changes in the Send Test <Template> Email section:
   a. Enter an email address in the To: field.
   b. Click Send Test Email.
   c. Review email received. Note that the variables specified in the email template will not be substituted during testing.

7. Click Save.

8. Repeat steps 5 through 7 to modify another email template, if required.