Class EmailPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of Email where multiple pages of data may be fetched. Two styles of enumerators are supported:

  • Enumerating over the Response objects returned by the list operation. These are referred to as ResponseEnumerators, and the methods are suffixed with ResponseEnumerator. For example: listUsersResponseEnumerator.
  • Enumerating over the resources/records being listed. These are referred to as RecordEnumerators, and the methods are suffixed with RecordEnumerator. For example: listUsersRecordEnumerator.
These enumerators abstract away the need to write code to manually handle pagination via looping and using the page tokens. They will automatically fetch more data from the service when required.

As an example, if we were using the ListUsers operation in IdentityService, then the iterator returned by calling a ResponseEnumerator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the enumerables returned by calling a RecordEnumerator method would iterate over the User records and we don't have to deal with ListUsersResponse objects at all. In either case, pagination will be automatically handled so we can iterate until there are no more responses or no more resources/records available.
Inheritance
object
EmailPaginators
Inherited Members
Namespace: Oci.EmailService
Assembly: OCI.DotNetSDK.Email.dll
Syntax
public class EmailPaginators

Constructors

EmailPaginators(EmailClient)

Declaration
public EmailPaginators(EmailClient client)
Parameters
Type Name Description
EmailClient client

Methods

ListDkimsRecordEnumerator(ListDkimsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the DkimSummary objects contained in responses from the ListDkims operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<DkimSummary> ListDkimsRecordEnumerator(ListDkimsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDkimsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<DkimSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListDkimsResponseEnumerator(ListDkimsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListDkims operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListDkimsResponse> ListDkimsResponseEnumerator(ListDkimsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDkimsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListDkimsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListEmailDomainsRecordEnumerator(ListEmailDomainsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the EmailDomainSummary objects contained in responses from the ListEmailDomains operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<EmailDomainSummary> ListEmailDomainsRecordEnumerator(ListEmailDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEmailDomainsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<EmailDomainSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListEmailDomainsResponseEnumerator(ListEmailDomainsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListEmailDomains operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListEmailDomainsResponse> ListEmailDomainsResponseEnumerator(ListEmailDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEmailDomainsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListEmailDomainsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListEmailReturnPathsRecordEnumerator(ListEmailReturnPathsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the EmailReturnPathSummary objects contained in responses from the ListEmailReturnPaths operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<EmailReturnPathSummary> ListEmailReturnPathsRecordEnumerator(ListEmailReturnPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEmailReturnPathsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<EmailReturnPathSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListEmailReturnPathsResponseEnumerator(ListEmailReturnPathsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListEmailReturnPaths operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListEmailReturnPathsResponse> ListEmailReturnPathsResponseEnumerator(ListEmailReturnPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEmailReturnPathsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListEmailReturnPathsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListSendersRecordEnumerator(ListSendersRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the SenderSummary objects contained in responses from the ListSenders operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<SenderSummary> ListSendersRecordEnumerator(ListSendersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSendersRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<SenderSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListSendersResponseEnumerator(ListSendersRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListSenders operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListSendersResponse> ListSendersResponseEnumerator(ListSendersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSendersRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListSendersResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListSuppressionsRecordEnumerator(ListSuppressionsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the SuppressionSummary objects contained in responses from the ListSuppressions operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<SuppressionSummary> ListSuppressionsRecordEnumerator(ListSuppressionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSuppressionsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<SuppressionSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListSuppressionsResponseEnumerator(ListSuppressionsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListSuppressions operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListSuppressionsResponse> ListSuppressionsResponseEnumerator(ListSuppressionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSuppressionsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListSuppressionsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestError objects contained in responses from the ListWorkRequestErrors operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestError> ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestError>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequestErrors operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestErrorsResponse> ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestErrorsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestLogEntry objects contained in responses from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestLogEntry> ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestLogEntry>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestLogsResponse> ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestLogsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestSummary objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestSummary> ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestsResponse> ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type