vmware-marketplacedreamfactory

Configure SMTP for outbound emails

NOTE: We are in the process of modifying the file structure and configuration for many Bitnami stacks. On account of these changes, the file paths stated in this guide may change depending on whether your Bitnami stack uses native Linux system packages (Approach A), or if it is a self-contained installation (Approach B). To identify your Bitnami installation type and what approach to follow, run the command below:

 $ test ! -f "/opt/bitnami/common/bin/openssl" && echo "Approach A: Using system packages." || echo "Approach B: Self-contained installation."

The output of the command indicates which approach (A or B) is used by the installation, and will allow you to identify the paths, configuration and commands to use in this guide. Refer to the FAQ for more information on these changes.

TIP: DreamFactory virtual machines and cloud images already have Postfix mail server installed. It is possible to send emails from Postfix, but it is not recommended to send emails from the server itself.

Version 1.x

We recommend configuring the “Email” service in the DreamFactory administration panel to send emails through SMTP. Navigate to “Services -> Email Service”, select the “SMTP” provider and configure it according to your SMTP credentials.

For instance, here is an example of configuring SMTP settings to send emails through a Gmail account. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

Host: smtp.gmail.com
Port: 465
Security: SSL
Username: USERNAME@gmail.com
Password: PASSWORD

Dreamfactory mail configuration

Version 2.x

Edit the bootstrap/cache/config.php file inside the DreamFactory installation directory, and configure the SMTP options.

NOTE: To navigate to the DreamFactory installation directory, execute the following commands depending on your installation type:

  • Approach A (Bitnami installations using system packages):

      $ cd /opt/bitnami/dreamfactory
    
  • Approach B (Self-contained Bitnami installations):

      $ cd /opt/bitnami/apps/dreamfactory/htdocs/
    

For example, to configure a Gmail account, use the settings below. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

'mail' =>
array (
  'driver' => 'smtp',
  'host' => 'smtp.gmail.com',
  'port' => 587,
  'from' =>
  array (
    'address' => 'user@example.com',
    'name' => 'User Name',
  ),
  'encryption' => 'tls',
  'username' => 'USERNAME@gmail.com',
  'password' => 'PASSWORD',

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 September 9, 2021