Configuring SMTP for the Apigee BaaS SMTP Server

Edge for Private Cloud v. 4.16.05

Apigee BaaS requires that you configure an SMTP server. When you install the Apigee BaaS API Backend Stack, you enter the SMTP information, including the password of the SMTP user. That password is then encrypted before it is stored.

If you later want to change the SMTP information, edit /<inst_root>/apigee/customer/application/usergrid.properties on all BaaS Stack nodes.

To encrypted a new password so you can set it in usergrid.properties, use the apigee-service utility:

> /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid secure_password newPword

This command returns the encrypted password in the form:

SECURE:ae1b6dedbf6b26aaab8bee815a910737c1c15b55f3505c239e43bc09f8050

To change SMTP information:

  1. Open /<inst_root>/apigee/customer/application/usergrid.properties in an editor. Create this file if it does not exist.
  2. Set the following properties as necessary:
    # SMTP Properties
    usergrid-deployment_mail.smtp.host=smtp.gmail.com
    usergrid-deployment_mail.smtp.port=465
    usergrid-deployment_mail.smtp.auth=true
    usergrid-deployment_mail.smtp.username=your@email.com
    usergrid-deployment_mail.smtp.password=SECURE:74c57edacd3242f0ba1b1413890e17c22a5
    usergrid-deployment_mail.smtp.quitwait=false

    # SMTPS Properties
    usergrid-deployment_mail.smtps.host=smtp.gmail.com
    usergrid-deployment_mail.smtps.port=465
    usergrid-deployment_mail.smtps.auth=true
    usergrid-deployment_mail.smtps.username=your@email.com
    usergrid-deployment_mail.smtps.password=SECURE:74c57edacd3242f0ba1b1413890e17c22a52
    usergrid-deployment_mail.smtps.quitwait=false
  3. After editing this information, you must configure and restart the API Backend Stack by using the commands:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid configure
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid restart
  4. Repeat on all API BaaS Stack nodes.