Octopus.Email exported 2026-07-22 by Octopus Deploy belongs to ‘Other’ category.
Sends an email using a configured SMTP server.
Parameters
When this step is included in a project’s deployment process, the parameters below can be set.
To
Octopus.Action.Email.To
Email addresses to send the email to. Separate multiple email addresses with ; or ,. At least one To address or Team must be entered.
Example: user@example.com
To teams
Octopus.Action.Email.ToTeamIds
The teams whose members should receive the email.
Example: teams-123
CC
Octopus.Action.Email.CC
Email addresses to CC. Separate multiple email addresses with ; or ,.
CC teams
Octopus.Action.Email.CCTeamIds
The teams whose members should be CC’d on the email.
BCC
Octopus.Action.Email.Bcc
Email addresses to BCC. Separate multiple email addresses with ; or ,.
BCC teams
Octopus.Action.Email.BccTeamIds
The teams whose members should be BCC’d on the email.
Subject
Octopus.Action.Email.Subject (required)
The subject line of the email.
Body
Octopus.Action.Email.Body (required)
The email body as raw text or HTML. Supports Octopus variable substitution syntax including conditional if/unless and iteration with each.
Email body format
Octopus.Action.Email.IsHtml
Whether the email body is HTML or plain text.
Allowed values: True, False
Default: False
Priority
Octopus.Action.Email.Priority
Select the priority of the email.
Allowed values: Low, Normal, High
Default: Normal
Step configuration using OCL
Example in Octopus Configuration Language (OCL):
step "send-email" {
name = "Send Email"
action {
action_type = "Octopus.Email"
properties = {
Octopus.Action.Email.Body = "Deployment completed successfully."
Octopus.Action.Email.IsHtml = "False"
Octopus.Action.Email.Priority = "Normal"
Octopus.Action.Email.Subject = "Deployment of #{Octopus.Project.Name} to #{Octopus.Environment.Name}"
Octopus.Action.Email.To = "ops@example.com"
Octopus.Action.RunOnServer = "false"
}
}
}Page updated on Wednesday, July 22, 2026