SubjectWord

 

 

 

SubjectWord

 

Description

Takes the subject line of the message that impelled the job and breaks up the text of the subject line into words based on whitespace.  The macro then returns a word or words based on the numerical order (1-based index) of the text fragments.

 

Arguments

1.SubjectWord - Name of the Macro.

2.Index - The 1-based index of the word or words to return.  This value must be >0.

3.Include Remaining - The optional parameter indicating whether to return all fragments following the target fragment.  The options are true or false.  If not specified the default value is false.

 

Examples

<SubjectWord|1>

If the message subject was "pasUnity: Report File" the value returned would be "pasUnity:".

 

<SubjectWord|1|false>

If the message subject was "pasUnity: Report File" the value returned would be "pasUnity:".

 

<SubjectWord|1|true>

If the message subject was "pasUnity: Report File" the value returned would be "pasUnity: Report File".

 

<SubjectWord|2>

If the message subject was "pasUnity: Report File" the value returned would be "Report".

 

<SubjectWord|2|false>

If the message subject was "pasUnity: Report File" the value returned would be "Report".

 

<SubjectWord|2|true>

If the message subject was "pasUnity: Report File" the value returned would be "Report File".

 

Notes

The SubjectWord function will not generate an error if a job was not impelled by a message - it will just emit a blank value.  If the index value is greater than the number of words in the subject a blank value will be returned.

 


Copyright © 2024 pasUNITY, Inc.

 

Send comments on this topic.