modifyEmailConfig

Summary

Modifies an existing email configuration.

Stringrequired

The email configuration name.

Stringoptional

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

Stringoptional

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

Stringoptional

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

Stringoptional

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

Stringoptional

Name of the email server host.

Integeroptional

The port number for the email service on the server.

Stringoptional

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

Stringoptional

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

Stringoptional

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

Stringoptional

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

$cmdr->modifyEmailConfig(
  "test-configName" # configName
  # optionals
);▼

ectool modifyEmailConfig \
  "test-configName" `# configName` \
  # optionals▼

$cmdr->modifyEmailConfig("QA test", {mailFrom => "test@example.com"});▼

ectool modifyEmailConfig "QA test" --mailFrom "test@example.com"
    --description "This is a Secure SMTP email config object for testing"▼