Extend Outlook SDK Based Automation

As a first step, since an email search can result in multiple emails, customize your automation project to handle multiple emails in the search context.

1. SAP Build Process Automaton comes handy with several loop controls. Add a Forever loop activity after Log Message. You can read more about it from the documentation.

   

2. Forever loop needs to make sure it is executed until there is one email in the search result. In order to know this, use Check Current Email activity which will return if there is any pending emails in the search context. Kindly make sure to test an appropriate output parameter for this activity.

   

3. The output of Check Current Email activity step is a boolean.

   

4. The result of the previous step will return true if an email exists in the search context, stop the loop when there are no more emails to process. You use the Condition Expression Editor and include Is not or ! on the boolean output parameter from previous step. Add the given expression through the expression editor and close it.

   

5. Add a Log Message that loop has reached its end. You can provide a custom message if you want.

   

6. Add an appropriate log message to this step.

   

7. If none of the conditions are met, the workflow of the automation will continue through the default branch. Now to the default branch, you can log the loop index first. Log Message comes handy during debugging. You may remove it, in case you no longer need them.

   

8. You can optionally include a custom log message.

   

9. For each email in the loop context, let us retrieve its email Subject through Get Mail Subject activity.

   

10. Add a log message to print the email subject.

    

11. To the log message event, add your custom message

    

12. Add Get Next Email (Context) activity to advance the loop variable.

    

13. Save and Test the automation, you should see appropriate results.

    

14. You can include additional attributes related to your email in search context result. For example, see the various activities you can use to retrieve additional attributes in your search context.

    

    At this stage, you converted your project to process a series of emails in the search context. An Email may contain one or more file attachments. In the next step, you will download the file attachments.

In this step, you will create a local folder in your windows file system. Then define a folder name dynamically using current timestamp. Finally, save each email attachment to that local folder.

1. Create a string variable folder name. For this use String datatype and drag and drop into the workflow. You can include it above Get Next Email (Context) activity as shown below.

   

2. To the string variable, assign a timestamp value as its value. This is done by using Date.now().toString() via the expression editor.

   In the real world, you may want to use your business process specific folder Name.

   

3. Just make sure, you set the desired variable name as the output parameter.

   

4. Using the folder name, create a folder in the file system and include relevant Create Folder activity from the File System collection to the flow.

   

5. In case you wish the new folder to be created in a specific path, you can append that location to the folder name. Make sure you append double slash (\) to the path.

   

6. Here you save all the attachments in an email in one go by adding Save All Mail Attachments activity to your flow. You can also individually save every attachment using Save Mail Attachment. It is a good idea for you to explore the difference between both these options on your own.

   

7. You will refer the folder path from the previous step as the destination location for saving attachments.

   

8. Save and test the project.

   

9. If any email in your search context contains an attachment, it is saved in your local folders. Based on the logic of this automation, you can review it based on recently created folder in your local file system.

   

At times, you may want the automation to handle sending an acknowledgement or an email reply to the email received.

1. Add Send Reply (Outlook) activity to the flow after Save All Attachments activity.

   

2. In the activity properties, Create Custom Data to the email reply activity.

   

3. You can optionally include additional attributes like an email ID to be kept in cc, bcc in your reply.

   

4. You can optionally modify reply email’s subject. For example, you can use a custom subject to the email reply as Email reply.

   

5. You can include custom message as email body in your reply.

   

6. Once you are done designing your automation, do not forget to add Close Outlook Instance and Release Outlook Instance to your flow.

   

7. Save and Test the project.

   

8. You can validate the result by checking your email reply.

   

If you wish to enhance this use case, after you finish processing an email from your search context, say with the file that was saved, you can move the email from current mail box folder to a “Processed folder”. This will be a good enhancement to this tutorial project that you may try.

• Do review the below resources:
  • Microsoft Outlook Best Practices from the SAP Build Process Automation documentation.
  • Outlook Email Best Practices Automation from the SAP Build Process Automation Store.