Go API client for emaildetective

EmailDetective.io is an API focusing on validating email addresses and providing a score based off how suspicious an email address is.

To get started register a new user (make sure to verify your email) and then you can can start getting email information.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.10.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://emaildetective.io/contact

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import emaildetective "github.com/AndrewCopeland/go-emaildetective"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value emaildetective.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), emaildetective.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value emaildetective.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), emaildetective.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using emaildetective.ContextOperationServerIndices and emaildetective.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), emaildetective.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), emaildetective.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.emaildetective.io

Class	Method	HTTP request	Description
EmailInfoAPI	GetBulkEmailAddressInfo	Post /emails	Get information and legitimacy score for many email address
EmailInfoAPI	GetEmailAddressInfo	Get /emails/{emailAddress}	Get information and legitimacy score for an email address
EmailInfoAPI	GetEmailCSV	Post /emails/csv	Get information and legitimacy score for many email addresses and return via CSV

Documentation For Models

• BulkEmailInfoRequest
• BulkEmailInfoResponse
• EmailInfoResponse
• Model400ErrorResponse
• Model401ErrorResponse
• Model404ErrorResponse
• Model429ErrorResponse
• Model500ErrorResponse

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: api_key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		emaildetective.ContextAPIKeys,
		map[string]emaildetective.APIKey{
			"api_key": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author