EmailRetrieve Agent

<< Click to Display Table of Contents >>

Navigation:  Configuration > ST_CONFIG Entries > Enterprise Workflow Service >

EmailRetrieve Agent

The Email Retrieval agent is part of the Enterprise workflow service that poles an email box, retrieves any message found, strips all attachments from the message saving them to the EML sub-folder of the EQuIS work folder, and then deletes the message. Only the message attachments are saved. It is assumed that an EML channel is defined for the FileMonitor agent.

 

Note: Only one instance of EarthSoft.Workflow.Agents.EmailRetrieveAgent can be running per account mail box.

 

 

EQuIS Version:  7

 

Namespace: EarthSoft.Workflow.Agents.EmailRetrieveAgent

 

Products Affected: Enterprise

 

Required Modules:

Enterprise

Custom Code

 

 

Host

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings

Required


CONFIG_KEY

agent

Required


OBJECT_TYPE

<service_name>

Begins with "EmailRetrieve"

One of the SERVICE_NAME values from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

host

Required


STRING_VALUE

<hostname or ip address>

Valid host name or ip address of a mail server that is reachable from the EQuIS application server.

 

 

Port

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings

Required


CONFIG_KEY

agent

Required


OBJECT_TYPE

<service_name>

Begins with "EmailRetrieve"

One of the SERVICE_NAME values from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

port

Required


STRING_VALUE

<integer>

Network port number that mail server is listening on. Default value is 143.

See mail server configuration and file wall settings.

 

 

Protocol

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings

Required


CONFIG_KEY

agent

Required


OBJECT_TYPE

<service_name>

Begins with "EmailRetrieve"

One of the SERVICE_NAME values from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

protocol

Required


STRING_VALUE

<string>

Default value is IMAP

Choose one of:

POP

IMAP

 

 

Security

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings

Required


CONFIG_KEY

agent

Required


OBJECT_TYPE

<service_name>

Begins with "EmailRetrieve"

One of the SERVICE_NAME values from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

security

Required


STRING_VALUE

<string>

Default value is implicit.

Choose one of:

implicit or ssl

explicit or tls

explicitoptional

none

 

 

Username

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings

Required


CONFIG_KEY

agent

Required


OBJECT_TYPE

<service_name>

Begins with "EmailRetrieve"

One of the SERVICE_NAME values from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

username

Required


STRING_VALUE

<string>


As defined by mail server

 

 

Password

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings

Required


CONFIG_KEY

agent

Required


OBJECT_TYPE

<service_name>

Begins with "EmailRetrieve"

One of the SERVICE_NAME values from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

password

Required


STRING_VALUE

<string>

This value is not encrypted by EQuIS.

As defined by mail server

 

 

Example

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

AgentsConfigSettings

agent

EmailRetrieve

host

exchange.example.com

AgentsConfigSettings

agent

EmailRetrieve

port

143

AgentsConfigSettings

agent

EmailRetrieve

protocol

IMAP

AgentsConfigSettings

agent

EmailRetrieve

security

implicit

AgentsConfigSettings

agent

EmailRetrieve

username

EDD@example.com

AgentsConfigSettings

agent

EmailRetrieve

password

fe12!@EFG$$%^HJ&^^&*KI#B7564f