SetEmailOption method: ProcessRequest class

Syntax

SetEmailOption(EmailSubject, EmailText, EmailAddress, EmailWebReport, EmailAttachLog [, JobName] [, PrcsItemLevel] [, JobSeqNo] [, ItemJobSeq])

Description

Use the SetEmailOption method to set the email options for all job items in the main job.

Parameters

Parameter Description

EmailSubject

Specify the text used in the subject of the email sent at completion of this job email subject as a string. You can specify a Null ("") for this parameter.

EmailText

Specify the email text sent at completion of this job as a string. You can specify a Null ("") for this parameter.

EmailAddress

Specify the email address of the person you want an email sent to at the completion of this job. To send more than one email address, separate the addresses with a semicolon.

EmailWebReport

Specify whether to attach the web report to the email sent at the completion of this job. This parameter takes a string value: "True", attach the web report, "False", don't attach the web report. This parameter can be set only to "True" when the OutDestType property for the request is "Web".

EmailAttachLog

Specify whether to attach the log file to the email sent at the completion of this job. This parameter takes a string value: "True", attach the log file, "False", don't attach the log file.

JobName

Specify the name of the job that this item belongs to as a string.

PrcsItemLevel

Specify the job item's process item level within the main job as a number.

JobSeqNo

Specify the job item's job sequence number within the process item level as a number.

ItemJobSeq

Specify the job item’s sequence within its parent job as a number

Returns

None.