"list"
******

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


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

Gets a list of suppressed recipient email addresses for a user. The
*compartmentId* for suppressions must be a tenancy OCID. The returned
list is sorted by creation time in descending order.


Usage
=====

   oci email suppression list [OPTIONS]


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

--compartment-id, -c [text]

The OCID for the compartment.


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

--all

Fetches all pages of results. If you provide this option, then you
cannot provide the "--limit" option.

--email-address [text]

The email address of the suppression.

--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

--limit [integer]

For list pagination. The maximum number of results per page, or items
to return in a paginated "List" call. *1* is the minimum, *1000* is
the maximum. For important details about how pagination works, see
List Pagination.

--page [text]

For list pagination. The value of the opc-next-page response header
from the previous "List" call. For important details about how
pagination works, see List Pagination.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only
valid when used with "--all" or "--limit", and ignored otherwise.

--sort-by [text]

The field to sort by. The *TIMECREATED* value returns the list in in
descending order by default. The *EMAILADDRESS* value returns the list
in ascending order by default. Use the *SortOrderQueryParam* to change
the direction of the returned list of items.

Accepted values are:

   EMAILADDRESS, TIMECREATED

--sort-order [text]

The sort order to use, either ascending or descending order.

Accepted values are:

   ASC, DESC

--time-created-greater-than-or-equal-to [datetime]

Search for suppressions that were created within a specific date
range, using this parameter to specify the earliest creation date for
the returned list (inclusive). Specifying this parameter without the
corresponding *timeCreatedLessThan* parameter will retrieve
suppressions created from the given *timeCreatedGreaterThanOrEqualTo*
to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as
defined by RFC 3339.

**Example:** 2016-12-19T16:39:57.600Z

   The following datetime formats are supported:

      Format: YYYY-MM-DDTHH:mm:ss.sssTZD
      Example: 2017-09-15T20:30:00.123Z

      Format: YYYY-MM-DDTHH:mm:ssTZD
      Example: 2017-09-15T20:30:00Z

      Format: YYYY-MM-DDTHH:mmTZD
      Example: 2017-09-15T20:30Z

      Format: YYYY-MM-DDTHH:mm:ssTZD
      Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

      Format: YYYY-MM-DDTHH:mm:ssTZD
      Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

      Format: YYYY-MM-DDTHH:mmTZD
      Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

   The timezone for this date and time will be taken as UTC (Needs to
   be surrounded by single or double quotes)

      Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
      Example: '2017-09-15 17:25'

   This date will be taken as midnight UTC of that day

      Format: YYYY-MM-DD
      Example: 2017-09-15

      Example: 1412195400

--time-created-less-than [datetime]

Search for suppressions that were created within a specific date
range, using this parameter to specify the latest creation date for
the returned list (exclusive). Specifying this parameter without the
corresponding *timeCreatedGreaterThanOrEqualTo* parameter will
retrieve all suppressions created before the specified end date, in
"YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

**Example:** 2016-12-19T16:39:57.600Z

   The following datetime formats are supported:

      Format: YYYY-MM-DDTHH:mm:ss.sssTZD
      Example: 2017-09-15T20:30:00.123Z

      Format: YYYY-MM-DDTHH:mm:ssTZD
      Example: 2017-09-15T20:30:00Z

      Format: YYYY-MM-DDTHH:mmTZD
      Example: 2017-09-15T20:30Z

      Format: YYYY-MM-DDTHH:mm:ssTZD
      Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

      Format: YYYY-MM-DDTHH:mm:ssTZD
      Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

      Format: YYYY-MM-DDTHH:mmTZD
      Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

   The timezone for this date and time will be taken as UTC (Needs to
   be surrounded by single or double quotes)

      Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
      Example: '2017-09-15 17:25'

   This date will be taken as midnight UTC of that day

      Format: YYYY-MM-DD
      Example: 2017-09-15

      Example: 1412195400


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

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

"--auth-purpose", "--auth", "--cert-bundle", "--cli-rc-file", "--
config-file", "--debug", "--defaults-file", "--endpoint", "--generate-
full-command-json-input", "--generate-param-json-input", "--help", "--
latest-version", "--no-retry", "--opc-client-request-id", "--opc-
request-id", "--output", "--profile", "--query", "--raw-output", "--
region", "--release-info", "--request-id", "--version", "-?", "-d",
"-h", "-v"


Examples
========

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/suppression/list.html#cmdoption-compartment-id

       oci email suppression list --compartment-id $compartment_id
