"submit-email"
**************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Submits a formatted email.


Usage
=====

   oci email-data-plane email-submitted-response submit-email [OPTIONS]


Required Parameters
===================

--recipients [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--sender [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--subject [text]

A short summary of the content, which will appear in the recipient’s
inbox. UTF-8 supported RFC 2047.


Optional Parameters
===================

--body-html [text]

HTML body content in UTF-8. NOTE: Even though bodytext and bodyhtml
are both optional, at least one of them must be provided.

--body-text [text]

Text body content. NOTE: Even though bodytext and bodyhtml are both
optional, at least one of them must be provided.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--header-fields [complex type]

The header used by the customer for the email sent. Reserved headers
are not allowed e.g “subject”, “from”, and “to” etc. Example: *{“bar-
key”: “value”}* This is a complex type whose value must be valid JSON.
The value can be provided as a string on the command line or passed in
as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--message-id [text]

The unique ID for the email’s Message-ID header used for service log
correlation. The submission will return an error if the syntax is not
a valid RFC 5322 Message-ID. This will be generated if not provided.
Example: sdiofu234qwermls24fd@mail.example.com

--reply-to [complex type]

The email address for the recipient to reply to. If left blank,
defaults to the sender address.

This option is a JSON list with items of type EmailAddress.  For
documentation on EmailAddress please see our API reference: https://d
ocs.cloud.oracle.com/api/#/en/emaildp/20220926/datatypes/EmailAddress.
This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy and paste the following example into a JSON file, replacing the
example parameters with your own.

       oci email-data-plane email-submitted-response submit-email --generate-param-json-input recipients > recipients.json
       oci email-data-plane email-submitted-response submit-email --generate-param-json-input sender > sender.json

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export subject=<substitute-value-of-subject> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email-data-plane/email-submitted-response/submit-email.html#cmdoption-subject

       oci email-data-plane email-submitted-response submit-email --recipients file://recipients.json --sender file://sender.json --subject $subject
