EmailDeliver

<< Click to Display Table of Contents >>

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

EmailDeliver

 

Email Deliver agent is responsible for sending notices generated by other workflow agents. Notices pending delivery are identified in st_user_notice where delivery_type='Email' and delivered_date and undelivered_date are both null.

 

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

 

EQuIS Version:  7

 

Namespace: EarthSoft.Workflow.Agents.EmailDeliverAgent

 

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 EmailDeliver

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

OBJECT_VALUE

from_address


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 EmailDeliver

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

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 EmailDeliver

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

OBJECT_VALUE

port


Required

STRING_VALUE

<integer>

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

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 EmailDeliver

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

OBJECT_VALUE

enable_ssl


Required

STRING_VALUE

<boolean>

Default value is false.

Choose one of:

true
false

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

AgentsConfigSettings


Required

CONFIG_KEY

agent


Required

OBJECT_TYPE

<service_name>

Defaults to EmailDeliver

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

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 EmailDeliver

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

OBJECT_VALUE

password


Required

STRING_VALUE

<string>

This value is not encrypted by EQuIS.

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 EmailDeliver

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

OBJECT_VALUE

compressed_file_extension


Required

STRING_VALUE

<boolean>

Choose one of:

true

false

 

 

 

Example:

 

config_section

config_key

object_type

object_value

string_value

AgentsConfigSettings

agent

EmailDeliver

compressed_file_extension

.zip

AgentsConfigSettings

agent

EmailDeliver

host

exchange.example.com

AgentsConfigSettings

agent

EmailDeliver

port

995

AgentsConfigSettings

agent

EmailDeliver

useDefaultCredentials

true

AgentsConfigSettings

agent

EmailDeliver

enable_ssl

true

AgentsConfigSettings

agent

EmailDeliver

username

EQuIS-do-not-reply@example.com

AgentsConfigSettings

agent

EmailDeliver

password

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