How Do I

Setting Up Email

Client-deployment.properties file

  • The client.properties file contains many of the high-level configuration options that the underlying platform OFBiz requires.
  • When making changes to this file, OFBiz will need to be restarted for the changes to take effect.
  • For emails, in the General Properties section, there are several properties that need to be considered:
Property Description
defaultFromEmailAddress General default “from email address” for all outgoing emails. This will be overridden for specific emails by using the Admin linkPath Email Configuration. It is recommended that the specific email configurations are used.
mail.notifications.enabled If set to “N”, then emails will NOT be sent, all emails will be logged as an OFBiz “communication event”. If set to “Y” then emails will be sent.
mail.smtp.relay.host The default email server to be used. For example, mail.acmecorp.com.
mail.smtp.auth.user If required, the user name needed for the SMTP server. This is required if the web server IP address is NOT publicly accessible.
mail.smtp.auth.password If required, the password needed for the SMTP server. This is required if the web server IP address is NOT publicly accessible.
mail.notifications.redirectTo For initial testing purposes. This will override ALL emails sent via BigFish and send them to this address.
  • Note:
    • The client-deployment.properties files is a BigFish configuration file that consolidates the various OFBiz properties.
    • To build / admin-module / restart apache.

Email Configuration

  • Admin linkPath Manage Emails linkPath Email Configuration
  • The primary purpose of this function is to control the following identifiers in the sent emails:
    • From: for each email this determines which email is used as the “from address.”
    • CC: for each email, this determines who should be “copied” on the email. Typically this would be a member of the customer service department for control purposes.
    • BCC: similar to the “cc” option, a “blind copy” of the email.

Email Templates

  • Accessed from Admin linkPath Manage Emails linkPathEmail Templates
  • This function allows for the specific content of each email to be maintained.
  • The content can be quite complex and clients should proceed with caution when modifying.
  • For the latest content:
    • Go to bigfish.solveda.com
    • Click on Demo.
    • Login to the Fashion House Admin Module.
    • Admin linkPath Manage Emails linkPathEmail Templates
    • This content can be copied from the Fashion House Demo instance to your instance.

Email Template Logo

  • The initial seeded data setup for email templates includes standard “header” and “footer” sub-templates that are included in all generated emails
    • Admin linkPath Manage Emails linkPath Email Templates
    • Review E_COMMON_HEADER and E_COMMON_FOOTER
  • E_COMMON_HEADER already references a system parameter called EMAIL_CLNT_LOGO. This system parameter contains a path to a logo.
  • To view the value of EMAIL_CLNT_LOGO
    • Admin linkPath System Parameters
    • Enter "EMAIL" in the search
    • Click on the Search button
    • By default, EMAIL_CLNT_LOGO is setup as /osafe_theme/images/logo/emailClientLogo.gif
  • The above reference expects to find a media asset of that name. To check if that is available:
    • Content linkPath Media Library
    • enter "logo" in the search
    • click on the Search button
    • go ahead and overlay the emailClientLogo.gif with an appropriate image for your implementation

The full path of the included logo image is actually a combination of two system parameters: HTTP_HOST and EMAIL_CLNT_LOGO. You may need to modify the HTTP_HOST for this to work.

Testing your Email Setup

  • Testing your implementation is easy:
    • Admin linkPath Manage Emails linkPath Email Templates
    • Click on the “Email Test” for E_NEW_CUSTOMER
    • Enter or select a Customer#
    • Enter your email in the “To Email”
    • Click “Send”

System Parameters

  • There are many BigFish System Parameters to consider when initially setting up emails:
  • To view all relevant parameters:
    • Go to the Admin linkPath System Parameters function
    • Enter "email" in the entry box and click "Search".
    • Review all available parameters and configure accordingly.

Scheduled Jobs

  • There are two specific Scheduled Jobs that can be maintained via Admin linkPathSceduled Jobs
    • Abandoned Cart Email:
      • A job that will identify all abandoned carts and send an email to the registered user.
      • Two system parameters should be considered: EMAIL_ABANDON_HRS and EMAIL_ABANDON_NUM.
      • The email template is E_ABANDON_CART.
      • The email configuration is PRDS_ABD_CART.
    • Review Email:
      • A job that will identify all completed purchases and send an email encouraging the customer to return to the site and post a product review.
      • The following system parameters should be considered: EMAIL_REVIEW_SHP_DYS, REVIEW_ACTIVE_FLAG, REVIEW_AUTO_APPROVE and REVIEW_SEND_EMAIL.
      • The email template is E_SHIP_REVIEW.
      • The email configuration is PRDS_SHIP_REVIEW.
Back to Top

Built by Solveda