Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

sendEmail

On this page
Back to index

Summary

Send an email message.
attachment
Stringoptional
Attachments for the email.
bcc
Stringoptional
A user name or email address to include in the Bcc: header element.
cc
Stringoptional
A user name or email address to include in the Cc: header element.
configName
Stringoptional
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.
header
Stringoptional
A raw RFC 822 header-line.
html
Stringoptional
The html text body of the message.
inline
Stringoptional
Inline attachments.
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.
multipartMode
Stringoptional
The multipart message mode. Defaults to none for single part messages and mixedRelated for messages with multiple parts.
Possible values: "mixed", "mixedRelated", "none", "related"
raw
Stringoptional
A raw RFC 822 mail message including headers and body.
subject
Stringoptional
The Subject header field of the message.
text
Stringoptional
The plain text body of the message.
to
Stringoptional
A user name or email address to include in the To: header element.

Usage

Perl

$cmdr->sendEmail(
  # optionals
);
▼

ectool

ectool sendEmail \
  # optionals
▼