mailslurp_netstandard_2x.Api.InboxForwarderControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
CreateNewInboxForwarderPOST /forwardersCreate an inbox forwarder
DeleteInboxForwarderDELETE /forwarders/{id}Delete an inbox forwarder
DeleteInboxForwardersDELETE /forwardersDelete inbox forwarders
GetInboxForwarderGET /forwarders/{id}Get an inbox forwarder
GetInboxForwardersGET /forwardersList inbox forwarders
TestInboxForwarderPOST /forwarders/{id}/testTest an inbox forwarder
TestInboxForwardersForInboxPUT /forwardersTest inbox forwarders for inbox
TestNewInboxForwarderPATCH /forwardersTest new inbox forwarder

CreateNewInboxForwarder

InboxForwarderDto CreateNewInboxForwarder (CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null)

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_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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 createInboxForwarderOptions = new CreateInboxForwarderOptions(); // CreateInboxForwarderOptions | createInboxForwarderOptions
            var inboxId = new Guid?(); // Guid? | Inbox id to attach forwarder to (optional) 

            try
            {
                // Create an inbox forwarder
                InboxForwarderDto result = apiInstance.CreateNewInboxForwarder(createInboxForwarderOptions, inboxId);
                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

NameTypeDescriptionNotes
createInboxForwarderOptionsCreateInboxForwarderOptionscreateInboxForwarderOptions
inboxIdGuid?Inbox id to attach forwarder to[optional]

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DeleteInboxForwarder

void DeleteInboxForwarder (Guid id)

Delete an inbox forwarder

Delete inbox forwarder

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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

NameTypeDescriptionNotes
idGuidID of inbox forwarder

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status codeDescriptionResponse headers
204No Content-
401Unauthorized-
403Forbidden-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DeleteInboxForwarders

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_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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

NameTypeDescriptionNotes
inboxIdGuid?Optional inbox id to attach forwarder to[optional]

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status codeDescriptionResponse headers
204No Content-
401Unauthorized-
403Forbidden-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetInboxForwarder

InboxForwarderDto GetInboxForwarder (Guid id)

Get an inbox forwarder

Get inbox ruleset

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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

NameTypeDescriptionNotes
idGuidID of inbox forwarder

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetInboxForwarders

PageInboxForwarderDto GetInboxForwarders (Guid? inboxId = null, int? page = null, string searchFilter = null, int? size = null, string sort = null)

List inbox forwarders

List all forwarders attached to an inbox

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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 searchFilter = searchFilter_example;  // string | Optional search filter (optional) 
            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)

            try
            {
                // List inbox forwarders
                PageInboxForwarderDto result = apiInstance.GetInboxForwarders(inboxId, page, searchFilter, size, sort);
                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

NameTypeDescriptionNotes
inboxIdGuid?Optional inbox id to get forwarders from[optional]
pageint?Optional page in inbox forwarder list pagination[optional] [default to 0]
searchFilterstringOptional search filter[optional]
sizeint?Optional page size in inbox forwarder list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ASC]

Return type

PageInboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

TestInboxForwarder

InboxForwarderTestResult TestInboxForwarder (Guid id, InboxForwarderTestOptions inboxForwarderTestOptions)

Test an inbox forwarder

Test an inbox forwarder

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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 | 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

NameTypeDescriptionNotes
idGuidID of inbox forwarder
inboxForwarderTestOptionsInboxForwarderTestOptionsinboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

TestInboxForwardersForInbox

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_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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 | 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

NameTypeDescriptionNotes
inboxIdGuidID of inbox
inboxForwarderTestOptionsInboxForwarderTestOptionsinboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

TestNewInboxForwarder

InboxForwarderTestResult TestNewInboxForwarder (TestNewInboxForwarderOptions testNewInboxForwarderOptions)

Test new inbox forwarder

Test new inbox forwarder

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.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 | 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

NameTypeDescriptionNotes
testNewInboxForwarderOptionsTestNewInboxForwarderOptionstestNewInboxForwarderOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
204No Content-
401Unauthorized-
403Forbidden-

[Back to top] [Back to API list] [Back to Model list] [Back to ]