com.mailgun.api.v4.MailgunEmailVerificationApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mailgun-java Show documentation
The Mailgun SDK for Java enables Java developers to work with Mailgun API efficiently.
The newest version!
package com.mailgun.api.v4;

import com.mailgun.api.MailgunApi;
import com.mailgun.enums.ApiVersion;
import com.mailgun.model.verification.AddressValidationResponse;
import com.mailgun.model.verification.BulkVerificationCreatingResponse;
import com.mailgun.model.verification.BulkVerificationJobListResponse;
import com.mailgun.model.verification.BulkVerificationJobStatusResponse;
import com.mailgun.model.verification.BulkVerificationPreviewListResponse;
import com.mailgun.model.verification.BulkVerificationPreviewResponse;
import com.mailgun.model.verification.BulkVerificationStatusRequest;
import feign.Headers;
import feign.Param;
import feign.RequestLine;
import feign.Response;

/**
 * 
 * This API endpoint is an email address verification service.
 * 
 * 
 * We will verify the given address based on:
 * 
 *  * Mailbox detection
 * Syntax checks (RFC defined grammar)
 * DNS validation
 * Spell checks
 * Email Service Provider (ESP) specific local-part grammar (if available).
 * 
 *
 * @see Email Validation/Verification
 */
public interface MailgunEmailVerificationApi extends MailgunApi {

    static ApiVersion getApiVersion() {
        return ApiVersion.V_4;
    }

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address An email address to validate. (Maximum: 512 characters)
     * @return {@link AddressValidationResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate?address={address}")
    AddressValidationResponse validateAddress(@Param("address") String address);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address An email address to validate. (Maximum: 512 characters)
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate?address={address}")
    Response validateAddressFeignResponse(@Param("address") String address);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address An email address to validate. (Maximum: 512 characters)
     * @return {@link AddressValidationResponse}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate")
    AddressValidationResponse validateAddressPostRequest(@Param("address") String address);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address An email address to validate. (Maximum: 512 characters)
     * @return {@link Response}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate")
    Response validateAddressPostRequestFeignResponse(@Param("address") String address);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address        An email address to validate. (Maximum: 512 characters)
     * @param providerLookup Warning: For advanced users only.
     *                       The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider.
     *                       If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.
     * @return {@link AddressValidationResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate?address={address}&provider_lookup={providerLookup}")
    AddressValidationResponse validateAddress(@Param("address") String address, @Param("providerLookup") Boolean providerLookup);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address        An email address to validate. (Maximum: 512 characters)
     * @param providerLookup Warning: For advanced users only.
     *                       The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider.
     *                       If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate?address={address}&provider_lookup={providerLookup}")
    Response validateAddressFeignResponse(@Param("address") String address, @Param("providerLookup") Boolean providerLookup);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address        An email address to validate. (Maximum: 512 characters)
     * @param providerLookup Warning: For advanced users only
     *                       The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider.
     *                       If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.
     * @return {@link AddressValidationResponse}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate?provider_lookup={providerLookup}")
    AddressValidationResponse validateAddressPostRequest(@Param("address") String address, @Param("providerLookup") Boolean providerLookup);

    /**
     * 
     * Given an arbitrary address, validates address based off defined checks.
     * 
     *
     * @param address        An email address to validate. (Maximum: 512 characters)
     * @param providerLookup Warning: For advanced users only
     *                       The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider.
     *                       If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.
     * @return {@link Response}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate?provider_lookup={providerLookup}")
    Response validateAddressPostFeignResponse(@Param("address") String address, @Param("providerLookup") Boolean providerLookup);

    /**
     * 
     * Get list of all bulk verification jobs (limit to 500 entries).
     * 
     *
     * @return {@link BulkVerificationJobListResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/bulk")
    BulkVerificationJobListResponse getBulkVerificationJobList();

    /**
     * 
     * Get list of all bulk verification jobs (limit to 500 entries).
     * 
     *
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/bulk")
    Response getBulkVerificationJobListFeignResponse();

    /**
     * 
     * Get list of all bulk verification jobs.
     * 
     *
     * @param limit  Number of entries to return.
     * @return {@link BulkVerificationJobListResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/bulk?limit={limit}")
    BulkVerificationJobListResponse getBulkVerificationJobList(@Param("limit") Integer limit);

    /**
     * 
     * Get list of all bulk verification jobs.
     * 
     *
     * @param limit  Number of entries to return.
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/bulk?limit={limit}")
    Response getBulkVerificationJobListFeignResponse(@Param("limit") Integer limit);

    /**
     * 
     * Check the current status of a bulk verification job.
     * 
     *
     * @param listName Bulk verification job list name
     * @return {@link BulkVerificationJobStatusResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/bulk/{listName}")
    BulkVerificationJobStatusResponse getBulkVerificationJobStatus(@Param("listName") String listName);

    /**
     * 
     * Check the current status of a bulk verification job.
     * 
     *
     * @param listName Bulk verification job list name
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/bulk/{listName}")
    Response getBulkVerificationJobStatusFeignResponse(@Param("listName") String listName);

    /**
     * 
     * Create a bulk verification job.
     * 
     *
     * @param listName Bulk verification job list name
     * @param request  {@link BulkVerificationStatusRequest}
     * @return {@link BulkVerificationCreatingResponse}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate/bulk/{listName}")
    BulkVerificationCreatingResponse createBulkVerificationJob(@Param("listName") String listName,
        BulkVerificationStatusRequest request);

    /**
     * 
     * Create a bulk verification job.
     * 
     *
     * @param listName Bulk verification job list name
     * @param request  {@link BulkVerificationStatusRequest}
     * @return {@link Response}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate/bulk/{listName}")
    Response createBulkVerificationJobFeignResponse(@Param("listName") String listName,
        BulkVerificationStatusRequest request);

    /**
     * 
     * Cancel current running bulk verification job.
     * 
     *
     * @param listName Bulk verification job list name
     * @return Result status message
     */
    @Headers({"Accept: application/json"})
    @RequestLine("DELETE /address/validate/bulk/{listName}")
    String cancelBulkVerificationJob(@Param("listName") String listName);

    /**
     * 
     * Cancel current running bulk verification job.
     * 
     *
     * @param listName Bulk verification job list name
     * @return {@link Response}
     */
    @Headers({"Accept: application/json"})
    @RequestLine("DELETE /address/validate/bulk/{listName}")
    Response cancelBulkVerificationJobFeignResponse(@Param("listName") String listName);

    /**
     * 
     * Get list of all bulk verification previews.
     * 
     *
     * @return {@link BulkVerificationPreviewListResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/preview")
    BulkVerificationPreviewListResponse getBulkVerificationPreviewList();

    /**
     * 
     * Get list of all bulk verification previews.
     * 
     *
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/preview")
    Response getBulkVerificationPreviewListFeignResponse();

    /**
     * 
     * Check the current status of a bulk verification preview.
     * 
     *
     * @param listName Bulk verification preview list name
     * @return {@link
     * BulkVerificationPreviewResponse}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/preview/{listName}")
    BulkVerificationPreviewResponse getBulkVerificationPreviewStatus(@Param("listName") String listName);

    /**
     * 
     * Check the current status of a bulk verification preview.
     * 
     *
     * @param listName Bulk verification preview list name
     * @return {@link Response}
     */
    @Headers("Accept: application/json")
    @RequestLine("GET /address/validate/preview/{listName}")
    Response getBulkVerificationPreviewStatusFeignResponse(@Param("listName") String listName);

    /**
     * 
     * Create a bulk verification preview.
     * 
     *
     * @param listName Bulk verification preview list name
     * @param request  {@link BulkVerificationStatusRequest}
     * @return {@link BulkVerificationCreatingResponse}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate/preview/{listName}")
    BulkVerificationCreatingResponse createBulkVerificationPreview(@Param("listName") String listName,
        BulkVerificationStatusRequest request);

    /**
     * 
     * Create a bulk verification preview.
     * 
     *
     * @param listName Bulk verification preview list name
     * @param request  {@link BulkVerificationStatusRequest}
     * @return {@link Response}
     */
    @Headers({"Content-Type: multipart/form-data", "Accept: application/json"})
    @RequestLine("POST /address/validate/preview/{listName}")
    Response createBulkVerificationPreviewFeignResponse(@Param("listName") String listName,
        BulkVerificationStatusRequest request);

    /**
     * 
     * Delete a bulk verification preview.
     * 
     *
     * @param listName Bulk verification preview list name
     * @return {@link Response}
     */
    @Headers({"Accept: application/json"})
    @RequestLine("DELETE /address/validate/preview/{listName}")
    Response deleteBulkVerificationPreview(@Param("listName") String listName);
}