Configure SMTP for outbound emails

Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and MacOS) or by clicking the shortcut in the Start Menu under “Start -> Bitnami APPNAME Stack -> Application console” (Windows). On OS X VMs, the installation directory is /opt/bitnami and OS X VM users can click the “Open Terminal” button to run commands. Learn more about the Bitnami stack environment and about OS X VMs.

To configure outbound email, follow these steps:

Edit the installdir/apps/erpnext/htdocs/frappe-bench/sites/erpnext/site_config.json file. Add or update the SMTP configuration in the file. Here is an example of how to configure a Gmail account. Replace the DB_PASSWORD placeholder with the correct database password and the USERNAME and PASSWORD placeholders with your Gmail account username and password respectively.

Your file should look like this:

    "db_name": "bitnami_erpnext",
    "db_password": "DB_PASSWORD",
    "mail_server": "",
    "mail_login": "",
    "mail_password": "PASSWORD",
    "use_ssl": 1,
    "mail_port": 587,
    "auto_email_id": ""

NOTE: Remember to use double quotes around the values and a comma after every line except the last one. All the parameters should be enclosed between curly braces as shown above.

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid, refer to the FAQ.

NOTE: If you are using Gmail as the outbound email server, your application’s attempts to send outgoing emails may be blocked by Gmail if it considers the authentication attempts to be suspicious. When this happens, you will receive a Gmail security alert at the corresponding Gmail address. To proceed, you will need to manually confirm the validity of the authentication attempt before Gmail will permit the application to send outbound emails. For more information on this and other Gmail issues related to outbound email from your application, refer to our Gmail SMTP troubleshooting page.

Last modification November 17, 2020