To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Pipeline step that emails a summary of the pipeline's failures, warnings and informational messages to a list of recipients once the run finishes. Recipients may be existing user names or email addresses; an address that does not match an existing profile gets a new one created for it. When onlySendOnFailure is set, the email is skipped unless the run recorded at least one failure. Configured in pipeline XML as ResultEmail.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Short, human-readable description of this step shown to administrators managing a pipeline. |
| formPath | String | Path to the velocity template that renders this step's management UI form. |
| fromAddress | String | The email address the result summary is sent from. |
| next | PipelineStep | The single step that follows this one in the pipeline, or null if none has been configured. |
| nextStep | PipelineStep | The single step that follows this one in the pipeline, or null if none has been configured. Equivalent to getNext. |
| onlySendOnFailure | boolean | Whether the summary email is sent only when the pipeline run recorded at least one failure, rather than on every run. |
| recipients | List<String> | User names or email addresses the result summary email is sent to. An address with no matching profile gets a new profile created for it when the email is sent. |
| subject | String | The base subject line for the result email. The pipeline's path, and a failure count if any failures were recorded, are appended to this when the email is built. |
Methods
getFormPath()
Returns: String
Path to the velocity template that renders this step's management UI form.
getDescription()
Returns: String
Short, human-readable description of this step shown to administrators managing a pipeline.
getFromAddress()
Returns: String
The email address the result summary is sent from.
isOnlySendOnFailure()
Returns: boolean
Whether the summary email is sent only when the pipeline run recorded at least one failure, rather than on every run.
getNext()
Returns: PipelineStep
The single step that follows this one in the pipeline, or null if none has been configured.
getNextStep()
Returns: PipelineStep
The single step that follows this one in the pipeline, or null if none has been configured. Equivalent to getNext.
getRecipients()
Returns: List<String>
User names or email addresses the result summary email is sent to. An address with no matching profile gets a new profile created for it when the email is sent.
getSubject()
Returns: String
The base subject line for the result email. The pipeline's path, and a failure count if any failures were recorded, are appended to this when the email is built.
© 2025 Kademi Ltd