Skip to content

send-email

Send an email

Description

Send an email with an existing template or with a subject and body

Synopsis

send-email
    --to <to>
    [--cc <cc>]
    [--subject <subject>]
    [--body <body>]
    [--template <template>]
    [<template_args>]

Arguments

to - (string)

     Addressses to which email is to be sent
     Example: --to "to-1"
     Default: _None_      Attributes: required, multiple allowed

cc - (string)

     Addressses to which email is Cc-ed
     Example: --cc "cc-1"
     Default: _None_      Attributes: optional, multiple allowed

subject - (string)

     Subject of the email
     Example: --subject "subject-1"
     Default: _None_      Attributes: optional

body - (string)

     Body of the email
     Example: --body "body-1"
     Default: _None_      Attributes: optional

template - (string)

     Template to be used for sending the email. Template/args are mutually exclusive with subject/body
     Example: --template "template-1"
     Default: _None_      Attributes: optional

template_args - (string)

     Template arguments(json) to be used for sending the email
     Example: "template_args-1"
     Default: _None_      Attributes: optional

Examples

Input: 

! send-email --to "varghese@maira.io" --subject "Hello" --body "Hello there"
Output: 
Email Sent!
Input: 
! send-email --to "varghese@maira.io" --template "d-09e71fe13d354a90aedf1bb8e733d8c7" `{"name":"Varghese", "message":"Hello"}`
Output: 
Email Sent!

Access Control

To use this command, you need access to the following:

Field Value
Action "create"
Service Type "builtin"
Service Instance
Namespace
Object Type "email"
Object ID

Please see Access Control for details.