Page History

This server-side class is intended to implement to the email objects for applications; use these methods along with the email global object available in mail notification scripts.

addAddress(address, displayName)

This method adds the address to the email listpopulates the To field of the Email (sys_email) table record with address specified.

Parameter(s):

Name	Type	Mandatory	Default Value
address	String	Y	N
displayName	String or Null	N	'NULL'

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addAddress

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.addAddress('test@example.com', 'firstname lastname');
})(current, template, email, event);

addAddressBcc(address, displayName)

This method adds populates the address to the "Blind Carbon Copy" or "bcc" list applied to the specified letter field of the Email (sys_email) table record with address specified.

Parameter(s):

Name	Type	Mandatory	Default Value
address	String	Y	N
displayName	String or Null	N	'NULL'

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addAddressBcc

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.addAddressBcc('test@example.com', 'firstname lastname');
})(current, template, email, event);

addAddressCc(address, displayName)

This method adds populates the address to the "Carbon Copy" or "cc" email list applied to the specified letter Carbon Copy field of the Email (sys_email) table record with address specified.

Parameter(s):

Name	Type	Mandatory	Default Value
address	String	Y	N
displayName	String or Null	N	'NULL'

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addAddressCc

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.addAddressCc('test@example.com', 'firstname lastname');
})(current, template, email, event);

getAddresses()

This method gets the recipients' addresses.

Return:

Type	Description
String	A string containing the recipient's addresses.

Example:

Code Block

language	js
theme	Eclipse
title	getAddresses

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getAddresses();
})(current, template, email, event);

getAddressesBcc()

This method gets the recipients' BCC addresses.

Return:

Type	Description
String	A string containing the recipient's BCC addresses.

Example:

Code Block

language	js
theme	Eclipse
title	getAddressesBcc

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getAddressesBcc();
})(current, template, email, event);

getAddressesCc()

This method gets the recipients' CC addresses.

Return:

Type	Description
String	A string containing the recipient's CC addresses.

Example:

Code Block

language	js
theme	Eclipse
title	getAddressesCc

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getAddressesCc();
})(current, template, email, event);

getBody()

This method gets the message body.

Return:

Type	Description
String	The message body.

Example:

Code Block

language	js
theme	Eclipse
title	getBody

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getBody();
})(current, template, email, event);

getFrom()

This method gets the sender's address.

Return:

Type	Description
String	A string containing the sender's address.

Example:

Code Block

language	js
theme	Eclipse
title	getForm

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getFrom();
})(current, template, email, event);

getReplyTo()

This method gets the replyTo address.

Return:

Type	Description
String	A string containing the replyTo address.

Example:

Code Block

language	js
theme	Eclipse
title	getReplyTo

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getReplyTo();
})(current, template, email, event);

getSubject()

This method returns the message subject line.

Return:

Type	Description
String	A string containing the message subject line.

Example:

Code Block

language	js
theme	Eclipse
title	getSubject

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getSubject();
})(current, template, email, event);

setBody(bodyText)

This method sets the message body.

Parameter(s):

Name	Type	Mandatory	Default Value
bodyText	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setBody

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setBody(`Additional comments have been added to ${current.number}`);
})(current, template, email, event);

setFrom(address)

This method sets the sender's address.

Parameter(s):

Name	Type	Mandatory	Default Value
address	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setFrom

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setFrom('test@example.com');
})(current, template, email, event);

setReplyTo(address)

This method sets the replyTo address.

Parameter(s):

Name	Type	Mandatory	Default Value
address	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setReplyTo

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setReplyTo('test@example.com');
})(current, template, email, event);

setSubject(subject)

This method sets the email subject line.

Parameter(s):

Name	Type	Mandatory	Default Value
subject	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setSubject

(function runNotificationScript(
    /* SimpleRecord */ current, 
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setSubject('Additional comments have been added');
})(current, template, email, event);

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 14

New Version 15

Key

addAddress(address, displayName)

addAddressBcc(address, displayName)

addAddressCc(address, displayName)

getAddresses()

getAddressesBcc()

getAddressesCc()

getBody()

getFrom()

getReplyTo()

getSubject()

setBody(bodyText)

setFrom(address)

setReplyTo(address)

setSubject(subject)