Page History

Help is available by sending an email to csf-support@mit.edu
Have any suggestion on how improve this wiki?  Please give us your feedback at csf-support@mit.edu

CSF Email properties description

1. email.address.from:
   • Description:  A string containing an email address from whom the email is being sent.  The string may contain more than just an email address.
   • Usage:  Optional
   • Example:  email.address.from=registration@mit.edu ("MIT Office of the Registrar")
   • Dependencies:  If specified, this value will always be used in the from field of the email. If not specified, the CSF Email Service default address (csf-support@mit.edu) will be used.
2. email.address.test.to:
   • Description:  A string containing an email address to whom the email is being sent.
   • Usage:  Optional.  Recommend to be used on WORKSTATION, DEV, TEST and QA servers and not used on PRODUCTION servers.
   • Example:  email.address.test.to=rjrenolds@mit.edu
   • Dependencies:  Used in conjunction with the email.production.mode property.
       When email.production.mode=false:
         email will be sent to the email address specified with this property.
       When email.production.mode=true:
         email will be sent to the email address specified by the calling application.
     If no "to address" is determined in either of the above cases, the CSF Email Service default address (csf-support@mit.edu) will be used.
3. email.address.bcc:
   • Description:  A string of CSV email address(es) to be used in the email's bcc.
   • Usage:  Optional
   • Example:  email.address.bcc=rjrenolds@mit.edu
   • Dependencies:  Used in conjunction with the email.production.mode property.
       When email.production.mode=false:
         bcc addresses will not be added to the emails.
       When email.production.mode=true:
         bcc addresses will be added to the emails.
4. email.production.mode:
   • Description:  Used to indicate whether or not the applicaition is deployed on a production server.
   • Usage:  Optional. Only the boolean values true or false are allowed (default is false).
   • Example: 
       When email.production.mode=false:
         the application is deployed to DEV, TEST or QA server and is not deployed to a PRODUCTION server.
       When email.production.mode=true:
         the application is deployed to a PRODUCTION server.
   • Dependencies:  None.
5. email.app.id:
   • Description: Used to identify the application that created the email.
   • Usage: Required.
   • Example: email.app.id=ssb
       In this example, the application id is ssb and must be unique.
   • Dependencies: The application id must be unique. In other words, each application must have its own unique email.app.id value.
6. email.sendEmailSchedule:
   • Description: Used to set the time interval for sending emails. The property value follows the format for the Quartz cron trigger. IMPORTANT: in a clustered environment (i.e. TEST and PROD), this property should be different for every server in the cluster: we want to avoid multiple quartz jobs running against the same email data at the same time and sending duplicate emails. In fact we recommend effectively disabling the quartz job on all but one of the servers in a given cluster by specifying a schedule that will never be triggered (e.g. a data in the year 2099).
   • Usage: Required when using csf-email in a cluster. If not specified, the csf-email default schedule will be used (every 10 minutes starting at the top of the hour).
   • Example: email.sendEmailSchedule=0 0/20 0-22 * * ?
       In this example, the emails will be send every 20 minutes, at 0, 20, and 40 minutes past the hour.
   • Dependencies: none.
   • Recommended Settings In Clustered Environment (TEST/PROD):
     one server in cluster (e.g. sea-app-5 in TEST): email.sendEmailSchedule=0 0/10 0-22 * * ?
     other server(s) in cluster (e.g. sea-app-6 in TEST): email.sendEmailSchedule=0 * * * * ? 2099
7. email.deleteEmailSchedule:
   • Description: Used to set the time interval for deleting emails that have been sent. The property value follows the format for the Quartz cron trigger. IMPORTANT: in a clustered environment (i.e. TEST and PROD), this property should be different for every server in the cluster: we want to avoid multiple quartz jobs running against the same email data at the same time. In fact we recommend effectively disabling the quartz job on all but one of the servers in a given cluster by specifying a schedule that will never be triggered (e.g. a data in the year 2099).
   • Usage: Required when using csf-email in a cluster. If not specified, the csf-email default schedule will be used (nightly at 10.30pm).
   • Example: email.deleteEmailSchedule=0 45 23 * * ?
       In this example, the emails will be deleted every night at 11.45pm.
   • Dependencies: none.
   • Recommended Settings In Clustered Environment (TEST/PROD):
     one server in cluster (e.g. sea-app-5 in TEST): email.deleteEmailSchedule=0 30 22 * * ?
     other server(s) in cluster (e.g. sea-app-6 in TEST): email.deleteEmailSchedule=0 * * * * ? 2099