Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

createEmailConfig

Back to index

Summary

Creates a new 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/RO 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.

Usage

Perl

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

ectool

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

Examples

Perl

$cmdr->createEmailConfig("testConfiguration", {mailHost => "test-sol2", mailFrom => "test_user@abc.com", mailUser => "build@abc.com", mailUserPassword => "mybuildmail"});
▼

ectool

ectool createEmailConfig EmailConfig_test --mailHost test-sol2 --mailFrom "test_user@abc.com" --mailUser "build@abc.com" --mailUserPassword "mybuildmail" --description "This is a test for the email config object"
▼