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(before, inboxId, page, searchFilter, since, size, sort)

Get all MissedEmails in paginated format

Example

// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.MissedEmailControllerApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mailslurp.com");
    
    // Configure API key authorization: API_KEY
    ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
    API_KEY.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //API_KEY.setApiKeyPrefix("Token");

    MissedEmailControllerApi apiInstance = new MissedEmailControllerApi(defaultClient);
    OffsetDateTime before = new OffsetDateTime(); // OffsetDateTime | Filter by created at before the given timestamp
    UUID inboxId = new UUID(); // UUID | Optional inbox ID filter
    Integer page = 0; // Integer | Optional page  in list pagination
    String searchFilter = "searchFilter_example"; // String | Optional search filter
    OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Filter by created at after the given timestamp
    Integer size = 20; // Integer | Optional page size in list pagination
    String sort = "ASC"; // String | Optional createdAt sort direction ASC or DESC
    try {
      PageMissedEmailProjection result = apiInstance.getAllMissedEmails(before, inboxId, page, searchFilter, since, size, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MissedEmailControllerApi#getAllMissedEmails");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
beforeOffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdUUIDOptional inbox ID filter[optional]
pageIntegerOptional page in list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceOffsetDateTimeFilter by created at after the given timestamp[optional]
sizeIntegerOptional page size in list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

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-

getAllUnknownMissedEmails

PageUnknownMissedEmailProjection getAllUnknownMissedEmails(before, inboxId, page, searchFilter, since, size, sort)

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

// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.MissedEmailControllerApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mailslurp.com");
    
    // Configure API key authorization: API_KEY
    ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
    API_KEY.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //API_KEY.setApiKeyPrefix("Token");

    MissedEmailControllerApi apiInstance = new MissedEmailControllerApi(defaultClient);
    OffsetDateTime before = new OffsetDateTime(); // OffsetDateTime | Filter by created at before the given timestamp
    UUID inboxId = new UUID(); // UUID | Optional inbox ID filter
    Integer page = 0; // Integer | Optional page  in list pagination
    String searchFilter = "searchFilter_example"; // String | Optional search filter
    OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Filter by created at after the given timestamp
    Integer size = 20; // Integer | Optional page size in list pagination
    String sort = "ASC"; // String | Optional createdAt sort direction ASC or DESC
    try {
      PageUnknownMissedEmailProjection result = apiInstance.getAllUnknownMissedEmails(before, inboxId, page, searchFilter, since, size, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MissedEmailControllerApi#getAllUnknownMissedEmails");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
beforeOffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdUUIDOptional inbox ID filter[optional]
pageIntegerOptional page in list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceOffsetDateTimeFilter by created at after the given timestamp[optional]
sizeIntegerOptional page size in list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

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-

getMissedEmail

MissedEmail getMissedEmail(missedEmailId)

Get MissedEmail

Example

// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.MissedEmailControllerApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mailslurp.com");
    
    // Configure API key authorization: API_KEY
    ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
    API_KEY.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //API_KEY.setApiKeyPrefix("Token");

    MissedEmailControllerApi apiInstance = new MissedEmailControllerApi(defaultClient);
    UUID missedEmailId = new UUID(); // UUID | missedEmailId
    try {
      MissedEmail result = apiInstance.getMissedEmail(missedEmailId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MissedEmailControllerApi#getMissedEmail");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
missedEmailIdUUIDmissedEmailId

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-

waitForNthMissedEmail

MissedEmail waitForNthMissedEmail(before, inboxId, , since, timeout)

Wait for Nth missed email

Wait for 0 based missed email

Example

// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.MissedEmailControllerApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mailslurp.com");
    
    // Configure API key authorization: API_KEY
    ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
    API_KEY.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //API_KEY.setApiKeyPrefix("Token");

    MissedEmailControllerApi apiInstance = new MissedEmailControllerApi(defaultClient);
    OffsetDateTime before = new OffsetDateTime(); // OffsetDateTime | Filter by created at before the given timestamp
    UUID inboxId = new UUID(); // UUID | Optional inbox ID filter
    Integer  = 56; // Integer | Zero based  of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
    OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Filter by created at after the given timestamp
    Long timeout = 56L; // Long | Optional timeout milliseconds
    try {
      MissedEmail result = apiInstance.waitForNthMissedEmail(before, inboxId, , since, timeout);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MissedEmailControllerApi#waitForNthMissedEmail");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
beforeOffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdUUIDOptional inbox ID filter[optional]
****IntegerZero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1[optional]
sinceOffsetDateTimeFilter by created at after the given timestamp[optional]
timeoutLongOptional 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-