5.29.3 SET

This command is used to prepare the email and can be called many times with one or more keywords to build up the email definition before it is sent. (This is especially useful in RDML where the command length is limited to 256 characters).

The SET keyword must be used before the SEND keyword.

Comments / Warnings

Any keyword values set up using the SET command will be overridden by use of the equivalent keyword on the SEND command.

Syntax:

Command

Keyword

Value

Developer notes

SET

SERVER

value

Optional.

TIMEOUT.READ

value

The read timeout is the timeout on waiting to read data. If the server (or network) fails to deliver any data seconds after the client makes a socket read call, a read timeout error will be raised.
Default value
timeout.read = 90000

TIMEOUT.WRITE

value

A write timeout defines a maximum time of inactivity between two data packets when sending the request to the server.
Default value
timeout.write = 90000

TIMEOUT.CONNECTION

value

A connect timeout defines a time period in which the client should establish a connection with a target host.
Default value
timeout.connection = 90000

SECURE

value

Optional.

PORT

value

Optional.

MAILDOMAIN

value

Optional.

NTLMDOMAIN

value

Optional.

CHARSET

value

Optional.

USER

value

Optional.

PASSWORD

value

Optional.

AUTH

*XOAUTH2

Token based authentication.

FROM

value

Optional.

TO

*LIST

Optional.

value

Optional.

CC

*LIST

Optional.

value

Optional.

BCC

*LIST

Optional.

value

Optional.

SUBJECT

value

Optional.

ATTACHMENT

value

Optional.

ATTACHMENTNAME

value

Optional.

TENANT.ID

Value

The unique identifier of the Azure AD tenant. Required when using XOAUTH2 with Microsoft identity platform.

Ex: abcd1234-5678-90ef-ghij-klmnopqrstuv

CLIENT.ID

Value

The client_id is a public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string.
Ex- Foursquare: ZYDPLLBWSK3MVQJSIYHB1OR2JXCY0X2C5UJ2QAR2MAAIT5Q

CLIENT.SECRET

Value

The client_secret is a secret known only to the application and the authorization server. It is essential the application’s own password. It must be sufficiently random to not be guessable, which means you should avoid using common UUID libraries, which often take into account the timestamp or MAC address of the server generating it.
Ex - A great way to generate a secure secret is to use a cryptographically-secure library to generate a 256-bit value and then convert it to a hexadecimal representation.
In PHP, you can use the random_bytes function and convert to a hex string:
bin2hex(random_bytes(32));
Lq08Q~EtgN-BpoINX6msRD9GL_cCx

AUTH.TOKEN.ENDPOINT

Value

Token endpoint is used by the application in order to get an access token or a refresh token. It is used by all flows except for the Implicit Flow because, in that case, an access token is issued directly.
Ex -https://login.microsoftonline.com/5c951c05-0f75-44ef-6223f150a449/oauth2/v2.0/token

AUTH.SCOPE

Value

Scope is a way to limit an app’s access to a user’s data. Rather than granting complete access to a user’s account, it is often useful to give apps a way to request a more limited scope of what they are allowed to do on behalf of a user.
Ex- https://outlook.office365.com/.default

TOKEN.CACHE

Value

This is a boolean parameter to save the token at the mentioned directory. It can have two values- true or false.
Ex - Token.cache = true
In this case generated token will be saved at the path mentioned in
Token.cache.dir parameter.

TOKEN.CACHE.DIR

Value

It is a directory where the user wants to save the token while caching.
Ex- C:\Program Files (x86)\LANSA\dummy

SESSION.DEBUG

Value

Enable session debugging to display debugging messages in the user interface.
Ex- true or false

KEYSTORE

name:password

Optional.

 

Example

SET FROM(me@company.com) TO(you@company.com)