Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter TwelveInternet Functions (continued)

EmailSetupSMTP Function

Overview

The EmailSetupSMTP function sends a simple email. The body can be text or HTML.

Syntax/Parameters

Syntax

int = EmailSetupSMTP ( string host, string email, string user_id, string user_pw,
                  [int port], [string alias] ); 

Parameters

host

A string containing the host name which is a combination of the domain plus a possible prefix such as “mail” or “smtp”. Check the provided/server for the complete name.

email

A string containing the email name to me sent from.

user_id

A string specifying the user ID.

user_pw

A string specifying the user password.

port

An optional int specifying the port. The default is 25.

alias

An optional string specifying alias name. This is presently not used.

Return Value

Returns an int as ERROR_NONE (0) or a formatted error code on failure. Use the GetLastError and GetLastErrorMessage functions to retrieve additional details.

Note that this function sets up the parameters. A failure on login is not reported.

Remarks

Depending on the application, the SMTP settings may be initially set by the application preference. This function overrides the existing settings or sets the initial setting. It does not set the preferences.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE