Implementation Overview for the Email Agent

There are different components required to integrate your Automation Engine and an IMAP mailbox so that you can trigger and monitor Mail Jobs from your Automic Automation system.

As a system administrator, you carry out the steps required to integrate Automic Automation with the Email Agent to access any Internet Message Access Protocol (IMAP) mailbox and check for incoming emails.

These are the steps you have to follow for the integration:

Download the Email Agent Installation Package

You can download the relevant Agent installation package from our download center at https://docs.automic.com/documentation or from our marketplace at https://marketplace.automic.com/.

For more information, see Downloads and Marketplace.

Install the Email Agent

After downloading the relevant installation package, you have to install the Agent so that you can establish the communication between the two systems.

Important!

Before installing the Agent, check the version compatibility information at compatibility matrix. For information about how to use the compatibility matrix, see Compatibility Information.

You can install the Agent manually or in a container. The containerized Agent installation refers to building and running a Docker image hosting Java Agents in a container.

Regardless of how you install the Agents, you can use them in on-premises Automic Automation systems as well as in an Automic Automation Kubernetes Edition system.

For more information, see the Automic Automation documentation:

Installing Containerized Java Agents in the Automic Automation documentation
Agents (HOST) in the Automic Automation documentation

For more information on how to install the Email Agent see Installing the Email Agent.

Define the Email Agent

Once you have installed the Agent, you have to configure its INI file to cover your system's requirements, for example, the connection between the Agent and the Automation Engine instance. Then, you define the Agent object in AWI. There are definition pages that are common to all Agents and some that are Agent-specific.

The Agent definition allows you to configure the communication between the Automation Engine and the Email Integration to process your Mail Jobs. The Agent starts the execution of these jobs and makes both their monitoring and the corresponding reporting possible.

For more information, see Defining the Email Agent.

Establish the Connection from the Automation Engine to the IMAP Mail Server

Now you have to make sure that the log in data required to establish the connection to the IMAP mail server is available and the network, including proper ports and protocols, is open to allow the Email Agent to connect. Otherwise, you cannot create and execute Mail Jobs without leaving the Automic Web Interface.

To do so, you have to create and define Email Connection objects.

For more information, see .

Define Email Jobs

Now that the Agent is installed and defined and both systems can communicate with each other, you have to create and define the Mail Jobs so that you can process (move, delete, or download them) the relevant processing steps on the IMAP mail server.

Once the job is defined, you can execute it and monitor its progress from the Automic Web Interface.

For more information, see Email Jobs: Defining Mail Job Properties.