list
****


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]


Options
=======


--compartment-id, -c [text]
---------------------------

The OCID for the compartment. [required]


--email-address [text]
----------------------

The email address of the suppression.


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


UTC with milliseconds
~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ss.sssTZD

Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ssTZD

Example: 2017-09-15T20:30:00Z


UTC with minute precision
~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mmTZD

Example: 2017-09-15T20:30Z


Timezone with milliseconds
~~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ssTZD

Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800


Timezone without milliseconds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ssTZD

Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800


Timezone with minute precision
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mmTZD

Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800


Date Only
~~~~~~~~~

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD

Example: 2017-09-15


Epoch seconds
~~~~~~~~~~~~~

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:


UTC with milliseconds
~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ss.sssTZD

Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ssTZD

Example: 2017-09-15T20:30:00Z


UTC with minute precision
~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mmTZD

Example: 2017-09-15T20:30Z


Timezone with milliseconds
~~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ssTZD

Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800


Timezone without milliseconds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mm:ssTZD

Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800


Timezone with minute precision
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Format: YYYY-MM-DDTHH:mmTZD

Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800


Date Only
~~~~~~~~~

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD

Example: 2017-09-15


Epoch seconds
~~~~~~~~~~~~~

Example: 1412195400


--page [text]
-------------

The value of the *opc-next-page* response header from the previous GET
request.


--limit [integer]
-----------------

The maximum number of items to return in a paginated GET request.


--sort-by [TIMECREATED|EMAILADDRESS]
------------------------------------

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.


--sort-order [ASC|DESC]
-----------------------

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


--all
-----

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


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


--from-json [text]
------------------

Provide input to this command as a JSON document from a file.

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


-?, -h, --help
--------------

Show this message and exit.
