Class ExpiredControllerApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class ExpiredControllerApi : IExpiredControllerApi, IExpiredControllerApiSync, IExpiredControllerApiAsync, IApiAccessor
Constructors
View SourceExpiredControllerApi()
Initializes a new instance of the ExpiredControllerApi class.
Declaration
public ExpiredControllerApi()
ExpiredControllerApi(Configuration)
Initializes a new instance of the ExpiredControllerApi class using Configuration object
Declaration
public ExpiredControllerApi(Configuration configuration)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of Configuration |
ExpiredControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)
Initializes a new instance of the ExpiredControllerApi class using a Configuration object and client instance.
Declaration
public ExpiredControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ISynchronousClient | client | The client interface for synchronous API access. |
IAsynchronousClient | asyncClient | The client interface for asynchronous API access. |
IReadableConfiguration | configuration | The configuration object. |
ExpiredControllerApi(string)
Initializes a new instance of the ExpiredControllerApi class.
Declaration
public ExpiredControllerApi(string basePath)
Parameters
Type | Name | Description |
---|---|---|
string | basePath |
Properties
View SourceAsynchronousClient
The client for accessing this underlying API asynchronously.
Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
Type | Description |
---|---|
IAsynchronousClient |
Client
The client for accessing this underlying API synchronously.
Declaration
public ISynchronousClient Client { get; set; }
Property Value
Type | Description |
---|---|
ISynchronousClient |
Configuration
Gets or sets the configuration object
Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
Type | Description |
---|---|
IReadableConfiguration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
View SourceGetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetExpirationDefaults(int)
Get default expiration settings Return default times used for inbox expiration
Declaration
public ExpirationDefaults GetExpirationDefaults(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ExpirationDefaults | ExpirationDefaults |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpirationDefaultsAsync(int, CancellationToken)
Get default expiration settings Return default times used for inbox expiration
Declaration
public Task<ExpirationDefaults> GetExpirationDefaultsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ExpirationDefaults> | Task of ExpirationDefaults |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpirationDefaultsWithHttpInfo(int)
Get default expiration settings Return default times used for inbox expiration
Declaration
public ApiResponse<ExpirationDefaults> GetExpirationDefaultsWithHttpInfo(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<ExpirationDefaults> | ApiResponse of ExpirationDefaults |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpirationDefaultsWithHttpInfoAsync(int, CancellationToken)
Get default expiration settings Return default times used for inbox expiration
Declaration
public Task<ApiResponse<ExpirationDefaults>> GetExpirationDefaultsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<ExpirationDefaults>> | Task of ApiResponse (ExpirationDefaults) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxByInboxId(Guid, int)
Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
Declaration
public ExpiredInboxDto GetExpiredInboxByInboxId(Guid inboxId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | inboxId | ID of inbox you want to retrieve (not the inbox ID) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ExpiredInboxDto | ExpiredInboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxByInboxIdAsync(Guid, int, CancellationToken)
Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
Declaration
public Task<ExpiredInboxDto> GetExpiredInboxByInboxIdAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | inboxId | ID of inbox you want to retrieve (not the inbox ID) |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ExpiredInboxDto> | Task of ExpiredInboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxByInboxIdWithHttpInfo(Guid, int)
Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
Declaration
public ApiResponse<ExpiredInboxDto> GetExpiredInboxByInboxIdWithHttpInfo(Guid inboxId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | inboxId | ID of inbox you want to retrieve (not the inbox ID) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<ExpiredInboxDto> | ApiResponse of ExpiredInboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxByInboxIdWithHttpInfoAsync(Guid, int, CancellationToken)
Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
Declaration
public Task<ApiResponse<ExpiredInboxDto>> GetExpiredInboxByInboxIdWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | inboxId | ID of inbox you want to retrieve (not the inbox ID) |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<ExpiredInboxDto>> | Task of ApiResponse (ExpiredInboxDto) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxes(int?, int?, string, DateTime?, DateTime?, int)
List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
Declaration
public PageExpiredInboxRecordProjection GetExpiredInboxes(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageExpiredInboxRecordProjection | PageExpiredInboxRecordProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxesAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)
List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
Declaration
public Task<PageExpiredInboxRecordProjection> GetExpiredInboxesAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<PageExpiredInboxRecordProjection> | Task of PageExpiredInboxRecordProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxesWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)
List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
Declaration
public ApiResponse<PageExpiredInboxRecordProjection> GetExpiredInboxesWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageExpiredInboxRecordProjection> | ApiResponse of PageExpiredInboxRecordProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxesWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)
List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
Declaration
public Task<ApiResponse<PageExpiredInboxRecordProjection>> GetExpiredInboxesWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<PageExpiredInboxRecordProjection>> | Task of ApiResponse (PageExpiredInboxRecordProjection) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxRecord(Guid, int)
Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
Declaration
public ExpiredInboxDto GetExpiredInboxRecord(Guid expiredId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | expiredId | ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ExpiredInboxDto | ExpiredInboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxRecordAsync(Guid, int, CancellationToken)
Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
Declaration
public Task<ExpiredInboxDto> GetExpiredInboxRecordAsync(Guid expiredId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | expiredId | ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ExpiredInboxDto> | Task of ExpiredInboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxRecordWithHttpInfo(Guid, int)
Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
Declaration
public ApiResponse<ExpiredInboxDto> GetExpiredInboxRecordWithHttpInfo(Guid expiredId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | expiredId | ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<ExpiredInboxDto> | ApiResponse of ExpiredInboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetExpiredInboxRecordWithHttpInfoAsync(Guid, int, CancellationToken)
Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
Declaration
public Task<ApiResponse<ExpiredInboxDto>> GetExpiredInboxRecordWithHttpInfoAsync(Guid expiredId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | expiredId | ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<ExpiredInboxDto>> | Task of ApiResponse (ExpiredInboxDto) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |