mailslurp.Api.InboxForwarderControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
CreateNewInboxForwarder | POST /forwarders | Create an inbox forwarder |
DeleteInboxForwarder | DELETE /forwarders/{id} | Delete an inbox forwarder |
DeleteInboxForwarders | DELETE /forwarders | Delete inbox forwarders |
GetInboxForwarder | GET /forwarders/{id} | Get an inbox forwarder |
GetInboxForwarders | GET /forwarders | List inbox forwarders |
TestInboxForwarder | POST /forwarders/{id}/test | Test an inbox forwarder |
TestInboxForwardersForInbox | PUT /forwarders | Test inbox forwarders for inbox |
TestNewInboxForwarder | PATCH /forwarders | Test new inbox forwarder |
InboxForwarderDto CreateNewInboxForwarder (Guid inboxId, CreateInboxForwarderOptions createInboxForwarderOptions)
Create an inbox forwarder
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class CreateNewInboxForwarderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var inboxId = new Guid(); // Guid | Inbox id to attach forwarder to
var createInboxForwarderOptions = new CreateInboxForwarderOptions(); // CreateInboxForwarderOptions |
try
{
// Create an inbox forwarder
InboxForwarderDto result = apiInstance.CreateNewInboxForwarder(inboxId, createInboxForwarderOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.CreateNewInboxForwarder: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | Guid | Inbox id to attach forwarder to | |
createInboxForwarderOptions | CreateInboxForwarderOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void DeleteInboxForwarder (Guid id)
Delete an inbox forwarder
Delete inbox forwarder
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DeleteInboxForwarderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var id = new Guid(); // Guid | ID of inbox forwarder
try
{
// Delete an inbox forwarder
apiInstance.DeleteInboxForwarder(id);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.DeleteInboxForwarder: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid | ID of inbox forwarder |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void DeleteInboxForwarders (Guid? inboxId = null)
Delete inbox forwarders
Delete inbox forwarders. Accepts optional inboxId filter.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DeleteInboxForwardersExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var inboxId = new Guid?(); // Guid? | Optional inbox id to attach forwarder to (optional)
try
{
// Delete inbox forwarders
apiInstance.DeleteInboxForwarders(inboxId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.DeleteInboxForwarders: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | Guid? | Optional inbox id to attach forwarder to | [optional] |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
InboxForwarderDto GetInboxForwarder (Guid id)
Get an inbox forwarder
Get inbox ruleset
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetInboxForwarderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var id = new Guid(); // Guid | ID of inbox forwarder
try
{
// Get an inbox forwarder
InboxForwarderDto result = apiInstance.GetInboxForwarder(id);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.GetInboxForwarder: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid | ID of inbox forwarder |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageInboxForwarderDto GetInboxForwarders (Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null)
List inbox forwarders
List all forwarders attached to an inbox
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetInboxForwardersExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var inboxId = new Guid?(); // Guid? | Optional inbox id to get forwarders from (optional)
var page = 56; // int? | Optional page in inbox forwarder list pagination (optional) (default to 0)
var size = 56; // int? | Optional page size in inbox forwarder list pagination (optional) (default to 20)
var sort = sort_example; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var searchFilter = searchFilter_example; // string | Optional search filter (optional)
var since = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at after the given timestamp (optional)
var before = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at before the given timestamp (optional)
try
{
// List inbox forwarders
PageInboxForwarderDto result = apiInstance.GetInboxForwarders(inboxId, page, size, sort, searchFilter, since, before);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.GetInboxForwarders: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | Guid? | Optional inbox id to get forwarders from | [optional] |
page | int? | Optional page in inbox forwarder list pagination | [optional] [default to 0] |
size | int? | Optional page size in inbox forwarder list pagination | [optional] [default to 20] |
sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] |
searchFilter | string | Optional search filter | [optional] |
since | DateTime? | Filter by created at after the given timestamp | [optional] |
before | DateTime? | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
InboxForwarderTestResult TestInboxForwarder (Guid id, InboxForwarderTestOptions inboxForwarderTestOptions)
Test an inbox forwarder
Test an inbox forwarder
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class TestInboxForwarderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var id = new Guid(); // Guid | ID of inbox forwarder
var inboxForwarderTestOptions = new InboxForwarderTestOptions(); // InboxForwarderTestOptions |
try
{
// Test an inbox forwarder
InboxForwarderTestResult result = apiInstance.TestInboxForwarder(id, inboxForwarderTestOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.TestInboxForwarder: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid | ID of inbox forwarder | |
inboxForwarderTestOptions | InboxForwarderTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
InboxForwarderTestResult TestInboxForwardersForInbox (Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions)
Test inbox forwarders for inbox
Test inbox forwarders for inbox
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class TestInboxForwardersForInboxExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var inboxId = new Guid(); // Guid | ID of inbox
var inboxForwarderTestOptions = new InboxForwarderTestOptions(); // InboxForwarderTestOptions |
try
{
// Test inbox forwarders for inbox
InboxForwarderTestResult result = apiInstance.TestInboxForwardersForInbox(inboxId, inboxForwarderTestOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.TestInboxForwardersForInbox: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | Guid | ID of inbox | |
inboxForwarderTestOptions | InboxForwarderTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
InboxForwarderTestResult TestNewInboxForwarder (TestNewInboxForwarderOptions testNewInboxForwarderOptions)
Test new inbox forwarder
Test new inbox forwarder
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class TestNewInboxForwarderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new InboxForwarderControllerApi(config);
var testNewInboxForwarderOptions = new TestNewInboxForwarderOptions(); // TestNewInboxForwarderOptions |
try
{
// Test new inbox forwarder
InboxForwarderTestResult result = apiInstance.TestNewInboxForwarder(testNewInboxForwarderOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling InboxForwarderControllerApi.TestNewInboxForwarder: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
testNewInboxForwarderOptions | TestNewInboxForwarderOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]