All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.mailslurp.apis.EmailControllerApi Maven / Gradle / Ivy

Go to download

Official MailSlurp email API - create real inboxes then send and receive emails and attachments from tests and code.

The newest version!
/*
 * MailSlurp API
 * MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
 *
 * The version of the OpenAPI document: 6.5.2
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package com.mailslurp.apis;

import com.mailslurp.clients.ApiCallback;
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.ApiResponse;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.Pair;
import com.mailslurp.clients.ProgressRequestBody;
import com.mailslurp.clients.ProgressResponseBody;

import com.google.gson.reflect.TypeToken;

import java.io.IOException;


import com.mailslurp.models.AttachmentMetaData;
import com.mailslurp.models.CanSendEmailResults;
import com.mailslurp.models.CheckEmailBodyFeatureSupportResults;
import com.mailslurp.models.CheckEmailBodyResults;
import com.mailslurp.models.CheckEmailClientSupportOptions;
import com.mailslurp.models.CheckEmailClientSupportResults;
import com.mailslurp.models.ContentMatchOptions;
import com.mailslurp.models.CountDto;
import com.mailslurp.models.DownloadAttachmentDto;
import com.mailslurp.models.Email;
import com.mailslurp.models.EmailContentMatchResult;
import com.mailslurp.models.EmailContentPartResult;
import com.mailslurp.models.EmailHtmlDto;
import com.mailslurp.models.EmailLinksResult;
import com.mailslurp.models.EmailPreview;
import com.mailslurp.models.EmailPreviewUrls;
import com.mailslurp.models.EmailScreenshotResult;
import com.mailslurp.models.EmailTextLinesResult;
import com.mailslurp.models.ForwardEmailOptions;
import com.mailslurp.models.GetEmailScreenshotOptions;
import com.mailslurp.models.GravatarUrl;
import com.mailslurp.models.ImapFlagOperationOptions;
import java.time.OffsetDateTime;
import com.mailslurp.models.PageEmailProjection;
import com.mailslurp.models.RawEmailJson;
import com.mailslurp.models.ReplyToEmailOptions;
import com.mailslurp.models.SearchEmailsOptions;
import com.mailslurp.models.SendEmailOptions;
import com.mailslurp.models.SentEmailDto;
import java.util.UUID;
import com.mailslurp.models.UnreadCount;
import com.mailslurp.models.ValidationDto;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class EmailControllerApi {
    private ApiClient localVarApiClient;

    public EmailControllerApi() {
        this(Configuration.getDefaultApiClient());
    }

    public EmailControllerApi(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public ApiClient getApiClient() {
        return localVarApiClient;
    }

    public void setApiClient(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    /**
     * Build call for applyImapFlagOperation
     * @param emailId  (required)
     * @param imapFlagOperationOptions  (required)
     * @param _callback Callback for upload/download progress
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call applyImapFlagOperationCall(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = imapFlagOperationOptions; // create path and map variables String localVarPath = "/emails/{emailId}/imap-flag-operation" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call applyImapFlagOperationValidateBeforeCall(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling applyImapFlagOperation(Async)"); } // verify the required parameter 'imapFlagOperationOptions' is set if (imapFlagOperationOptions == null) { throw new ApiException("Missing the required parameter 'imapFlagOperationOptions' when calling applyImapFlagOperation(Async)"); } okhttp3.Call localVarCall = applyImapFlagOperationCall(emailId, imapFlagOperationOptions, _callback); return localVarCall; } /** * Set IMAP flags associated with a message. Only supports '\\Seen' flag. * Apply RFC3501 section-2.3.2 IMAP flag operations on an email * @param emailId (required) * @param imapFlagOperationOptions (required) * @return EmailPreview * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailPreview applyImapFlagOperation(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions) throws ApiException { ApiResponse localVarResp = applyImapFlagOperationWithHttpInfo(emailId, imapFlagOperationOptions); return localVarResp.getData(); } /** * Set IMAP flags associated with a message. Only supports '\\Seen' flag. * Apply RFC3501 section-2.3.2 IMAP flag operations on an email * @param emailId (required) * @param imapFlagOperationOptions (required) * @return ApiResponse<EmailPreview> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse applyImapFlagOperationWithHttpInfo(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions) throws ApiException { okhttp3.Call localVarCall = applyImapFlagOperationValidateBeforeCall(emailId, imapFlagOperationOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Set IMAP flags associated with a message. Only supports '\\Seen' flag. (asynchronously) * Apply RFC3501 section-2.3.2 IMAP flag operations on an email * @param emailId (required) * @param imapFlagOperationOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call applyImapFlagOperationAsync(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = applyImapFlagOperationValidateBeforeCall(emailId, imapFlagOperationOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for canSend * @param inboxId ID of the inbox you want to send the email from (required) * @param sendEmailOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call canSendCall(UUID inboxId, SendEmailOptions sendEmailOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = sendEmailOptions; // create path and map variables String localVarPath = "/emails/can-send"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxId", inboxId)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call canSendValidateBeforeCall(UUID inboxId, SendEmailOptions sendEmailOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'inboxId' is set if (inboxId == null) { throw new ApiException("Missing the required parameter 'inboxId' when calling canSend(Async)"); } // verify the required parameter 'sendEmailOptions' is set if (sendEmailOptions == null) { throw new ApiException("Missing the required parameter 'sendEmailOptions' when calling canSend(Async)"); } okhttp3.Call localVarCall = canSendCall(inboxId, sendEmailOptions, _callback); return localVarCall; } /** * Check if email can be sent and options are valid. * Can user send email to given recipient or is the recipient blocked * @param inboxId ID of the inbox you want to send the email from (required) * @param sendEmailOptions (required) * @return CanSendEmailResults * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public CanSendEmailResults canSend(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException { ApiResponse localVarResp = canSendWithHttpInfo(inboxId, sendEmailOptions); return localVarResp.getData(); } /** * Check if email can be sent and options are valid. * Can user send email to given recipient or is the recipient blocked * @param inboxId ID of the inbox you want to send the email from (required) * @param sendEmailOptions (required) * @return ApiResponse<CanSendEmailResults> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse canSendWithHttpInfo(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException { okhttp3.Call localVarCall = canSendValidateBeforeCall(inboxId, sendEmailOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Check if email can be sent and options are valid. (asynchronously) * Can user send email to given recipient or is the recipient blocked * @param inboxId ID of the inbox you want to send the email from (required) * @param sendEmailOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call canSendAsync(UUID inboxId, SendEmailOptions sendEmailOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = canSendValidateBeforeCall(inboxId, sendEmailOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for checkEmailBody * @param emailId (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call checkEmailBodyCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/check-email-body" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call checkEmailBodyValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling checkEmailBody(Async)"); } okhttp3.Call localVarCall = checkEmailBodyCall(emailId, _callback); return localVarCall; } /** * Detect broken links, spelling, and images in email content * Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. * @param emailId (required) * @return CheckEmailBodyResults * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public CheckEmailBodyResults checkEmailBody(UUID emailId) throws ApiException { ApiResponse localVarResp = checkEmailBodyWithHttpInfo(emailId); return localVarResp.getData(); } /** * Detect broken links, spelling, and images in email content * Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. * @param emailId (required) * @return ApiResponse<CheckEmailBodyResults> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse checkEmailBodyWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = checkEmailBodyValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Detect broken links, spelling, and images in email content (asynchronously) * Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. * @param emailId (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call checkEmailBodyAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = checkEmailBodyValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for checkEmailBodyFeatureSupport * @param emailId (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call checkEmailBodyFeatureSupportCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/check-email-body-feature-support" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call checkEmailBodyFeatureSupportValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling checkEmailBodyFeatureSupport(Async)"); } okhttp3.Call localVarCall = checkEmailBodyFeatureSupportCall(emailId, _callback); return localVarCall; } /** * Show which mail clients support the HTML and CSS features used in an email body. * Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. * @param emailId (required) * @return CheckEmailBodyFeatureSupportResults * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public CheckEmailBodyFeatureSupportResults checkEmailBodyFeatureSupport(UUID emailId) throws ApiException { ApiResponse localVarResp = checkEmailBodyFeatureSupportWithHttpInfo(emailId); return localVarResp.getData(); } /** * Show which mail clients support the HTML and CSS features used in an email body. * Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. * @param emailId (required) * @return ApiResponse<CheckEmailBodyFeatureSupportResults> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse checkEmailBodyFeatureSupportWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = checkEmailBodyFeatureSupportValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Show which mail clients support the HTML and CSS features used in an email body. (asynchronously) * Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. * @param emailId (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call checkEmailBodyFeatureSupportAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = checkEmailBodyFeatureSupportValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for checkEmailClientSupport * @param checkEmailClientSupportOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call checkEmailClientSupportCall(CheckEmailClientSupportOptions checkEmailClientSupportOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = checkEmailClientSupportOptions; // create path and map variables String localVarPath = "/emails/check-email-client-support"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call checkEmailClientSupportValidateBeforeCall(CheckEmailClientSupportOptions checkEmailClientSupportOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'checkEmailClientSupportOptions' is set if (checkEmailClientSupportOptions == null) { throw new ApiException("Missing the required parameter 'checkEmailClientSupportOptions' when calling checkEmailClientSupport(Async)"); } okhttp3.Call localVarCall = checkEmailClientSupportCall(checkEmailClientSupportOptions, _callback); return localVarCall; } /** * Show which email programs and devices support the features used in an email body. * Evaluate the features used in an email body and return a report of email client support across different platforms and versions. * @param checkEmailClientSupportOptions (required) * @return CheckEmailClientSupportResults * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public CheckEmailClientSupportResults checkEmailClientSupport(CheckEmailClientSupportOptions checkEmailClientSupportOptions) throws ApiException { ApiResponse localVarResp = checkEmailClientSupportWithHttpInfo(checkEmailClientSupportOptions); return localVarResp.getData(); } /** * Show which email programs and devices support the features used in an email body. * Evaluate the features used in an email body and return a report of email client support across different platforms and versions. * @param checkEmailClientSupportOptions (required) * @return ApiResponse<CheckEmailClientSupportResults> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse checkEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions checkEmailClientSupportOptions) throws ApiException { okhttp3.Call localVarCall = checkEmailClientSupportValidateBeforeCall(checkEmailClientSupportOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Show which email programs and devices support the features used in an email body. (asynchronously) * Evaluate the features used in an email body and return a report of email client support across different platforms and versions. * @param checkEmailClientSupportOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call checkEmailClientSupportAsync(CheckEmailClientSupportOptions checkEmailClientSupportOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = checkEmailClientSupportValidateBeforeCall(checkEmailClientSupportOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for deleteAllEmails * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public okhttp3.Call deleteAllEmailsCall(final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call deleteAllEmailsValidateBeforeCall(final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = deleteAllEmailsCall(_callback); return localVarCall; } /** * Delete all emails in all inboxes. * Deletes all emails in your account. Be careful as emails cannot be recovered * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public void deleteAllEmails() throws ApiException { deleteAllEmailsWithHttpInfo(); } /** * Delete all emails in all inboxes. * Deletes all emails in your account. Be careful as emails cannot be recovered * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public ApiResponse deleteAllEmailsWithHttpInfo() throws ApiException { okhttp3.Call localVarCall = deleteAllEmailsValidateBeforeCall(null); return localVarApiClient.execute(localVarCall); } /** * Delete all emails in all inboxes. (asynchronously) * Deletes all emails in your account. Be careful as emails cannot be recovered * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public okhttp3.Call deleteAllEmailsAsync(final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = deleteAllEmailsValidateBeforeCall(_callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for deleteEmail * @param emailId ID of email to delete (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public okhttp3.Call deleteEmailCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call deleteEmailValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling deleteEmail(Async)"); } okhttp3.Call localVarCall = deleteEmailCall(emailId, _callback); return localVarCall; } /** * Delete an email * Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. * @param emailId ID of email to delete (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public void deleteEmail(UUID emailId) throws ApiException { deleteEmailWithHttpInfo(emailId); } /** * Delete an email * Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. * @param emailId ID of email to delete (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public ApiResponse deleteEmailWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = deleteEmailValidateBeforeCall(emailId, null); return localVarApiClient.execute(localVarCall); } /** * Delete an email (asynchronously) * Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. * @param emailId ID of email to delete (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public okhttp3.Call deleteEmailAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = deleteEmailValidateBeforeCall(emailId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for downloadAttachment * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param apiKey Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public okhttp3.Call downloadAttachmentCall(UUID emailId, String attachmentId, String apiKey, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/attachments/{attachmentId}" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())) .replaceAll("\\{" + "attachmentId" + "\\}", localVarApiClient.escapeString(attachmentId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (apiKey != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("apiKey", apiKey)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/octet-stream" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call downloadAttachmentValidateBeforeCall(UUID emailId, String attachmentId, String apiKey, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling downloadAttachment(Async)"); } // verify the required parameter 'attachmentId' is set if (attachmentId == null) { throw new ApiException("Missing the required parameter 'attachmentId' when calling downloadAttachment(Async)"); } okhttp3.Call localVarCall = downloadAttachmentCall(emailId, attachmentId, apiKey, _callback); return localVarCall; } /** * Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. * Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param apiKey Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public byte[] downloadAttachment(UUID emailId, String attachmentId, String apiKey) throws ApiException { ApiResponse localVarResp = downloadAttachmentWithHttpInfo(emailId, attachmentId, apiKey); return localVarResp.getData(); } /** * Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. * Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param apiKey Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public ApiResponse downloadAttachmentWithHttpInfo(UUID emailId, String attachmentId, String apiKey) throws ApiException { okhttp3.Call localVarCall = downloadAttachmentValidateBeforeCall(emailId, attachmentId, apiKey, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. (asynchronously) * Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param apiKey Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public okhttp3.Call downloadAttachmentAsync(UUID emailId, String attachmentId, String apiKey, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = downloadAttachmentValidateBeforeCall(emailId, attachmentId, apiKey, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for downloadAttachmentBase64 * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call downloadAttachmentBase64Call(UUID emailId, String attachmentId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/attachments/{attachmentId}/base64" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())) .replaceAll("\\{" + "attachmentId" + "\\}", localVarApiClient.escapeString(attachmentId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call downloadAttachmentBase64ValidateBeforeCall(UUID emailId, String attachmentId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling downloadAttachmentBase64(Async)"); } // verify the required parameter 'attachmentId' is set if (attachmentId == null) { throw new ApiException("Missing the required parameter 'attachmentId' when calling downloadAttachmentBase64(Async)"); } okhttp3.Call localVarCall = downloadAttachmentBase64Call(emailId, attachmentId, _callback); return localVarCall; } /** * Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. * Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @return DownloadAttachmentDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public DownloadAttachmentDto downloadAttachmentBase64(UUID emailId, String attachmentId) throws ApiException { ApiResponse localVarResp = downloadAttachmentBase64WithHttpInfo(emailId, attachmentId); return localVarResp.getData(); } /** * Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. * Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @return ApiResponse<DownloadAttachmentDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse downloadAttachmentBase64WithHttpInfo(UUID emailId, String attachmentId) throws ApiException { okhttp3.Call localVarCall = downloadAttachmentBase64ValidateBeforeCall(emailId, attachmentId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. (asynchronously) * Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call downloadAttachmentBase64Async(UUID emailId, String attachmentId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = downloadAttachmentBase64ValidateBeforeCall(emailId, attachmentId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for downloadBody * @param emailId ID of email (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call downloadBodyCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/body" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "text/plain", "text/html" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call downloadBodyValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling downloadBody(Async)"); } okhttp3.Call localVarCall = downloadBodyCall(emailId, _callback); return localVarCall; } /** * Get email body as string. Returned as `plain/text` with content type header. * Returns the specified email body for a given email as a string * @param emailId ID of email (required) * @return String * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public String downloadBody(UUID emailId) throws ApiException { ApiResponse localVarResp = downloadBodyWithHttpInfo(emailId); return localVarResp.getData(); } /** * Get email body as string. Returned as `plain/text` with content type header. * Returns the specified email body for a given email as a string * @param emailId ID of email (required) * @return ApiResponse<String> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse downloadBodyWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = downloadBodyValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email body as string. Returned as `plain/text` with content type header. (asynchronously) * Returns the specified email body for a given email as a string * @param emailId ID of email (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call downloadBodyAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = downloadBodyValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for downloadBodyBytes * @param emailId ID of email (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public okhttp3.Call downloadBodyBytesCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/body-bytes" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/octet-stream" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call downloadBodyBytesValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling downloadBodyBytes(Async)"); } okhttp3.Call localVarCall = downloadBodyBytesCall(emailId, _callback); return localVarCall; } /** * Get email body in bytes. Returned as `octet-stream` with content type header. * Returns the specified email body for a given email as a stream / array of bytes. * @param emailId ID of email (required) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public byte[] downloadBodyBytes(UUID emailId) throws ApiException { ApiResponse localVarResp = downloadBodyBytesWithHttpInfo(emailId); return localVarResp.getData(); } /** * Get email body in bytes. Returned as `octet-stream` with content type header. * Returns the specified email body for a given email as a stream / array of bytes. * @param emailId ID of email (required) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public ApiResponse downloadBodyBytesWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = downloadBodyBytesValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email body in bytes. Returned as `octet-stream` with content type header. (asynchronously) * Returns the specified email body for a given email as a stream / array of bytes. * @param emailId ID of email (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
0 default response -
*/ public okhttp3.Call downloadBodyBytesAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = downloadBodyBytesValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for forwardEmail * @param emailId ID of email (required) * @param forwardEmailOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public okhttp3.Call forwardEmailCall(UUID emailId, ForwardEmailOptions forwardEmailOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = forwardEmailOptions; // create path and map variables String localVarPath = "/emails/{emailId}/forward" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call forwardEmailValidateBeforeCall(UUID emailId, ForwardEmailOptions forwardEmailOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling forwardEmail(Async)"); } // verify the required parameter 'forwardEmailOptions' is set if (forwardEmailOptions == null) { throw new ApiException("Missing the required parameter 'forwardEmailOptions' when calling forwardEmail(Async)"); } okhttp3.Call localVarCall = forwardEmailCall(emailId, forwardEmailOptions, _callback); return localVarCall; } /** * Forward email to recipients * Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. * @param emailId ID of email (required) * @param forwardEmailOptions (required) * @return SentEmailDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public SentEmailDto forwardEmail(UUID emailId, ForwardEmailOptions forwardEmailOptions) throws ApiException { ApiResponse localVarResp = forwardEmailWithHttpInfo(emailId, forwardEmailOptions); return localVarResp.getData(); } /** * Forward email to recipients * Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. * @param emailId ID of email (required) * @param forwardEmailOptions (required) * @return ApiResponse<SentEmailDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public ApiResponse forwardEmailWithHttpInfo(UUID emailId, ForwardEmailOptions forwardEmailOptions) throws ApiException { okhttp3.Call localVarCall = forwardEmailValidateBeforeCall(emailId, forwardEmailOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Forward email to recipients (asynchronously) * Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. * @param emailId ID of email (required) * @param forwardEmailOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public okhttp3.Call forwardEmailAsync(UUID emailId, ForwardEmailOptions forwardEmailOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = forwardEmailValidateBeforeCall(emailId, forwardEmailOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getAttachmentMetaData * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getAttachmentMetaDataCall(UUID emailId, String attachmentId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/attachments/{attachmentId}/metadata" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())) .replaceAll("\\{" + "attachmentId" + "\\}", localVarApiClient.escapeString(attachmentId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getAttachmentMetaDataValidateBeforeCall(UUID emailId, String attachmentId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getAttachmentMetaData(Async)"); } // verify the required parameter 'attachmentId' is set if (attachmentId == null) { throw new ApiException("Missing the required parameter 'attachmentId' when calling getAttachmentMetaData(Async)"); } okhttp3.Call localVarCall = getAttachmentMetaDataCall(emailId, attachmentId, _callback); return localVarCall; } /** * Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. * Returns the metadata such as name and content-type for a given attachment and email. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @return AttachmentMetaData * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public AttachmentMetaData getAttachmentMetaData(UUID emailId, String attachmentId) throws ApiException { ApiResponse localVarResp = getAttachmentMetaDataWithHttpInfo(emailId, attachmentId); return localVarResp.getData(); } /** * Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. * Returns the metadata such as name and content-type for a given attachment and email. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @return ApiResponse<AttachmentMetaData> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getAttachmentMetaDataWithHttpInfo(UUID emailId, String attachmentId) throws ApiException { okhttp3.Call localVarCall = getAttachmentMetaDataValidateBeforeCall(emailId, attachmentId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. (asynchronously) * Returns the metadata such as name and content-type for a given attachment and email. * @param emailId ID of email (required) * @param attachmentId ID of attachment (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getAttachmentMetaDataAsync(UUID emailId, String attachmentId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getAttachmentMetaDataValidateBeforeCall(emailId, attachmentId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmail * @param emailId (required) * @param decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailCall(UUID emailId, Boolean decode, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (decode != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("decode", decode)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailValidateBeforeCall(UUID emailId, Boolean decode, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmail(Async)"); } okhttp3.Call localVarCall = getEmailCall(emailId, decode, _callback); return localVarCall; } /** * Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. * Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints * @param emailId (required) * @param decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false) * @return Email * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public Email getEmail(UUID emailId, Boolean decode) throws ApiException { ApiResponse localVarResp = getEmailWithHttpInfo(emailId, decode); return localVarResp.getData(); } /** * Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. * Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints * @param emailId (required) * @param decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false) * @return ApiResponse<Email> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailWithHttpInfo(UUID emailId, Boolean decode) throws ApiException { okhttp3.Call localVarCall = getEmailValidateBeforeCall(emailId, decode, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. (asynchronously) * Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints * @param emailId (required) * @param decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailAsync(UUID emailId, Boolean decode, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailValidateBeforeCall(emailId, decode, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailAttachments * @param emailId ID of email (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailAttachmentsCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/attachments" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailAttachmentsValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailAttachments(Async)"); } okhttp3.Call localVarCall = getEmailAttachmentsCall(emailId, _callback); return localVarCall; } /** * Get all email attachment metadata. Metadata includes name and size of attachments. * Returns an array of attachment metadata such as name and content-type for a given email if present. * @param emailId ID of email (required) * @return List<AttachmentMetaData> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public List getEmailAttachments(UUID emailId) throws ApiException { ApiResponse> localVarResp = getEmailAttachmentsWithHttpInfo(emailId); return localVarResp.getData(); } /** * Get all email attachment metadata. Metadata includes name and size of attachments. * Returns an array of attachment metadata such as name and content-type for a given email if present. * @param emailId ID of email (required) * @return ApiResponse<List<AttachmentMetaData>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse> getEmailAttachmentsWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = getEmailAttachmentsValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get all email attachment metadata. Metadata includes name and size of attachments. (asynchronously) * Returns an array of attachment metadata such as name and content-type for a given email if present. * @param emailId ID of email (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailAttachmentsAsync(UUID emailId, final ApiCallback> _callback) throws ApiException { okhttp3.Call localVarCall = getEmailAttachmentsValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailContentMatch * @param emailId ID of email to match against (required) * @param contentMatchOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailContentMatchCall(UUID emailId, ContentMatchOptions contentMatchOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = contentMatchOptions; // create path and map variables String localVarPath = "/emails/{emailId}/contentMatch" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailContentMatchValidateBeforeCall(UUID emailId, ContentMatchOptions contentMatchOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailContentMatch(Async)"); } // verify the required parameter 'contentMatchOptions' is set if (contentMatchOptions == null) { throw new ApiException("Missing the required parameter 'contentMatchOptions' when calling getEmailContentMatch(Async)"); } okhttp3.Call localVarCall = getEmailContentMatchCall(emailId, contentMatchOptions, _callback); return localVarCall; } /** * Get email content regex pattern match results. Runs regex against email body and returns match groups. * Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. * @param emailId ID of email to match against (required) * @param contentMatchOptions (required) * @return EmailContentMatchResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailContentMatchResult getEmailContentMatch(UUID emailId, ContentMatchOptions contentMatchOptions) throws ApiException { ApiResponse localVarResp = getEmailContentMatchWithHttpInfo(emailId, contentMatchOptions); return localVarResp.getData(); } /** * Get email content regex pattern match results. Runs regex against email body and returns match groups. * Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. * @param emailId ID of email to match against (required) * @param contentMatchOptions (required) * @return ApiResponse<EmailContentMatchResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailContentMatchWithHttpInfo(UUID emailId, ContentMatchOptions contentMatchOptions) throws ApiException { okhttp3.Call localVarCall = getEmailContentMatchValidateBeforeCall(emailId, contentMatchOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email content regex pattern match results. Runs regex against email body and returns match groups. (asynchronously) * Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. * @param emailId ID of email to match against (required) * @param contentMatchOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailContentMatchAsync(UUID emailId, ContentMatchOptions contentMatchOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailContentMatchValidateBeforeCall(emailId, contentMatchOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailContentPart * @param emailId ID of email to match against (required) * @param contentType Content type (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailContentPartCall(UUID emailId, String contentType, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/contentPart" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (contentType != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("contentType", contentType)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailContentPartValidateBeforeCall(UUID emailId, String contentType, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailContentPart(Async)"); } // verify the required parameter 'contentType' is set if (contentType == null) { throw new ApiException("Missing the required parameter 'contentType' when calling getEmailContentPart(Async)"); } okhttp3.Call localVarCall = getEmailContentPartCall(emailId, contentType, _callback); return localVarCall; } /** * Get email content part by content type * Get email body content parts from a multipart email message for a given content type * @param emailId ID of email to match against (required) * @param contentType Content type (required) * @return EmailContentPartResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailContentPartResult getEmailContentPart(UUID emailId, String contentType) throws ApiException { ApiResponse localVarResp = getEmailContentPartWithHttpInfo(emailId, contentType); return localVarResp.getData(); } /** * Get email content part by content type * Get email body content parts from a multipart email message for a given content type * @param emailId ID of email to match against (required) * @param contentType Content type (required) * @return ApiResponse<EmailContentPartResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailContentPartWithHttpInfo(UUID emailId, String contentType) throws ApiException { okhttp3.Call localVarCall = getEmailContentPartValidateBeforeCall(emailId, contentType, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email content part by content type (asynchronously) * Get email body content parts from a multipart email message for a given content type * @param emailId ID of email to match against (required) * @param contentType Content type (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailContentPartAsync(UUID emailId, String contentType, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailContentPartValidateBeforeCall(emailId, contentType, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailCount * @param inboxId (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailCountCall(UUID inboxId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/emails/count"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxId", inboxId)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailCountValidateBeforeCall(UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailCountCall(inboxId, _callback); return localVarCall; } /** * Get email count * * @param inboxId (optional) * @return CountDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public CountDto getEmailCount(UUID inboxId) throws ApiException { ApiResponse localVarResp = getEmailCountWithHttpInfo(inboxId); return localVarResp.getData(); } /** * Get email count * * @param inboxId (optional) * @return ApiResponse<CountDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailCountWithHttpInfo(UUID inboxId) throws ApiException { okhttp3.Call localVarCall = getEmailCountValidateBeforeCall(inboxId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email count (asynchronously) * * @param inboxId (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailCountAsync(UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailCountValidateBeforeCall(inboxId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailHTML * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailHTMLCall(UUID emailId, Boolean decode, Boolean replaceCidImages, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/html" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (decode != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("decode", decode)); } if (replaceCidImages != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("replaceCidImages", replaceCidImages)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "text/html;charset=utf-8", "text/html" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailHTMLValidateBeforeCall(UUID emailId, Boolean decode, Boolean replaceCidImages, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailHTML(Async)"); } okhttp3.Call localVarCall = getEmailHTMLCall(emailId, decode, replaceCidImages, _callback); return localVarCall; } /** * Get email content as HTML. For displaying emails in browser context. * Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @return String * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public String getEmailHTML(UUID emailId, Boolean decode, Boolean replaceCidImages) throws ApiException { ApiResponse localVarResp = getEmailHTMLWithHttpInfo(emailId, decode, replaceCidImages); return localVarResp.getData(); } /** * Get email content as HTML. For displaying emails in browser context. * Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @return ApiResponse<String> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailHTMLWithHttpInfo(UUID emailId, Boolean decode, Boolean replaceCidImages) throws ApiException { okhttp3.Call localVarCall = getEmailHTMLValidateBeforeCall(emailId, decode, replaceCidImages, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email content as HTML. For displaying emails in browser context. (asynchronously) * Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailHTMLAsync(UUID emailId, Boolean decode, Boolean replaceCidImages, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailHTMLValidateBeforeCall(emailId, decode, replaceCidImages, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailHTMLJson * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailHTMLJsonCall(UUID emailId, Boolean decode, Boolean replaceCidImages, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/html/json" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (decode != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("decode", decode)); } if (replaceCidImages != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("replaceCidImages", replaceCidImages)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailHTMLJsonValidateBeforeCall(UUID emailId, Boolean decode, Boolean replaceCidImages, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailHTMLJson(Async)"); } okhttp3.Call localVarCall = getEmailHTMLJsonCall(emailId, decode, replaceCidImages, _callback); return localVarCall; } /** * Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content * Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @return EmailHtmlDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailHtmlDto getEmailHTMLJson(UUID emailId, Boolean decode, Boolean replaceCidImages) throws ApiException { ApiResponse localVarResp = getEmailHTMLJsonWithHttpInfo(emailId, decode, replaceCidImages); return localVarResp.getData(); } /** * Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content * Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @return ApiResponse<EmailHtmlDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailHTMLJsonWithHttpInfo(UUID emailId, Boolean decode, Boolean replaceCidImages) throws ApiException { okhttp3.Call localVarCall = getEmailHTMLJsonValidateBeforeCall(emailId, decode, replaceCidImages, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content (asynchronously) * Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. * @param emailId (required) * @param decode (optional, default to false) * @param replaceCidImages (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailHTMLJsonAsync(UUID emailId, Boolean decode, Boolean replaceCidImages, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailHTMLJsonValidateBeforeCall(emailId, decode, replaceCidImages, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailHTMLQuery * @param emailId ID of email to perform HTML query on (required) * @param htmlSelector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailHTMLQueryCall(UUID emailId, String htmlSelector, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/htmlQuery" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (htmlSelector != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("htmlSelector", htmlSelector)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailHTMLQueryValidateBeforeCall(UUID emailId, String htmlSelector, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailHTMLQuery(Async)"); } // verify the required parameter 'htmlSelector' is set if (htmlSelector == null) { throw new ApiException("Missing the required parameter 'htmlSelector' when calling getEmailHTMLQuery(Async)"); } okhttp3.Call localVarCall = getEmailHTMLQueryCall(emailId, htmlSelector, _callback); return localVarCall; } /** * Parse and return text from an email, stripping HTML and decoding encoded characters * Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors * @param emailId ID of email to perform HTML query on (required) * @param htmlSelector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) * @return EmailTextLinesResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailTextLinesResult getEmailHTMLQuery(UUID emailId, String htmlSelector) throws ApiException { ApiResponse localVarResp = getEmailHTMLQueryWithHttpInfo(emailId, htmlSelector); return localVarResp.getData(); } /** * Parse and return text from an email, stripping HTML and decoding encoded characters * Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors * @param emailId ID of email to perform HTML query on (required) * @param htmlSelector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) * @return ApiResponse<EmailTextLinesResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailHTMLQueryWithHttpInfo(UUID emailId, String htmlSelector) throws ApiException { okhttp3.Call localVarCall = getEmailHTMLQueryValidateBeforeCall(emailId, htmlSelector, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously) * Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors * @param emailId ID of email to perform HTML query on (required) * @param htmlSelector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailHTMLQueryAsync(UUID emailId, String htmlSelector, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailHTMLQueryValidateBeforeCall(emailId, htmlSelector, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailLinks * @param emailId ID of email to fetch text for (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailLinksCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/links" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailLinksValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailLinks(Async)"); } okhttp3.Call localVarCall = getEmailLinksCall(emailId, _callback); return localVarCall; } /** * Parse and return list of links found in an email (only works for HTML content) * HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes * @param emailId ID of email to fetch text for (required) * @return EmailLinksResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailLinksResult getEmailLinks(UUID emailId) throws ApiException { ApiResponse localVarResp = getEmailLinksWithHttpInfo(emailId); return localVarResp.getData(); } /** * Parse and return list of links found in an email (only works for HTML content) * HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes * @param emailId ID of email to fetch text for (required) * @return ApiResponse<EmailLinksResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailLinksWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = getEmailLinksValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Parse and return list of links found in an email (only works for HTML content) (asynchronously) * HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes * @param emailId ID of email to fetch text for (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailLinksAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailLinksValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailPreviewURLs * @param emailId (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailPreviewURLsCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/urls" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailPreviewURLsValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailPreviewURLs(Async)"); } okhttp3.Call localVarCall = getEmailPreviewURLsCall(emailId, _callback); return localVarCall; } /** * Get email URLs for viewing in browser or downloading * Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. * @param emailId (required) * @return EmailPreviewUrls * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailPreviewUrls getEmailPreviewURLs(UUID emailId) throws ApiException { ApiResponse localVarResp = getEmailPreviewURLsWithHttpInfo(emailId); return localVarResp.getData(); } /** * Get email URLs for viewing in browser or downloading * Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. * @param emailId (required) * @return ApiResponse<EmailPreviewUrls> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailPreviewURLsWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = getEmailPreviewURLsValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get email URLs for viewing in browser or downloading (asynchronously) * Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. * @param emailId (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailPreviewURLsAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailPreviewURLsValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailScreenshotAsBase64 * @param emailId (required) * @param getEmailScreenshotOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailScreenshotAsBase64Call(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = getEmailScreenshotOptions; // create path and map variables String localVarPath = "/emails/{emailId}/screenshot/base64" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailScreenshotAsBase64ValidateBeforeCall(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailScreenshotAsBase64(Async)"); } // verify the required parameter 'getEmailScreenshotOptions' is set if (getEmailScreenshotOptions == null) { throw new ApiException("Missing the required parameter 'getEmailScreenshotOptions' when calling getEmailScreenshotAsBase64(Async)"); } okhttp3.Call localVarCall = getEmailScreenshotAsBase64Call(emailId, getEmailScreenshotOptions, _callback); return localVarCall; } /** * Take a screenshot of an email in a browser and return base64 encoded string * Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. * @param emailId (required) * @param getEmailScreenshotOptions (required) * @return EmailScreenshotResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailScreenshotResult getEmailScreenshotAsBase64(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions) throws ApiException { ApiResponse localVarResp = getEmailScreenshotAsBase64WithHttpInfo(emailId, getEmailScreenshotOptions); return localVarResp.getData(); } /** * Take a screenshot of an email in a browser and return base64 encoded string * Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. * @param emailId (required) * @param getEmailScreenshotOptions (required) * @return ApiResponse<EmailScreenshotResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailScreenshotAsBase64WithHttpInfo(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions) throws ApiException { okhttp3.Call localVarCall = getEmailScreenshotAsBase64ValidateBeforeCall(emailId, getEmailScreenshotOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Take a screenshot of an email in a browser and return base64 encoded string (asynchronously) * Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. * @param emailId (required) * @param getEmailScreenshotOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailScreenshotAsBase64Async(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailScreenshotAsBase64ValidateBeforeCall(emailId, getEmailScreenshotOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailScreenshotAsBinary * @param emailId (required) * @param getEmailScreenshotOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailScreenshotAsBinaryCall(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = getEmailScreenshotOptions; // create path and map variables String localVarPath = "/emails/{emailId}/screenshot/binary" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailScreenshotAsBinaryValidateBeforeCall(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailScreenshotAsBinary(Async)"); } // verify the required parameter 'getEmailScreenshotOptions' is set if (getEmailScreenshotOptions == null) { throw new ApiException("Missing the required parameter 'getEmailScreenshotOptions' when calling getEmailScreenshotAsBinary(Async)"); } okhttp3.Call localVarCall = getEmailScreenshotAsBinaryCall(emailId, getEmailScreenshotOptions, _callback); return localVarCall; } /** * Take a screenshot of an email in a browser * Returns binary octet-stream of screenshot of the given email * @param emailId (required) * @param getEmailScreenshotOptions (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public void getEmailScreenshotAsBinary(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions) throws ApiException { getEmailScreenshotAsBinaryWithHttpInfo(emailId, getEmailScreenshotOptions); } /** * Take a screenshot of an email in a browser * Returns binary octet-stream of screenshot of the given email * @param emailId (required) * @param getEmailScreenshotOptions (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailScreenshotAsBinaryWithHttpInfo(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions) throws ApiException { okhttp3.Call localVarCall = getEmailScreenshotAsBinaryValidateBeforeCall(emailId, getEmailScreenshotOptions, null); return localVarApiClient.execute(localVarCall); } /** * Take a screenshot of an email in a browser (asynchronously) * Returns binary octet-stream of screenshot of the given email * @param emailId (required) * @param getEmailScreenshotOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailScreenshotAsBinaryAsync(UUID emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailScreenshotAsBinaryValidateBeforeCall(emailId, getEmailScreenshotOptions, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for getEmailTextLines * @param emailId ID of email to fetch text for (required) * @param decodeHtmlEntities Decode HTML entities (optional) * @param lineSeparator Line separator character (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailTextLinesCall(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/textLines" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (decodeHtmlEntities != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("decodeHtmlEntities", decodeHtmlEntities)); } if (lineSeparator != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("lineSeparator", lineSeparator)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailTextLinesValidateBeforeCall(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getEmailTextLines(Async)"); } okhttp3.Call localVarCall = getEmailTextLinesCall(emailId, decodeHtmlEntities, lineSeparator, _callback); return localVarCall; } /** * Parse and return text from an email, stripping HTML and decoding encoded characters * Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. * @param emailId ID of email to fetch text for (required) * @param decodeHtmlEntities Decode HTML entities (optional) * @param lineSeparator Line separator character (optional) * @return EmailTextLinesResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailTextLinesResult getEmailTextLines(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator) throws ApiException { ApiResponse localVarResp = getEmailTextLinesWithHttpInfo(emailId, decodeHtmlEntities, lineSeparator); return localVarResp.getData(); } /** * Parse and return text from an email, stripping HTML and decoding encoded characters * Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. * @param emailId ID of email to fetch text for (required) * @param decodeHtmlEntities Decode HTML entities (optional) * @param lineSeparator Line separator character (optional) * @return ApiResponse<EmailTextLinesResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailTextLinesWithHttpInfo(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator) throws ApiException { okhttp3.Call localVarCall = getEmailTextLinesValidateBeforeCall(emailId, decodeHtmlEntities, lineSeparator, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously) * Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. * @param emailId ID of email to fetch text for (required) * @param decodeHtmlEntities Decode HTML entities (optional) * @param lineSeparator Line separator character (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailTextLinesAsync(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailTextLinesValidateBeforeCall(emailId, decodeHtmlEntities, lineSeparator, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailsOffsetPaginated * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time (optional) * @param before Optional filter emails received before given date time (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailsOffsetPaginatedCall(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/offset-paginated"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "inboxId", inboxId)); } if (page != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); } if (size != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size)); } if (sort != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort)); } if (unreadOnly != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("unreadOnly", unreadOnly)); } if (searchFilter != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("searchFilter", searchFilter)); } if (since != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since)); } if (before != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailsOffsetPaginatedValidateBeforeCall(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailsOffsetPaginatedCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, _callback); return localVarCall; } /** * Get all emails in all inboxes in paginated form. Email API list all. * By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time (optional) * @param before Optional filter emails received before given date time (optional) * @return PageEmailProjection * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public PageEmailProjection getEmailsOffsetPaginated(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException { ApiResponse localVarResp = getEmailsOffsetPaginatedWithHttpInfo(inboxId, page, size, sort, unreadOnly, searchFilter, since, before); return localVarResp.getData(); } /** * Get all emails in all inboxes in paginated form. Email API list all. * By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time (optional) * @param before Optional filter emails received before given date time (optional) * @return ApiResponse<PageEmailProjection> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailsOffsetPaginatedWithHttpInfo(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException { okhttp3.Call localVarCall = getEmailsOffsetPaginatedValidateBeforeCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get all emails in all inboxes in paginated form. Email API list all. (asynchronously) * By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time (optional) * @param before Optional filter emails received before given date time (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailsOffsetPaginatedAsync(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailsOffsetPaginatedValidateBeforeCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getEmailsPaginated * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailsPaginatedCall(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "inboxId", inboxId)); } if (page != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); } if (size != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size)); } if (sort != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort)); } if (unreadOnly != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("unreadOnly", unreadOnly)); } if (searchFilter != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("searchFilter", searchFilter)); } if (since != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since)); } if (before != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getEmailsPaginatedValidateBeforeCall(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailsPaginatedCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, _callback); return localVarCall; } /** * Get all emails in all inboxes in paginated form. Email API list all. * By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @return PageEmailProjection * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public PageEmailProjection getEmailsPaginated(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException { ApiResponse localVarResp = getEmailsPaginatedWithHttpInfo(inboxId, page, size, sort, unreadOnly, searchFilter, since, before); return localVarResp.getData(); } /** * Get all emails in all inboxes in paginated form. Email API list all. * By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @return ApiResponse<PageEmailProjection> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getEmailsPaginatedWithHttpInfo(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException { okhttp3.Call localVarCall = getEmailsPaginatedValidateBeforeCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get all emails in all inboxes in paginated form. Email API list all. (asynchronously) * By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getEmailsPaginatedAsync(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEmailsPaginatedValidateBeforeCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getGravatarUrlForEmailAddress * @param emailAddress (required) * @param size (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getGravatarUrlForEmailAddressCall(String emailAddress, String size, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/gravatarFor"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (emailAddress != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("emailAddress", emailAddress)); } if (size != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getGravatarUrlForEmailAddressValidateBeforeCall(String emailAddress, String size, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailAddress' is set if (emailAddress == null) { throw new ApiException("Missing the required parameter 'emailAddress' when calling getGravatarUrlForEmailAddress(Async)"); } okhttp3.Call localVarCall = getGravatarUrlForEmailAddressCall(emailAddress, size, _callback); return localVarCall; } /** * * Get gravatar url for email address * @param emailAddress (required) * @param size (optional) * @return GravatarUrl * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public GravatarUrl getGravatarUrlForEmailAddress(String emailAddress, String size) throws ApiException { ApiResponse localVarResp = getGravatarUrlForEmailAddressWithHttpInfo(emailAddress, size); return localVarResp.getData(); } /** * * Get gravatar url for email address * @param emailAddress (required) * @param size (optional) * @return ApiResponse<GravatarUrl> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getGravatarUrlForEmailAddressWithHttpInfo(String emailAddress, String size) throws ApiException { okhttp3.Call localVarCall = getGravatarUrlForEmailAddressValidateBeforeCall(emailAddress, size, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * (asynchronously) * Get gravatar url for email address * @param emailAddress (required) * @param size (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getGravatarUrlForEmailAddressAsync(String emailAddress, String size, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getGravatarUrlForEmailAddressValidateBeforeCall(emailAddress, size, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getLatestEmail * @param inboxIds Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getLatestEmailCall(List inboxIds, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/latest"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxIds != null) { localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "inboxIds", inboxIds)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getLatestEmailValidateBeforeCall(List inboxIds, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLatestEmailCall(inboxIds, _callback); return localVarCall; } /** * Get latest email in all inboxes. Most recently received. * Get the newest email in all inboxes or in a passed set of inbox IDs * @param inboxIds Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional) * @return Email * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public Email getLatestEmail(List inboxIds) throws ApiException { ApiResponse localVarResp = getLatestEmailWithHttpInfo(inboxIds); return localVarResp.getData(); } /** * Get latest email in all inboxes. Most recently received. * Get the newest email in all inboxes or in a passed set of inbox IDs * @param inboxIds Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional) * @return ApiResponse<Email> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getLatestEmailWithHttpInfo(List inboxIds) throws ApiException { okhttp3.Call localVarCall = getLatestEmailValidateBeforeCall(inboxIds, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get latest email in all inboxes. Most recently received. (asynchronously) * Get the newest email in all inboxes or in a passed set of inbox IDs * @param inboxIds Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getLatestEmailAsync(List inboxIds, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLatestEmailValidateBeforeCall(inboxIds, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getLatestEmailInInbox1 * @param inboxId ID of the inbox you want to get the latest email from (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getLatestEmailInInbox1Call(UUID inboxId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/latestIn"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxId", inboxId)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getLatestEmailInInbox1ValidateBeforeCall(UUID inboxId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'inboxId' is set if (inboxId == null) { throw new ApiException("Missing the required parameter 'inboxId' when calling getLatestEmailInInbox1(Async)"); } okhttp3.Call localVarCall = getLatestEmailInInbox1Call(inboxId, _callback); return localVarCall; } /** * Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. * Get the newest email in all inboxes or in a passed set of inbox IDs * @param inboxId ID of the inbox you want to get the latest email from (required) * @return Email * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public Email getLatestEmailInInbox1(UUID inboxId) throws ApiException { ApiResponse localVarResp = getLatestEmailInInbox1WithHttpInfo(inboxId); return localVarResp.getData(); } /** * Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. * Get the newest email in all inboxes or in a passed set of inbox IDs * @param inboxId ID of the inbox you want to get the latest email from (required) * @return ApiResponse<Email> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getLatestEmailInInbox1WithHttpInfo(UUID inboxId) throws ApiException { okhttp3.Call localVarCall = getLatestEmailInInbox1ValidateBeforeCall(inboxId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. (asynchronously) * Get the newest email in all inboxes or in a passed set of inbox IDs * @param inboxId ID of the inbox you want to get the latest email from (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getLatestEmailInInbox1Async(UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLatestEmailInInbox1ValidateBeforeCall(inboxId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getOrganizationEmailsPaginated * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter search filter for emails. (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getOrganizationEmailsPaginatedCall(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/organization"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "inboxId", inboxId)); } if (page != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); } if (size != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size)); } if (sort != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort)); } if (unreadOnly != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("unreadOnly", unreadOnly)); } if (searchFilter != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("searchFilter", searchFilter)); } if (since != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since)); } if (before != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getOrganizationEmailsPaginatedValidateBeforeCall(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getOrganizationEmailsPaginatedCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, _callback); return localVarCall; } /** * Get all organization emails. List team or shared test email accounts * By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter search filter for emails. (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @return PageEmailProjection * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public PageEmailProjection getOrganizationEmailsPaginated(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException { ApiResponse localVarResp = getOrganizationEmailsPaginatedWithHttpInfo(inboxId, page, size, sort, unreadOnly, searchFilter, since, before); return localVarResp.getData(); } /** * Get all organization emails. List team or shared test email accounts * By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter search filter for emails. (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @return ApiResponse<PageEmailProjection> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getOrganizationEmailsPaginatedWithHttpInfo(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException { okhttp3.Call localVarCall = getOrganizationEmailsPaginatedValidateBeforeCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get all organization emails. List team or shared test email accounts (asynchronously) * By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages * @param inboxId Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) * @param page Optional page index in email list pagination (optional, default to 0) * @param size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) * @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC) * @param unreadOnly Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false) * @param searchFilter Optional search filter search filter for emails. (optional) * @param since Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) * @param before Optional filter emails received before given date time (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getOrganizationEmailsPaginatedAsync(List inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getOrganizationEmailsPaginatedValidateBeforeCall(inboxId, page, size, sort, unreadOnly, searchFilter, since, before, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getRawEmailContents * @param emailId ID of email (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getRawEmailContentsCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/raw" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getRawEmailContentsValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getRawEmailContents(Async)"); } okhttp3.Call localVarCall = getRawEmailContentsCall(emailId, _callback); return localVarCall; } /** * Get raw email string. Returns unparsed raw SMTP message with headers and body. * Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint * @param emailId ID of email (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public void getRawEmailContents(UUID emailId) throws ApiException { getRawEmailContentsWithHttpInfo(emailId); } /** * Get raw email string. Returns unparsed raw SMTP message with headers and body. * Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint * @param emailId ID of email (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getRawEmailContentsWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = getRawEmailContentsValidateBeforeCall(emailId, null); return localVarApiClient.execute(localVarCall); } /** * Get raw email string. Returns unparsed raw SMTP message with headers and body. (asynchronously) * Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint * @param emailId ID of email (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getRawEmailContentsAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getRawEmailContentsValidateBeforeCall(emailId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for getRawEmailJson * @param emailId ID of email (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getRawEmailJsonCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/raw/json" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getRawEmailJsonValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling getRawEmailJson(Async)"); } okhttp3.Call localVarCall = getRawEmailJsonCall(emailId, _callback); return localVarCall; } /** * Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. * Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response * @param emailId ID of email (required) * @return RawEmailJson * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public RawEmailJson getRawEmailJson(UUID emailId) throws ApiException { ApiResponse localVarResp = getRawEmailJsonWithHttpInfo(emailId); return localVarResp.getData(); } /** * Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. * Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response * @param emailId ID of email (required) * @return ApiResponse<RawEmailJson> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getRawEmailJsonWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = getRawEmailJsonValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. (asynchronously) * Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response * @param emailId ID of email (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getRawEmailJsonAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getRawEmailJsonValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getUnreadEmailCount * @param inboxId Optional inbox ID filter (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getUnreadEmailCountCall(UUID inboxId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/unreadCount"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxId", inboxId)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call getUnreadEmailCountValidateBeforeCall(UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getUnreadEmailCountCall(inboxId, _callback); return localVarCall; } /** * Get unread email count * Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response * @param inboxId Optional inbox ID filter (optional) * @return UnreadCount * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public UnreadCount getUnreadEmailCount(UUID inboxId) throws ApiException { ApiResponse localVarResp = getUnreadEmailCountWithHttpInfo(inboxId); return localVarResp.getData(); } /** * Get unread email count * Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response * @param inboxId Optional inbox ID filter (optional) * @return ApiResponse<UnreadCount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse getUnreadEmailCountWithHttpInfo(UUID inboxId) throws ApiException { okhttp3.Call localVarCall = getUnreadEmailCountValidateBeforeCall(inboxId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get unread email count (asynchronously) * Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response * @param inboxId Optional inbox ID filter (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call getUnreadEmailCountAsync(UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getUnreadEmailCountValidateBeforeCall(inboxId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for markAllAsRead * @param read What value to assign to email read property. Default true. (optional, default to true) * @param inboxId Optional inbox ID filter (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public okhttp3.Call markAllAsReadCall(Boolean read, UUID inboxId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/read"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (read != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("read", read)); } if (inboxId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxId", inboxId)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call markAllAsReadValidateBeforeCall(Boolean read, UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = markAllAsReadCall(read, inboxId, _callback); return localVarCall; } /** * Mark all emails as read or unread * Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread * @param read What value to assign to email read property. Default true. (optional, default to true) * @param inboxId Optional inbox ID filter (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public void markAllAsRead(Boolean read, UUID inboxId) throws ApiException { markAllAsReadWithHttpInfo(read, inboxId); } /** * Mark all emails as read or unread * Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread * @param read What value to assign to email read property. Default true. (optional, default to true) * @param inboxId Optional inbox ID filter (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public ApiResponse markAllAsReadWithHttpInfo(Boolean read, UUID inboxId) throws ApiException { okhttp3.Call localVarCall = markAllAsReadValidateBeforeCall(read, inboxId, null); return localVarApiClient.execute(localVarCall); } /** * Mark all emails as read or unread (asynchronously) * Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread * @param read What value to assign to email read property. Default true. (optional, default to true) * @param inboxId Optional inbox ID filter (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
204 No Content -
*/ public okhttp3.Call markAllAsReadAsync(Boolean read, UUID inboxId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = markAllAsReadValidateBeforeCall(read, inboxId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for markAsRead * @param emailId (required) * @param read What value to assign to email read property. Default true. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call markAsReadCall(UUID emailId, Boolean read, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/read" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (read != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("read", read)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call markAsReadValidateBeforeCall(UUID emailId, Boolean read, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling markAsRead(Async)"); } okhttp3.Call localVarCall = markAsReadCall(emailId, read, _callback); return localVarCall; } /** * Mark an email as read or unread * Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread * @param emailId (required) * @param read What value to assign to email read property. Default true. (optional, default to true) * @return EmailPreview * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public EmailPreview markAsRead(UUID emailId, Boolean read) throws ApiException { ApiResponse localVarResp = markAsReadWithHttpInfo(emailId, read); return localVarResp.getData(); } /** * Mark an email as read or unread * Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread * @param emailId (required) * @param read What value to assign to email read property. Default true. (optional, default to true) * @return ApiResponse<EmailPreview> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse markAsReadWithHttpInfo(UUID emailId, Boolean read) throws ApiException { okhttp3.Call localVarCall = markAsReadValidateBeforeCall(emailId, read, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Mark an email as read or unread (asynchronously) * Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread * @param emailId (required) * @param read What value to assign to email read property. Default true. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call markAsReadAsync(UUID emailId, Boolean read, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = markAsReadValidateBeforeCall(emailId, read, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for replyToEmail * @param emailId ID of the email that should be replied to (required) * @param replyToEmailOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call replyToEmailCall(UUID emailId, ReplyToEmailOptions replyToEmailOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = replyToEmailOptions; // create path and map variables String localVarPath = "/emails/{emailId}" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call replyToEmailValidateBeforeCall(UUID emailId, ReplyToEmailOptions replyToEmailOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling replyToEmail(Async)"); } // verify the required parameter 'replyToEmailOptions' is set if (replyToEmailOptions == null) { throw new ApiException("Missing the required parameter 'replyToEmailOptions' when calling replyToEmail(Async)"); } okhttp3.Call localVarCall = replyToEmailCall(emailId, replyToEmailOptions, _callback); return localVarCall; } /** * Reply to an email * Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. * @param emailId ID of the email that should be replied to (required) * @param replyToEmailOptions (required) * @return SentEmailDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public SentEmailDto replyToEmail(UUID emailId, ReplyToEmailOptions replyToEmailOptions) throws ApiException { ApiResponse localVarResp = replyToEmailWithHttpInfo(emailId, replyToEmailOptions); return localVarResp.getData(); } /** * Reply to an email * Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. * @param emailId ID of the email that should be replied to (required) * @param replyToEmailOptions (required) * @return ApiResponse<SentEmailDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse replyToEmailWithHttpInfo(UUID emailId, ReplyToEmailOptions replyToEmailOptions) throws ApiException { okhttp3.Call localVarCall = replyToEmailValidateBeforeCall(emailId, replyToEmailOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Reply to an email (asynchronously) * Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. * @param emailId ID of the email that should be replied to (required) * @param replyToEmailOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call replyToEmailAsync(UUID emailId, ReplyToEmailOptions replyToEmailOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = replyToEmailValidateBeforeCall(emailId, replyToEmailOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for searchEmails * @param searchEmailsOptions (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call searchEmailsCall(SearchEmailsOptions searchEmailsOptions, final ApiCallback _callback) throws ApiException { Object localVarPostBody = searchEmailsOptions; // create path and map variables String localVarPath = "/emails/search"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call searchEmailsValidateBeforeCall(SearchEmailsOptions searchEmailsOptions, final ApiCallback _callback) throws ApiException { // verify the required parameter 'searchEmailsOptions' is set if (searchEmailsOptions == null) { throw new ApiException("Missing the required parameter 'searchEmailsOptions' when calling searchEmails(Async)"); } okhttp3.Call localVarCall = searchEmailsCall(searchEmailsOptions, _callback); return localVarCall; } /** * Get all emails by search criteria. Return in paginated form. * Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body * @param searchEmailsOptions (required) * @return PageEmailProjection * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public PageEmailProjection searchEmails(SearchEmailsOptions searchEmailsOptions) throws ApiException { ApiResponse localVarResp = searchEmailsWithHttpInfo(searchEmailsOptions); return localVarResp.getData(); } /** * Get all emails by search criteria. Return in paginated form. * Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body * @param searchEmailsOptions (required) * @return ApiResponse<PageEmailProjection> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public ApiResponse searchEmailsWithHttpInfo(SearchEmailsOptions searchEmailsOptions) throws ApiException { okhttp3.Call localVarCall = searchEmailsValidateBeforeCall(searchEmailsOptions, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get all emails by search criteria. Return in paginated form. (asynchronously) * Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body * @param searchEmailsOptions (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 OK -
*/ public okhttp3.Call searchEmailsAsync(SearchEmailsOptions searchEmailsOptions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = searchEmailsValidateBeforeCall(searchEmailsOptions, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for sendEmailSourceOptional * @param sendEmailOptions (required) * @param inboxId ID of the inbox you want to send the email from (optional) * @param useDomainPool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) * @param virtualSend Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public okhttp3.Call sendEmailSourceOptionalCall(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend, final ApiCallback _callback) throws ApiException { Object localVarPostBody = sendEmailOptions; // create path and map variables String localVarPath = "/emails"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); if (inboxId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxId", inboxId)); } if (useDomainPool != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("useDomainPool", useDomainPool)); } if (virtualSend != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("virtualSend", virtualSend)); } Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call sendEmailSourceOptionalValidateBeforeCall(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend, final ApiCallback _callback) throws ApiException { // verify the required parameter 'sendEmailOptions' is set if (sendEmailOptions == null) { throw new ApiException("Missing the required parameter 'sendEmailOptions' when calling sendEmailSourceOptional(Async)"); } okhttp3.Call localVarCall = sendEmailSourceOptionalCall(sendEmailOptions, inboxId, useDomainPool, virtualSend, _callback); return localVarCall; } /** * Send email * Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. * @param sendEmailOptions (required) * @param inboxId ID of the inbox you want to send the email from (optional) * @param useDomainPool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) * @param virtualSend Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public void sendEmailSourceOptional(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend) throws ApiException { sendEmailSourceOptionalWithHttpInfo(sendEmailOptions, inboxId, useDomainPool, virtualSend); } /** * Send email * Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. * @param sendEmailOptions (required) * @param inboxId ID of the inbox you want to send the email from (optional) * @param useDomainPool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) * @param virtualSend Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public ApiResponse sendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend) throws ApiException { okhttp3.Call localVarCall = sendEmailSourceOptionalValidateBeforeCall(sendEmailOptions, inboxId, useDomainPool, virtualSend, null); return localVarApiClient.execute(localVarCall); } /** * Send email (asynchronously) * Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. * @param sendEmailOptions (required) * @param inboxId ID of the inbox you want to send the email from (optional) * @param useDomainPool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) * @param virtualSend Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public okhttp3.Call sendEmailSourceOptionalAsync(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = sendEmailSourceOptionalValidateBeforeCall(sendEmailOptions, inboxId, useDomainPool, virtualSend, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for validateEmail * @param emailId ID of email (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public okhttp3.Call validateEmailCall(UUID emailId, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/emails/{emailId}/validate" .replaceAll("\\{" + "emailId" + "\\}", localVarApiClient.escapeString(emailId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "API_KEY" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call validateEmailValidateBeforeCall(UUID emailId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailId' is set if (emailId == null) { throw new ApiException("Missing the required parameter 'emailId' when calling validateEmail(Async)"); } okhttp3.Call localVarCall = validateEmailCall(emailId, _callback); return localVarCall; } /** * Validate email HTML contents * Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. * @param emailId ID of email (required) * @return ValidationDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public ValidationDto validateEmail(UUID emailId) throws ApiException { ApiResponse localVarResp = validateEmailWithHttpInfo(emailId); return localVarResp.getData(); } /** * Validate email HTML contents * Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. * @param emailId ID of email (required) * @return ApiResponse<ValidationDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public ApiResponse validateEmailWithHttpInfo(UUID emailId) throws ApiException { okhttp3.Call localVarCall = validateEmailValidateBeforeCall(emailId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Validate email HTML contents (asynchronously) * Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. * @param emailId ID of email (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
201 Created -
*/ public okhttp3.Call validateEmailAsync(UUID emailId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = validateEmailValidateBeforeCall(emailId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy