EmailRetrieve

<< Click to Display Table of Contents >>

EQuIS 7  >>  Configuration > ST_CONFIG Entries > Enterprise Workflow >

EmailRetrieve

 

Email retrievalagent 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, then deletes the message. Only the message attachments are saved.  It is assumed that a EML channel is defined for FileMonitor agent.

 

At this time, it's possible to have only one instance of EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent running.

 

EQuIS Version:  7

 

Namespace:  EarthSoft.Workflow.Agents.EmailRetrieveAgent

 

Products Affected:

oEnterprise

 

Requires Module:

oEnterprise

oCustom Code

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailRetrieve

One of
select service_name from st_service_reservation 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.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailRetrieve

One of
select service_name from st_service_reservation 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.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailRetrieve

One of
select service_name from st_service_reservation 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

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailRetrieve

One of
select service_name from st_service_reservation 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

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailRetrieve

One of
select service_name from st_service_reservation where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.EmailRetrieveAgent'

OBJECT_VALUE

username


Required

STRING_VALUE

<string>


As defined by mail server

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailRetrieve

One of
select service_name from st_service_reservation 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