| Both sides previous revision Previous revision Next revision | Previous revision |
| 3400_how_to:0700_emails [2026/08/13 04:12] – localdev | 3400_how_to:0700_emails [2026/08/13 07:43] (current) – Imported by DokuWiki Advanced Plugin aware_support3 |
|---|
| ====== Emails ====== | ====== Emails ====== |
| ==== How To... ==== | ===== How to... ===== |
| |
| <accordion id="emails" collapsed="true"> | <accordion autoclose> |
| <panel type="primary" title="configure the system to send e-mails"> | <anchor id="configure_the_system_to_send_e_mails"> |
| | <accordion-item title="configure the system to send e-mails"> |
| To configure the application to send e-mails you need to do the following: | To configure the application to send e-mails you need to do the following: |
| |
| - Define a business rule that would use the ''[[ref:a_f:a:send|SEND]]'' action to send e-mail under particular circumstances – see the description of the ''[[ref:a_f:a:send|SEND]]'' Action in the [[:3000_rule_language|AwareIM Rule Language Reference]]. | - Define a business rule that would use the ''[[ref:a_f:a:send|SEND]]'' action to send e-mail under particular circumstances – see the description of the ''[[ref:a_f:a:send|SEND]]'' Action in the [[:3000_rule_language|AwareIM Rule Language Reference]]. |
| See also the “[[2000_concepts:0900_prod_feats:0500_email_handling#Outgoing_email|Outgoing E-mail]]” section. | See also the “[[2000_concepts:0900_prod_feats:0500_email_handling#Outgoing_email|Outgoing E-mail]]” section. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="send e-mail with attachments"> | <anchor id="send_e_mail_with_attachments"> |
| | <accordion-item title="send e-mail with attachments"> |
| To send e-mails with attachments you need to configure a notification representing a particular e-mail (see the “[[2500_config_apps:2600_emails:0200_outgoing_email|Sending Outgoing E-mail]]” section) and define attributes of the Document type that will hold the attachments – one attribute per attachment (see the “[[2500_config_apps:0700_add_edit_attributes:0700_doc_attrib|Attributes of Document Type]]” section). When you send e-mail using the ''[[ref:a_f:a:send|SEND]]'' action you need to initialize these attributes with the particular documents (these can be generated reports, “merged documents” or ordinary files). //**AwareIM**// will automatically convert these documents into e-mail attachments. For example, | To send e-mails with attachments you need to configure a notification representing a particular e-mail (see the “[[2500_config_apps:2600_emails:0200_outgoing_email|Sending Outgoing E-mail]]” section) and define attributes of the Document type that will hold the attachments – one attribute per attachment (see the “[[2500_config_apps:0700_add_edit_attributes:0700_doc_attrib|Attributes of Document Type]]” section). When you send e-mail using the ''[[ref:a_f:a:send|SEND]]'' action you need to initialize these attributes with the particular documents (these can be generated reports, “merged documents” or ordinary files). //**AwareIM**// will automatically convert these documents into e-mail attachments. For example, |
| |
| |
| In this example ''EmailToCustomer'' is assumed to have the second attribute of the Document type called Attachment2. After the notification has been created the value of this attribute is imported from file. When the e-mail is sent the file is converted to the e-mail attachment. | In this example ''EmailToCustomer'' is assumed to have the second attribute of the Document type called Attachment2. After the notification has been created the value of this attribute is imported from file. When the e-mail is sent the file is converted to the e-mail attachment. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="configure the system to receive e-mails">This is described in detail in the “[[2000_concepts:0900_prod_feats:0500_email_handling#Incoming_Email|Incoming E-mail]]” and “[[2500_config_apps:2600_emails:0100_incoming_emails|Setting Options for Incoming E-mail Handling]]” sections. | <anchor id="configure_the_system_to_receive_e_mails"> |
| </panel> | <accordion-item title="configure the system to receive e-mails"> |
| | This is described in detail in the “[[2000_concepts:0900_prod_feats:0500_email_handling#Incoming_Email|Incoming E-mail]]” and “[[2500_config_apps:2600_emails:0100_incoming_emails|Setting Options for Incoming E-mail Handling]]” sections. |
| | </accordion-item> |
| |
| <panel type="primary" title="register (save) incoming e-mails in the system"> | <anchor id="register_save_incoming_e_mails_in_the_system"> |
| | <accordion-item title="register (save) incoming e-mails in the system"> |
| You can ask //**AwareIM**// to register all incoming e-mails when you configure the properties of the incoming e-mail handling – see the “[[2500_config_apps:2600_emails:0100_incoming_emails|Setting Options for Incoming E-mail Handling]]” section. | You can ask //**AwareIM**// to register all incoming e-mails when you configure the properties of the incoming e-mail handling – see the “[[2500_config_apps:2600_emails:0100_incoming_emails|Setting Options for Incoming E-mail Handling]]” section. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="process e-mail based on its contents">In order to process the received e-mails you need to define business rules attached to the event of receiving an e-mail notification – see the “[[2500_config_apps:2600_emails:0100_incoming_emails|Incoming E-mail]]” section. The rules may check the subject and/or body of the e-mail (or maybe who it is from and when it was sent) and perform the appropriate actions. For example, | <anchor id="process_e_mail_based_on_its_contents"> |
| | <accordion-item title="process e-mail based on its contents"> |
| | In order to process the received e-mails you need to define business rules attached to the event of receiving an e-mail notification – see the “[[2500_config_apps:2600_emails:0100_incoming_emails|Incoming E-mail]]” section. The rules may check the subject and/or body of the e-mail (or maybe who it is from and when it was sent) and perform the appropriate actions. For example, |
| |
| <code aim>IF IncomingEmail.Subject = 'Registration' AND IncomingEmail.From = 'John Smith' THEN ... </code> | <code aim>IF IncomingEmail.Subject = 'Registration' AND IncomingEmail.From = 'John Smith' THEN ... </code> |
| |
| will set the Name, State and Balance attributes of the Account objects to the values provided in the body of the e-mail ('John Smith', 'NEW' and 100.0). You can define other rules that will check these values and perform the appropriate actions if required. | will set the Name, State and Balance attributes of the Account objects to the values provided in the body of the e-mail ('John Smith', 'NEW' and 100.0). You can define other rules that will check these values and perform the appropriate actions if required. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="do mail-merge"> | <anchor id="do_mail_merge"> |
| | <accordion-item title="do mail-merge"> |
| To perform “mail-merge” of your outgoing e-mails do the following: | To perform “mail-merge” of your outgoing e-mails do the following: |
| |
| - Define a notification representing the e-mail – see the “[[2500_config_apps:2600_emails:0200_outgoing_email|Sending Outgoing E-mail]]” section, [[3400_how_to:0700_emails:0930_email_config]] | - Define a notification representing the e-mail – see the “[[2500_config_apps:2600_emails:0200_outgoing_email|Sending Outgoing E-mail]]” section, [[:3400_how_to:0700_emails#configure_the_system_to_send_e_mails]] |
| - Provide the initial values to the Message and Subject attributes of the e-mail notification to include the body and subject of your e-mail respectively (see the “[[2500_config_apps:0700_add_edit_attributes:0100_common_props|Common Properties]]” section). Use tags inside the initialization text for those parts of the body and/or subject that will be “mail merged”. //**AwareIM**// will replace the tags with the appropriate values when the e-mail is sent. Below is an example of the initialization text for the Message attribute: | - Provide the initial values to the Message and Subject attributes of the e-mail notification to include the body and subject of your e-mail respectively (see the “[[2500_config_apps:0700_add_edit_attributes:0100_common_props|Common Properties]]” section). Use tags inside the initialization text for those parts of the body and/or subject that will be “mail merged”. //**AwareIM**// will replace the tags with the appropriate values when the e-mail is sent. Below is an example of the initialization text for the Message attribute: |
| |
| |
| Your policy is about to expire on <<Policy.ExpiryDate>></code> | Your policy is about to expire on <<Policy.ExpiryDate>></code> |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="send e-mails in HTML format"> | <anchor id="send_e_mails_in_html_format"> |
| To send e-mails in the HTML format first define the text of the e-mail as HTML document template (see the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]] section). After that add an email notification as described in [[3400_how_to:0700_emails:0930_email_config]]. This notification will have the predefined HTMLMessage attribute of the Document type. Set initial value of this attribute to the name of the HTML document template. Then define a rule to send this e-mail as usual. | <accordion-item title="send e-mails in HTML format"> |
| </panel> | To send e-mails in the HTML format first define the text of the e-mail as HTML document template (see the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]] section). After that add an email notification as described in [[:3400_how_to:0700_emails#configure_the_system_to_send_e_mails]]. This notification will have the predefined HTMLMessage attribute of the Document type. Set initial value of this attribute to the name of the HTML document template. Then define a rule to send this e-mail as usual. |
| | </accordion-item> |
| |
| </accordion> | </accordion> |