mailSettings

<< Click to Display Table of Contents >>

Navigation:  Configuration > ST_CONFIG Entries > EarthSoft.Net >

mailSettings

The earthsoft.net mailSettings define the default values loaded when a new instance of EarthSoft.Common.Net.MailClient is created. They are set when EmailRetrieve and EmailDeliver agent settings are set by the Workflow widget and are typically the same values.  These values are used when a user selects the "Lost Password" feature of the Login widget or when custom code calls EarthSoft.Common.Net objects.

 

Notes:

For IMAP and SSL Port should be 993.

Port settings should be configured to your email provider. For additional information, see the following document: https://support.microsoft.com/en-us/office/pop-imap-and-stmp-settings-8361e398-8af4-4e97-b147-6c6c4ac95353

 

 

EQuIS Version: 7

 

Namespace: EarthSoft.Common.Net

 

Products Affected:

Enterprise

 

Requires Module:

Enterprise

Custom Code

 

 

Inbox

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

inbox

Required


OBJECT_VALUE

host

Required


STRING_VALUE

<hostname or ip address>

Valid host name or IP address of an FTP server that is reachable from the EQuIS application server.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

inbox

Required


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

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

inbox

Required


OBJECT_VALUE

protocol

Required


STRING_VALUE

<string>

Default value is IMAP.

Choose one of:

POP

IMAP

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

inbox

Required


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

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

inbox

Required


OBJECT_VALUE

username

Required


STRING_VALUE

<string>


As defined by mail server.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

inbox

Required


OBJECT_VALUE

password

Required


STRING_VALUE

<string>

This value may be the plain-text password (stored as-is, not encrypted) for the mailbox as defined by the mail server. If using Microsoft Office 365 for IMAP (incoming mail), this value may be an OAuth token identifier obtained through the process described here.

As defined by mail server.

 

 

SMTP Settings

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


OBJECT_VALUE

from_address

Required


STRING_VALUE

<string>


As defined by mail server.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


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

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


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

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


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

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


OBJECT_VALUE

username

Required


STRING_VALUE

<string>


As defined by mail server.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


OBJECT_VALUE

password

Required


STRING_VALUE

<string>

This value may be the plain-text password (stored as-is, not encrypted) for the mailbox as defined by the mail server. If using Microsoft Office 365 for for SMTP (outgoing email), this value may be an OAuth token identifier obtained through the process described here.

As defined by mail server.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

mailSettings

Required


OBJECT_TYPE

smtp

Required


OBJECT_VALUE

useDefaultCredentials

Required


STRING_VALUE

<boolean>

Choose one of:

true

false

 

 

Compressed File Extension

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

earthsoft.net

Required


CONFIG_KEY

compressedFileExtension

Required


OBJECT_TYPE


Null


OBJECT_VALUE


Null


STRING_VALUE

<string>

Defaults to .zip

String value that begins with '.'

Remarks:

Used by EmailDeliver agent and EarthSoft.Reports.Library.75208.dll to change the file name extension of ZIP file attachments.

 

 

Example

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

earthsoft.net

compressedFileExtension



.zip

earthsoft.net

mailSettings

inbox

host

exchange.example.com

earthsoft.net

mailSettings

inbox

port

143

earthsoft.net

mailSettings

inbox

protocol

IMAP

earthsoft.net

mailSettings

inbox

security

implicit

earthsoft.net

mailSettings

inbox

username

EDD@example.com

earthsoft.net

mailSettings

inbox

password

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

earthsoft.net

mailSettings

smtp

host

exchange.example.com

earthsoft.net

mailSettings

smtp

port

995

earthsoft.net

mailSettings

smtp

protocolusedefaultcredentials

true

earthsoft.net

mailSettings

smtp

enable_ssl

true

earthsoft.net

mailSettings

smtp

username

EQuIS-do-not-reply@example.com

earthsoft.net

mailSettings

smtp

password

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