mimepost

MimePost API Reference (Beta)

• API version: 0.1.0
  • Build date: 2021-02-20T12:32:16.156+05:30

MimePost API for sending email. You can find out more about MimePost at https://mimepost.com. For this sample, you can use the api key special-key to test the authorization filters.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.mimepost</groupId>
  <artifactId>mimepost</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.mimepost:mimepost:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/mimepost-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.mimepost.*;
import com.mimepost.auth.*;
import com.mimepost.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

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

        AccountsApi apiInstance = new AccountsApi();
        try {
            AccountProfileResponse result = apiInstance.accountProfileGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#accountProfileGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.mimepost.com/v1/

Class	Method	HTTP request	Description
AccountsApi	accountProfileGet	GET /account/profile/	Get account profile details
AccountsApi	accountProfilePost	POST /account/profile/	Update account profile details
AccountsApi	settingsGet	GET /settings/	Get all the settings
AccountsApi	settingsPost	POST /settings/	Set a setting
DomainsApi	domainsGet	GET /domains/	Get a list of all the domains
DomainsApi	domainsIdApprovePost	POST /domains/{id}/approve/	Submit request for the approval of a verified domain
DomainsApi	domainsIdDelete	DELETE /domains/{id}	Remove a single domain
DomainsApi	domainsIdGet	GET /domains/{id}	Get the details of a single domain
DomainsApi	domainsIdVerifyDkimPost	POST /domains/{id}/verify_dkim/	Request for the verification of DKIM record for a single domain
DomainsApi	domainsIdVerifySpfPost	POST /domains/{id}/verify_spf/	Request for the verification of SPF record for a single domain
DomainsApi	domainsIdVerifyTrackingPost	POST /domains/{id}/verify_tracking/	Request for the verification of tracking record for a single domain
DomainsApi	domainsPost	POST /domains/	Add single domain
EmailsApi	sendEmail	POST /emails/	Send email
StatsApi	emaillogsGet	GET /emaillogs/	Get the logs of a particular date
StatsApi	statsGet	GET /stats/	Get the summary of stats for a range of dates
WebhooksApi	webhooksGet	GET /webhooks/	Get the list of all the webhooks
WebhooksApi	webhooksIdDelete	DELETE /webhooks/{id}	Remove a single webhook
WebhooksApi	webhooksIdGet	GET /webhooks/{id}	Get the details of a single webhook
WebhooksApi	webhooksIdPut	PUT /webhooks/{id}	Update the details of a single webhook
WebhooksApi	webhooksPost	POST /webhooks/	Add single webhook

Documentation for Models

• AccountProfile
• AccountProfileResponse
• AccountSettings
• ApiResponseAllWebhooks
• ApiResponseAllWebhooksData
• ApiResponseDomainsList
• ApiResponseDomainsListData
• ApiResponseEmaillogs
• ApiResponseEmaillogsData
• ApiResponseSingleWebhooks
• ApiResponseStats
• ApiResponseStatsData
• ApiResponseStatsDataDatewiseSummary
• ApiResponseStatsDataGraphSummary
• ApiResponseStatsDataTotalSummary
• ApiResponseStatsDataTotalSummaryStatus
• ApiResponseWebhooks
• ApiResponseWebhooksData
• Domain
• Email
• EmailAttachments
• EmailGlobalMergeVars
• EmailMergeVars
• EmailTo
• ModelApiResponse
• Webhook
• Webhook1

Documentation for Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: X-Auth-Token
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@mimepost.com