Skip to main content

Email Endpoints Reference

This is a reference for the Email Endpoints integration.

Server Config Name

Specifies the reference name of the email server.

Type

String

Required

Yes

Default

Email server reference name

Hostname

Specifies the hostname or IP address of the email server.

Type

String

Required

Yes

Default

Hostname or IP address of the mail server

Port

Specifies the port used for the email server.

Type

Integer

Required

Yes

Default

0

Account

Specifies the email address of the account.

Type

String

Required

Yes

Default

N/A

Password

The password for the account.

Type

String

Required

No

Default

N/A

Encrypted

Encrypt email messages.

Type

Boolean

Required

No

Default

Unchecked

START_TLS

Use Opportunistic TLS.

Type

Boolean

Required

No

Default

Unchecked

USE_TLS

Connect to the the email server using TLS.

Type

Boolean

Required

No

Default

Unchecked

Use Proxy in Request

Specifies a connection for a proxy server if you want to connect to the external system through a proxy.

Type

Boolean

Required

Yes

Default

No

Proxy Host

Specifies the hostname for the proxy server.

Type

String

Required

If Use Proxy in Request is set to Yes.

Default

N/A

Proxy Port

Specifies the port number for the proxy server.

Type

Integer

Required

If Use Proxy in Request is set to Yes.

Default

8080

Proxy User

Specifies the user for the proxy server.

Type

String

Required

If Use Proxy in Request is set to Yes.

Default

dummy

Proxy Password

Specifies the password for the proxy server.

Type

String

Required

No

Default

N/A

Message Template Name

Specifies the name of the email template. You can use the name to differentiate different message templates.

Type

String

Required

Yes

Default

<message template name>

Message Subject

Specifies the subject field for a given email template.

Type

String

Required

Yes

Default

Enter message subject, macro substitution supported

Message Body

Specifies the body for a given email template.

Type

String

Required

Yes

Default

Enter message body, macro substitution supported - use $NL for newline

Team Name

The team name should match the team name resulting from $EXPAND(teams). For an example, see sendEmailUsingTemplate.

Type

String

Required

Yes

Default

<team name>

Email Address

Email address destination for the team.

Type

String

Required

Yes

Default

<email address>