Interface IExpiredControllerApiAsync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IExpiredControllerApiAsync : IApiAccessorMethods
View SourceGetExpirationDefaultsAsync(int, CancellationToken)
Get default expiration settings
Declaration
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 |
Remarks
Return default times used for inbox expiration
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpirationDefaultsWithHttpInfoAsync(int, CancellationToken)
Get default expiration settings
Declaration
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) |
Remarks
Return default times used for inbox expiration
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpiredInboxByInboxIdAsync(Guid, int, CancellationToken)
Get expired inbox record for a previously existing inbox
Declaration
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 |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpiredInboxByInboxIdWithHttpInfoAsync(Guid, int, CancellationToken)
Get expired inbox record for a previously existing inbox
Declaration
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) |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpiredInboxesAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)
List records of expired inboxes
Declaration
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 |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpiredInboxesWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)
List records of expired inboxes
Declaration
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) |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpiredInboxRecordAsync(Guid, int, CancellationToken)
Get an expired inbox record
Declaration
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 |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetExpiredInboxRecordWithHttpInfoAsync(Guid, int, CancellationToken)
Get an expired inbox record
Declaration
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) |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |