mailslurp.Api.MissedEmailControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
GetAllMissedEmails | GET /missed-emails | Get all MissedEmails in paginated format |
GetAllUnknownMissedEmails | GET /missed-emails/unknown | Get all unknown missed emails in paginated format |
GetMissedEmail | GET /missed-emails/{missedEmailId} | Get MissedEmail |
WaitForNthMissedEmail | GET /missed-emails/waitForNthMissedEmail | Wait for Nth missed email |
PageMissedEmailProjection GetAllMissedEmails (int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null)
Get all MissedEmails in paginated format
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.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 page = 56; // int? | Optional page in list pagination (optional) (default to 0)
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)
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)
var inboxId = new Guid?(); // Guid? | Optional inbox ID filter (optional)
try
{
// Get all MissedEmails in paginated format
PageMissedEmailProjection result = apiInstance.GetAllMissedEmails(page, size, sort, searchFilter, since, before, inboxId);
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
Name | Type | Description | Notes |
---|---|---|---|
page | int? | Optional page in list pagination | [optional] [default to 0] |
size | int? | Optional page size in 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] |
inboxId | Guid? | Optional inbox ID filter | [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 ]
PageUnknownMissedEmailProjection GetAllUnknownMissedEmails (int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = 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.Api;
using mailslurp.Client;
using mailslurp.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 page = 56; // int? | Optional page in list pagination (optional) (default to 0)
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)
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)
var inboxId = new Guid?(); // Guid? | Optional inbox ID filter (optional)
try
{
// Get all unknown missed emails in paginated format
PageUnknownMissedEmailProjection result = apiInstance.GetAllUnknownMissedEmails(page, size, sort, searchFilter, since, before, inboxId);
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
Name | Type | Description | Notes |
---|---|---|---|
page | int? | Optional page in list pagination | [optional] [default to 0] |
size | int? | Optional page size in 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] |
inboxId | Guid? | Optional inbox ID filter | [optional] |
Return type
PageUnknownMissedEmailProjection
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 ]
MissedEmail GetMissedEmail (Guid missedEmailId)
Get MissedEmail
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.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 |
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
Name | Type | Description | Notes |
---|---|---|---|
missedEmailId | Guid |
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 ]
MissedEmail WaitForNthMissedEmail (int , Guid? inboxId = null, long? timeout = null, DateTime? since = null, DateTime? before = null)
Wait for Nth missed email
Wait for 0 based missed email
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.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 = 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
var inboxId = new Guid?(); // Guid? | Optional inbox ID filter (optional)
var timeout = 789; // long? | Optional timeout milliseconds (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
{
// Wait for Nth missed email
MissedEmail result = apiInstance.WaitForNthMissedEmail(, inboxId, timeout, since, before);
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
Name | Type | Description | Notes |
---|---|---|---|
**** | 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 | |
inboxId | Guid? | Optional inbox ID filter | [optional] |
timeout | long? | Optional timeout milliseconds | [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 ]