User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
wiki:guides:authors:objects:email [2016/02/11 05:12]
Brian Collins
wiki:guides:authors:objects:email [2017/04/26 05:43] (current)
Brian Collins
Line 3: Line 3:
  
 ----- -----
-**EMAIL** ​can be used to send e-mail messages ​to users while their EASAP submission ​is being processed on the EASA ServerThese e-mail messages ​are often used to accomplish the following two tasks+**EMAIL** ​will send an email message ​to one or more **Users** following an EASAP submission. ​ 
 + 
 +Two typical cases are to: 
       * Notify a user that their submission has completed, and        * Notify a user that their submission has completed, and 
       * Provide some results data to the user.        * Provide some results data to the user. 
  
-The user’s email address is specified in the **Email Address:​** ​parameter and can be set using DORs referencing ​either ​a data entry object ​in which the user has specified their address or a [[wiki:​guides:​authors:​objects:​contact_details]] object ​set to type ‘Email’. The content of both the subject and body of the email message can be made dynamic ​by use of DORS, and one file attachment can be made in the message. An important issue to reconcile when using **EMAIL** has to do with the frequency of messages being sent during a multiple run EASAP submission. You will need to decide whether an e-mail message should be sent during each separate run of the submission, sent just once after all the runs have finished or not at all. This decision is specified in the **Multirun Behaviour:​** ​parameter. The types of multiple run submissions allowed in an EASAP that are affected by this issue are described in detail in [[wiki:​guides:​authors:​parametric_studies]]+**Email Address:​** ​may be either
 +  * An **object ​reference** to user completed field 
 +  * A **[[wiki:​guides:​authors:​objects:​contact_details]]** object ​with **Type:**->Email 
 + 
 +An **object reference** in **Subject:​** ​ or **Body:** allows ​dynamic ​content.  
 + 
 +A single ​file name in **Attachment:** is allowed.  
 + 
 +multiple run EASAP submission ​may require ​**Multirun Behaviour:​**->'​Send Once When Finished'​ to limit email volume. 
 + 
 +The types of multiple run submissions allowed in an EASAP are described in detail in [[wiki:​guides:​authors:​parametric_studies]]
  
------ +**EMAIL** requires an **EASA Server** be configured to send email through a designated SMTP Server, see [[wiki:​guides:​admins:​enabling_email_in_easa]].
-**Note:** Before ​**EMAIL** will work in an EASAP, your EASA Server must be configured to send out e-mail ​through a designated SMTP Server ​as described in [[wiki:​guides:​admins:​enabling_email_in_easa]]+
  
 ^  {{:​wiki:​icons:​email.png?​nolink|}} EMAIL  ^^ ^  {{:​wiki:​icons:​email.png?​nolink|}} EMAIL  ^^
 ^Essential Parameters:​^^ ^Essential Parameters:​^^
-|**Email Address:**|E-mail ​address of message recipient. DORs allowed| +|**Email Address:**|Email address of message recipient, **object references** ​allowed| 
-|**Subject:​**|Subject of message. DORs allowed|+|**Subject:​**|Subject of message, **object references** ​allowed|
 ^Optional Parameters:​^^ ^Optional Parameters:​^^
-|**Body:**|Body of message. DORs allowed| +|**Body:**|Message content, **object reference** ​allowed| 
-|**Attachment:​**|Name of file to attach to message| +|**Attachment:​**|File name to attach to message| 
-|**From Address:**|E-mail ​address to use as from or reply address on message|+|**From Address:**|Email address to use as from or reply address on message|
 |**Multirun Behaviour:​**|Select action for multiple run submission. default->​Send None, Send All, Send Once When Finished| |**Multirun Behaviour:​**|Select action for multiple run submission. default->​Send None, Send All, Send Once When Finished|
 |**On Error:​**|Controls whether subsequent actions and processes should run, if there is an error sending the email. default->​CONTINUE,​ STOP| |**On Error:​**|Controls whether subsequent actions and processes should run, if there is an error sending the email. default->​CONTINUE,​ STOP|
 |**Send if:​**|Logical expression, if TRUE then send message, if FALSE then do NOT send message| |**Send if:​**|Logical expression, if TRUE then send message, if FALSE then do NOT send message|
-|**Delimiter:​**|Character to act as delimiter in DORs in **Email Address:**, **Subject:​** ​and **Body:​** ​parameters.|{{:​wiki:​icons:​email.png?​nolink|}}+|**Delimiter:​**|Character to delimit an **object reference** ​in  **Email Address:**, **Subject:​** ​or **Body:** |{{:​wiki:​icons:​email.png?​nolink|}}

Page Tools