Differences

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

--- docs:2500_config_apps:2600_emails:0100_incoming_emails [2025/06/11 08:31] – removed - external edit (Unknown date) 127.0.0.1
+++ docs:2500_config_apps:2600_emails:0100_incoming_emails [2025/06/12 02:34] (current) – Rename to AwareIM aware_support3
@@ Line 1: / Line 1: @@
+[<10>]
+====== Setting Options for Incoming E-mail Handling ======
+Quite often an application needs to process e-mails arriving to the business’s e-mail address and perform certain functions automatically based on the e-mail contents. For example, a customer relationship management system might register all e-mails from customers in its database, assign a unique ID to the e-mails and automatically reply to customers with the details about their request.
+In //**AwareIM**// it is possible to configure an application to process incoming e-mails and perform the necessary actions. As mentioned before all communication with the external parties in //**AwareIM**// is performed either via notifications or service requests (see also [[docs:2500_config_apps:0500_add_edit_objects:0600_intelligent_bo|Defining Intelligent Business Objects]]). Incoming e-mails are no exception – //**AwareIM**// treats them as notifications sent to the //**AwareIM**// application via a special channel. Once incoming e-mails have been delivered to //**AwareIM**// as notifications //**AwareIM**// evaluates any rules attached to the notification as usual. It is up to the configurator to define the appropriate rules.
+All that the configurator has to do to make sure that the application handles incoming e-mails is turn on the e-mail handling capability for the business space version, set the properties of the incoming e-mail channel and define the rules that deal with the incoming e-mail notification. This is explained in more detail below:
+<callout type="primary" icon="true" title="note"> Starting from version 5.7 it is now possible to handle incoming e-mails dynamically from a process. To do this select the business space version in the Configuration Tree and select the "Add Incoming Email Account" object from the Edit menu. This will create a special object that stores values of the incoming email account. You can use instances of this object in the ''[[a_f:a:disconnect_from_email|DISCONNECT FROM EMAIL]]'' action in a process. For more details see the ''[[a_f:a:connect_to_email|CONNECT TO EMAIL]]'' and ''[[a_f:a:disconnect_from_email|DISCONNECT FROM EMAIL]]'' actions in the [[docs:3000_rule_language|Rule Language Guide]].</callout>
+To turn on incoming e-mail handling capability for a business space version follow the steps below:
+  - Double click on the node representing the business space version to start editing it (or select File/Open from the menu).
+  - Click on the "Incoming emails" property displayed in the Elements Properties window The "Incoming E-mails" dialog will be displayed.
+  - Specify the following properties in the "Incoming E-mails" Dialog:
+    - Select the "The system will handle incoming e-mails" radio button to turn on the e-mail handling capability.
+    - Select the "Use values below" radio button and provide the following values:
+      - Specify the DNS name of the mail server that will receive e-mails in the Mail Host text box.
+      - Specify the credentials (the user name and password) of your account on the mail server.
+      - Specify the e-mail protocol supported by your mail server and the port number  (check with your e-mail provider if not sure).
+    - Alternatively you can select the "Use values from SystemSettings object" radio button. In this case the system administrator will have to provide the values for the DNS name, e-mail protocol and user credentials when the application is initialized – see [[docs:2000_concepts:0900_prod_feats:0700_setting_initial_values|Setting Initial Values of the System]].
+  - Press OK on the "Incoming E-mails" Dialog.
+The Configuration Tool will automatically add the following business objects and notification into the business space version:
+===== IncomingEmail notification =====
+This is the notification that represents an incoming e-mail. This notification has a special structure that you cannot change (you can define other attributes but you cannot change the existing ones). The attributes of the notification contain the properties of the received e-mail, such as who it is from, when it was received etc. Any rules that you want to specify to handle incoming e-mails must be attached to the events of this notification – see [[docs:2500_config_apps:0800_add_edit_rules|Adding/Editing Rules]]. You can check values of the pre-defined attributes of the notification in your rules and perform the appropriate actions.
+To turn off the incoming e-mail handling capability for the business space version select the "Incoming emails" property of the business space version to bring up the "Incoming Emails" dialog and select "The system will not handle incoming emails" radio button.