Class ListSendersRequest

Inheritance
object
ListSendersRequest
Implements
Inherited Members
Namespace: Oci.EmailService.Requests
Assembly: OCI.DotNetSDK.Email.dll
Syntax
public class ListSendersRequest : IOciRequest
Examples

Click here to see an example of how to use ListSenders request.

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID for the compartment.
Remarks

Required

Domain

Declaration
[HttpConverter(TargetEnum.Query, "domain")]
public string Domain { get; set; }
Property Value
Type Description
string

A filter to only return resources that match the given domain exactly.

EmailAddress

Declaration
[HttpConverter(TargetEnum.Query, "emailAddress")]
public string EmailAddress { get; set; }
Property Value
Type Description
string

The email address of the approved sender.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Sender.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Sender.LifecycleStateEnum?

The current state of a sender.

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

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.

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

The request ID for tracing from the system

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

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.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListSendersRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListSendersRequest.SortByEnum?

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.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type Description
SortOrder?

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

Implements