Package com.inductiveautomation.ignition.client.script

Class ClientNetUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.AbstractNetUtilities

com.inductiveautomation.ignition.client.script.ClientNetUtilities

public class ClientNetUtilities
extends AbstractNetUtilities

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractNetUtilities

commonContext

Constructor Summary

Constructors

Constructor	Description
ClientNetUtilities(CommonContext context)

Method Summary

Modifier and Type	Method	Description
protected void	_sendEmail(String smtpSettingsName, String from, String subject, String body, boolean html, String[] recipients, String[] ccRecipients, String[] bccRecipients, String[] attachNamesArg, byte[][] attachBytesArg, int timeout, int retries, String priority, String[] replyTo)	Sends an email with or without authorization and attachments, depending an what arguments are null.
protected void	_sendEmail(String smtp, String from, String subject, String body, boolean html, String[] recips, String username, String password, String priority, String[] attachNamesArg, byte[][] attachBytesArg, int timeout, String[] replyTo)	Sends an email with or without authorization and attachments, depending an what arguments are null.
protected List<String>	getRemoteServers(Boolean getRunningOnly)	Returns a list of Gateway Network servers that are visible on the local Gateway.

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractNetUtilities

generateEmailContentType, getHostName, getIpAddress, getRemoteServers, httpClient, httpDelete, httpGet, httpPost, httpPost, httpPut, httpPut, sendAuthEmail, sendAuthEmail, sendAuthEmail, sendEmail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClientNetUtilities

public ClientNetUtilities(CommonContext context)

Method Details

_sendEmail

protected void _sendEmail(String smtp,
 String from,
 String subject,
 String body,
 boolean html,
 String[] recips,
 String username,
 String password,
 String priority,
 String[] attachNamesArg,
 byte[][] attachBytesArg,
 int timeout,
 String[] replyTo)

Description copied from class: AbstractNetUtilities

Sends an email with or without authorization and attachments, depending an what arguments are null. This method is retained for backwards compatibility

Specified by:

_sendEmail in class AbstractNetUtilities

Parameters:

smtp - Address of the mail server, for example, mail.mycompany.com

from - An email address to use as the email's from address. Also the return address.

subject - The subject of the email.

body - The body of the email.

html - A boolean (0/1) indicating whether or not the body is HTML formatted.

recips - A python sequence of recipient email addresses.

replyTo - A python sequence of reply-to email addresses.

_sendEmail

protected void _sendEmail(String smtpSettingsName,
 String from,
 String subject,
 String body,
 boolean html,
 String[] recipients,
 String[] ccRecipients,
 String[] bccRecipients,
 String[] attachNamesArg,
 byte[][] attachBytesArg,
 int timeout,
 int retries,
 String priority,
 String[] replyTo)

Description copied from class: AbstractNetUtilities

Sends an email with or without authorization and attachments, depending an what arguments are null.

Specified by:

_sendEmail in class AbstractNetUtilities

Parameters:

smtpSettingsName - Name of an existing smtpSettings record to use

from - An email address to use as the email's from address. Also the return address.

subject - The subject of the email.

body - The body of the email.

html - A boolean (0/1) indicating whether or not the body is HTML formatted.

recipients - A python sequence of recipient email addresses.

attachNamesArg - List of attachment names

attachBytesArg - List of attachment data, must be the same length as the names

replyTo - A python sequence of reply-to email addresses.

getRemoteServers

protected List<String> getRemoteServers(Boolean getRunningOnly)
                                 throws GatewayException

Description copied from class: AbstractNetUtilities

Returns a list of Gateway Network servers that are visible on the local Gateway.

Specified by:

getRemoteServers in class AbstractNetUtilities

Parameters:

getRunningOnly - set to true to indicate that only currently reachable servers should be returned

Returns:

a List of Strings representing ServerIds

Throws:

GatewayException