EmailConfig

createEmailConfig

Creates a new email configuration.

Arguments

Argument Name	Type	Description
configName	String	The email configuration name. (Required)
credentialName	String	The name of the credential that contains the email password for the user from which CloudBees CD/RO sends email notifications.
credentialProjectName	String	The name of the credential project that contains the email password for the user from which CloudBees CD/RO sends email notifications.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
mailFrom	String	The email address used as the email sender address for CloudBees CD/RO notifications.
mailHost	String	Name of the email server host.
mailPort	Integer	The port number for the email service on the server.
mailProtocol	String	Name of the email transport protocol. Supported protocol names: 'SMTP', 'SMTPS'
mailUser	String	Name of the email user on behalf of which CloudBees CD/RO sends email notifications.
mailUserPassword	String	Password of the email user on behalf of which CloudBees CD/RO sends email notifications.

Argument Name

Type

Description

configName

String

The email configuration name. (Required)

credentialName

String

The name of the credential that contains the email password for the user from which CloudBees CD/RO sends email notifications.

credentialProjectName

String

The name of the credential project that contains the email password for the user from which CloudBees CD/RO sends email notifications.

description

String

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

mailFrom

String

The email address used as the email sender address for CloudBees CD/RO notifications.

mailHost

String

Name of the email server host.

mailPort

Integer

The port number for the email service on the server.

mailProtocol

String

Name of the email transport protocol. Supported protocol names: 'SMTP', 'SMTPS'

mailUser

String

Name of the email user on behalf of which CloudBees CD/RO sends email notifications.

mailUserPassword

String

Password of the email user on behalf of which CloudBees CD/RO sends email notifications.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createEmailConfig(
                configName: 'test-configName'
                /* optional arguments */)

deleteEmailConfig

Deletes an email configuration.

Arguments

Argument Name	Type	Description
configName	String	The email configuration name. (Required)

Argument Name

Type

Description

configName

String

The email configuration name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEmailConfig(
                configName: 'test-configName')

getEmailConfig

Retrieve an email configuration by name.

Arguments

Argument Name	Type	Description
configName	String	The email configuration name. (Required)

Argument Name

Type

Description

configName

String

The email configuration name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEmailConfig(
                configName: 'test-configName')

getEmailConfigs

Retrieve all email configurations.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEmailConfigs()

modifyEmailConfig

Modifies an existing email configuration.

Arguments

Argument Name	Type	Description
configName	String	The email configuration name. (Required)
credentialName	String	The name of the credential that contains the email password for the user from which CloudBees CD/RO sends email notifications.
credentialProjectName	String	The name of the credential project that contains the email password for the user from which CloudBees CD/RO sends email notifications.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
mailFrom	String	The email address used as the email sender address for CloudBees CD/RO notifications.
mailHost	String	Name of the email server host.
mailPort	Integer	The port number for the email service on the server.
mailProtocol	String	Name of the email transport protocol. Supported protocol names: 'SMTP', 'SMTPS'
mailUser	String	Name of the email user on behalf of which CloudBees CD/RO sends email notifications.
mailUserPassword	String	Password of the email user on behalf of which CloudBees CD/RO sends email notifications.
newName	String	New name for an existing object that is being renamed.

Argument Name

Type

Description

configName

String

The email configuration name. (Required)

credentialName

String

The name of the credential that contains the email password for the user from which CloudBees CD/RO sends email notifications.

credentialProjectName

String

The name of the credential project that contains the email password for the user from which CloudBees CD/RO sends email notifications.

description

String

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

mailFrom

String

The email address used as the email sender address for CloudBees CD/RO notifications.

mailHost

String

Name of the email server host.

mailPort

Integer

The port number for the email service on the server.

mailProtocol

String

Name of the email transport protocol. Supported protocol names: 'SMTP', 'SMTPS'

mailUser

String

Name of the email user on behalf of which CloudBees CD/RO sends email notifications.

mailUserPassword

String

Password of the email user on behalf of which CloudBees CD/RO sends email notifications.

newName

String

New name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyEmailConfig(
                configName: 'test-configName'
                /* optional arguments */)