Interface IOAuthConnectionApiAsync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IOAuthConnectionApiAsync : IApiAccessor
Methods
View SourceCreateOAuthConnectionAsync(string, string, string, int, CancellationToken)
Create an OAuth connection
Declaration
Task<CreateOAuthConnectionResult> CreateOAuthConnectionAsync(string redirectBase, string oAuthConnectionType, string emailAddress = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | redirectBase | |
string | oAuthConnectionType | |
string | emailAddress | (optional) |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<CreateOAuthConnectionResult> | Task of CreateOAuthConnectionResult |
Remarks
Configure an inbox for OAuth sync with MailSlurp
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateOAuthConnectionWithHttpInfoAsync(string, string, string, int, CancellationToken)
Create an OAuth connection
Declaration
Task<ApiResponse<CreateOAuthConnectionResult>> CreateOAuthConnectionWithHttpInfoAsync(string redirectBase, string oAuthConnectionType, string emailAddress = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | redirectBase | |
string | oAuthConnectionType | |
string | emailAddress | (optional) |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<CreateOAuthConnectionResult>> | Task of ApiResponse (CreateOAuthConnectionResult) |
Remarks
Configure an inbox for OAuth sync with MailSlurp
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ExchangeAuthorizationTokenAndCreateOrUpdateInboxAsync(string, string, int, CancellationToken)
Exchange authorization code for access token and create inbox
Declaration
Task<CreateOAuthExchangeResult> ExchangeAuthorizationTokenAndCreateOrUpdateInboxAsync(string authorizationCode, string redirectUri, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | authorizationCode | |
string | redirectUri | |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<CreateOAuthExchangeResult> | Task of CreateOAuthExchangeResult |
Remarks
Exchange an OAuth code for an access token and create an inbox connection in MailSlurp
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ExchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfoAsync(string, string, int, CancellationToken)
Exchange authorization code for access token and create inbox
Declaration
Task<ApiResponse<CreateOAuthExchangeResult>> ExchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfoAsync(string authorizationCode, string redirectUri, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | authorizationCode | |
string | redirectUri | |
int | operationIndex | Index associated with the operation. |
CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<CreateOAuthExchangeResult>> | Task of ApiResponse (CreateOAuthExchangeResult) |
Remarks
Exchange an OAuth code for an access token and create an inbox connection in MailSlurp
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |