ec-sendemail

3 minute readExtensibilityDeveloper productivity

Plugin version 1.0.7.2022040609

Revised on April 6, 2022

Plugin procedures

Send Email

This procedure sends email using CloudBees CD/RO sendEmail API.

Send Email parameters

ParameterDescription

Attachment(s)

One or more files to send as attachments. Newline-separated list of file names.

BCC

A semicolon-separated list of "bcc" recipients for the email message. The recipient can be a user name, group name or complete email address. You can enter this argument more than once to specify multiple recipients.

CC

A semicolon-separated list of "cc" recipients for the email message. The recipient can be a user name, group name, or complete email address. You can enter this argument more than once to specify multiple recipients.

Email Configuration

The name of the email configuration. If no configuration is specified, the configuration named "default" is used.

NOTE: The user must have execute permission on the configuration.

Header(s)

Newline-separated list of email headers. An RFC822 email header line (for example: "reply-to: user@example.com").

HTML

The body of a simple HTML message.

HTML file

Reads the specified file and uses it as the body of a simple HTML message.

In-line Attachment(s)

Newline-separated list of inline attachments. Inline attachments in this format: <contentId>=<fileName> [<contentId>=<fileName> …​]. One or more inline attachments specified as a contentId and a client-side filename. The filename extension is examined to determine the content-type. The contentId can be referenced in an HTML body using the cid:protocol.

Multipart Mode

The multipart message mode: <none|mixed|related|mixedRelated>

* none: Non-multipart message. * mixed: Single-root multipart element of type "mixed". Text, inline elements, and attachments are added to this root element. * related: Multipart message with a single root multipart element of "related" type. Text, inline elements, and attachments are added to this root element. It works on most mail clients, except Lotus Notes. * mixedRelated: Multipart "mixed" element with a nested multipart "related" element. Text and inline elements are added to the nested "related" element, while attachments are added to the "mixed' root element. It works on most mail clients other than Mac Mail and certain scenarios in Microsoft Outlook. If you experience problems, use the "related" value.

NOTE: multipartMode defaults to none unless there are multiple parts, in which case it defaults to mixedRelated. If both text and html arguments are specified, both values are sent as alternates in a multipart message.

Raw

A raw RFC 822 email message including headers to use as the basis for the email message. Additional options can be applied to this message.

Raw file

Reads the specified client-side file and uses it as the entire mail message, including headers.

Subject

The subject of the email message.

Message

The body of the email message, or a workspace file containing the body. If both a plain text and an HTML message are provided, both values are sent as alternates in a multipart message. If a raw message is provided, the value should be a properly formatted RFC822 message.

Text file

Reads the specified client-side file and uses it as the body of a simple text message.

To

A semicolon-separated list of "to" recipients for the email message. The recipient can be a user, group name, or complete email address. You can enter this argument more than once to specify multiple recipients.

Release notes

EC-SendEmail 1.0.7

  • Extend the documentation

EC-SendEmail 1.0.6

  • Fixed drop-down list

  • Renamed from "Electric Cloud" to "CloudBees"

  • Fixed catch of formal parameters

  • Changed the way step retrieves the parameters

  • Reverted the clearing empty parameters code

  • Added bintray to repositories

  • Checked dependencies with GCP artifactory

  • Checked for attachment name

EC-SendEmail 1.0.5

  • Fixed the issue with unrecognized parameters in the application component process definition.