mailslurp_netstandard_2x.Api.MissedEmailControllerApi

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

MethodHTTP requestDescription
GetAllMissedEmailsGET /missed-emailsGet all MissedEmails in paginated format
GetAllUnknownMissedEmailsGET /missed-emails/unknownGet all unknown missed emails in paginated format
GetMissedEmailGET /missed-emails/{missedEmailId}Get MissedEmail
WaitForNthMissedEmailGET /missed-emails/waitForNthMissedEmailWait for Nth missed email

GetAllMissedEmails

PageMissedEmailProjection GetAllMissedEmails (DateTime? before = null, Guid? inboxId = null, int? page = null, string searchFilter = null, DateTime? since = null, int? size = null, string sort = null)

Get all MissedEmails in paginated format

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 GetAllMissedEmailsExample
    {
        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 MissedEmailControllerApi(config);
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter by created at before the given timestamp (optional) 
            var inboxId = new Guid?(); // Guid? | Optional inbox ID filter (optional) 
            var page = 56;  // int? | Optional page  in list pagination (optional)  (default to 0)
            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 size = 56;  // int? | Optional page size in list pagination (optional)  (default to 20)
            var sort = sort_example;  // string | Optional createdAt sort direction ASC or DESC (optional)  (default to ASC)

            try
            {
                // Get all MissedEmails in paginated format
                PageMissedEmailProjection result = apiInstance.GetAllMissedEmails(before, inboxId, page, searchFilter, since, size, sort);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MissedEmailControllerApi.GetAllMissedEmails: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
beforeDateTime?Filter by created at before the given timestamp[optional]
inboxIdGuid?Optional inbox ID filter[optional]
pageint?Optional page in list pagination[optional] [default to 0]
searchFilterstringOptional search filter[optional]
sinceDateTime?Filter by created at after the given timestamp[optional]
sizeint?Optional page size in list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ASC]

Return type

PageMissedEmailProjection

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 ]

GetAllUnknownMissedEmails

PageUnknownMissedEmailProjection GetAllUnknownMissedEmails (DateTime? before = null, Guid? inboxId = null, int? page = null, string searchFilter = null, DateTime? since = null, int? size = null, string sort = null)

Get all unknown missed emails in paginated format

Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing 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 GetAllUnknownMissedEmailsExample
    {
        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 MissedEmailControllerApi(config);
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter by created at before the given timestamp (optional) 
            var inboxId = new Guid?(); // Guid? | Optional inbox ID filter (optional) 
            var page = 56;  // int? | Optional page  in list pagination (optional)  (default to 0)
            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 size = 56;  // int? | Optional page size in list pagination (optional)  (default to 20)
            var sort = sort_example;  // string | Optional createdAt sort direction ASC or DESC (optional)  (default to ASC)

            try
            {
                // Get all unknown missed emails in paginated format
                PageUnknownMissedEmailProjection result = apiInstance.GetAllUnknownMissedEmails(before, inboxId, page, searchFilter, since, size, sort);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MissedEmailControllerApi.GetAllUnknownMissedEmails: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
beforeDateTime?Filter by created at before the given timestamp[optional]
inboxIdGuid?Optional inbox ID filter[optional]
pageint?Optional page in list pagination[optional] [default to 0]
searchFilterstringOptional search filter[optional]
sinceDateTime?Filter by created at after the given timestamp[optional]
sizeint?Optional page size in list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ASC]

Return type

PageUnknownMissedEmailProjection

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 ]

GetMissedEmail

MissedEmail GetMissedEmail (Guid missedEmailId)

Get MissedEmail

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 GetMissedEmailExample
    {
        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 MissedEmailControllerApi(config);
            var missedEmailId = new Guid(); // Guid | missedEmailId

            try
            {
                // Get MissedEmail
                MissedEmail result = apiInstance.GetMissedEmail(missedEmailId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MissedEmailControllerApi.GetMissedEmail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
missedEmailIdGuidmissedEmailId

Return type

MissedEmail

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 ]

WaitForNthMissedEmail

MissedEmail WaitForNthMissedEmail (DateTime? before = null, Guid? inboxId = null, int? = null, DateTime? since = null, long? timeout = null)

Wait for Nth missed email

Wait for 0 based missed email

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 WaitForNthMissedEmailExample
    {
        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 MissedEmailControllerApi(config);
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter by created at before the given timestamp (optional) 
            var inboxId = new Guid?(); // Guid? | Optional inbox ID filter (optional) 
            var  = 56;  // int? | Zero based  of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1 (optional) 
            var since = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter by created at after the given timestamp (optional) 
            var timeout = 789;  // long? | Optional timeout milliseconds (optional) 

            try
            {
                // Wait for Nth missed email
                MissedEmail result = apiInstance.WaitForNthMissedEmail(before, inboxId, , since, timeout);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MissedEmailControllerApi.WaitForNthMissedEmail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
beforeDateTime?Filter by created at before the given timestamp[optional]
inboxIdGuid?Optional inbox ID filter[optional]
****int?Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1[optional]
sinceDateTime?Filter by created at after the given timestamp[optional]
timeoutlong?Optional timeout milliseconds[optional]

Return type

MissedEmail

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 ]