Roadmap to CloudBees CD APIs
IntroductionUsing the Groovy APIUsing JRubyCloudBees CD API error messages
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API response and element glossary
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential managementCustom filtersDatabase configurationData retentionDevOps insightDirectory Provider managementDynamic environmentsemail configuration managementEmail Notifier managementEnvironmentEnvironment tierGateway and Zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and Group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Using the Groovy API
IntroductionExamples
Groovy API reference
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

EmailNotifier

8 minute readReference

createEmailNotifier

Create an EmailNotifier on a property sheet container specified by an emailNotifierSelector.

Arguments

Argument NameTypeDescription

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep)

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep)

condition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

configName

String

Name for an email configuration; or a text that - through property expansion - results into such an email configuration name

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD.

destinations

String

A list of space-separated user names, email addresses or email aliases or a text that - through property expansion - results into such a list.

environmentNames

String array

Name of the environments

eventType

String

An enumeration of valid event categories recognized by the email notifiers.

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

formattingTemplate

String

String containing email formatting instructions for generating notifications.

gateType

String

The type of the gate.

groupNames

String array

A list of names of the groups which receives the notification.

jobStepId

String

The primary key of the job-step container of the email notifier.

notificationType

String

The notification type which will be stored to the ec_notificationType property

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier)

processStepName

String

The name of the process step container of the email notifier)

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

serviceName

String

The name of the service which is related to the target email container (Process/ProcessStep)

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

the name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

String array

A list of names of the users who receives the notification.

workflowDefinitionName

String

the name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createEmailNotifier(
                notifierName: 'test-notifierName'
                /* optional arguments */)

deleteEmailNotifier

Delete an EmailNotifier from a (property sheet) container.

Arguments

Argument NameTypeDescription

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep)

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep)

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

String

The type of the gate.

jobStepId

String

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier)

processStepName

String

The name of the process step container of the email notifier)

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

serviceName

String

The name of the service which is related to the target email container (Process/ProcessStep)

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

the name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

the name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEmailNotifier(
                notifierName: 'test-notifierName'
                /* optional arguments */)

getEmailNotifier

Get an EmailNotifier from a property sheet container.

Arguments

Argument NameTypeDescription

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep)

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep)

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

String

The type of the gate.

jobStepId

String

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier)

processStepName

String

The name of the process step container of the email notifier)

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

serviceName

String

The name of the service which is related to the target email container (Process/ProcessStep)

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

the name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

the name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getEmailNotifier(
                notifierName: 'test-notifierName'
                /* optional arguments */)

getEmailNotifiers

Get all EmailNotifier’s defined for the specified property sheet container.

Arguments

Argument NameTypeDescription

jobId

String

The primary key or name of the job container of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep)

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep)

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

String

The type of the gate.

jobStepId

String

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier)

processStepName

String

The name of the process step container of the email notifier)

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

serviceName

String

The name of the service which is related to the target email container (Process/ProcessStep)

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

the name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

the name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getEmailNotifiers(
                /* optional arguments */)

modifyEmailNotifier

Modify an EmailNotifier on a property sheet container specified by an emailNotifierSelector.

Arguments

Argument NameTypeDescription

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep)

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep)

condition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

configName

String

Name for an email configuration; or a text that - through property expansion - results into such an email configuration name

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD.

destinations

String

A list of space-separated user names, email addresses or email aliases or a text that - through property expansion - results into such a list.

environmentNames

String array

Name of the environments

eventType

String

An enumeration of valid event categories recognized by the email notifiers.

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

formattingTemplate

String

String containing email formatting instructions for generating notifications.

gateType

String

The type of the gate.

groupNames

String array

A list of names of the groups which receives the notification.

jobStepId

String

The primary key of the job-step container of the email notifier.

newName

String

New name for an existing object that is being renamed.

notificationType

String

The notification type which will be stored to the ec_notificationType property

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier)

processStepName

String

The name of the process step container of the email notifier)

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

serviceName

String

The name of the service which is related to the target email container (Process/ProcessStep)

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

the name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

String array

A list of names of the users who receives the notification.

workflowDefinitionName

String

the name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyEmailNotifier(
                notifierName: 'test-notifierName'
                /* optional arguments */)
emailconfig
entitychange