modifyEmailConfig

Summary

Modifies an existing email configuration.

configName

Stringrequired

The email configuration name.

credentialName

Stringoptional

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

credentialProjectName

Stringoptional

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

description

Stringoptional

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

mailFrom

Stringoptional

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

mailHost

Stringoptional

Name of the email server host.

mailPort

Integeroptional

The port number for the email service on the server.

mailProtocol

Stringoptional

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

mailUser

Stringoptional

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

mailUserPassword

Stringoptional

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

newName

Stringoptional

The new name for an existing object that is being renamed.

Usage

Groovy

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 */
)▼