com.sendgrid

Interface SendGridAPI

All Known Implementing Classes:

SendGrid

public interface SendGridAPI

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	addRequestHeader(java.lang.String key, java.lang.String value) Adds a request headers.
com.sendgrid.Response	api(com.sendgrid.Request request) Class api sets up the request to the SendGrid API, this is main interface.
java.lang.String	getHost() Gets the host.
java.lang.String	getLibraryVersion() Returns the library version
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders() Gets the request headers.
java.lang.String	getVersion() Gets the version.
void	initializeSendGrid(java.lang.String apiKey) Initializes SendGrid
com.sendgrid.Response	makeCall(com.sendgrid.Request request) Class makeCall makes the call to the SendGrid API, override this method for testing.
java.util.Map<java.lang.String,java.lang.String>	removeRequestHeader(java.lang.String key) Removes a request headers.
void	setHost(java.lang.String host) Sets the host.
void	setVersion(java.lang.String version) Sets the version.

Method Detail

initializeSendGrid

void initializeSendGrid(java.lang.String apiKey)

Initializes SendGrid

Parameters:

apiKey - is your SendGrid API Key: https://app.sendgrid.com/settings/api_keys

getLibraryVersion

java.lang.String getLibraryVersion()

Returns the library version

Returns:

the library version.

getVersion

java.lang.String getVersion()

Gets the version.

Returns:

returns the version.

setVersion

void setVersion(java.lang.String version)

Sets the version.

Parameters:

version - the SendGrid version.

getRequestHeaders

java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Gets the request headers.

Returns:

returns a map of request headers.

addRequestHeader

java.util.Map<java.lang.String,java.lang.String> addRequestHeader(java.lang.String key,
                                                                  java.lang.String value)

Adds a request headers.

Parameters:

key - the key

value - the value

Returns:

returns a map of request headers.

removeRequestHeader

java.util.Map<java.lang.String,java.lang.String> removeRequestHeader(java.lang.String key)

Removes a request headers.

Parameters:

key - the key

Returns:

returns a map of request headers.

getHost

java.lang.String getHost()

Gets the host.

Returns:

returns the host.

setHost

void setHost(java.lang.String host)

Sets the host.

Parameters:

host - the host to set

makeCall

com.sendgrid.Response makeCall(com.sendgrid.Request request)
                        throws java.io.IOException

Class makeCall makes the call to the SendGrid API, override this method for testing.

Parameters:

request - the request

Returns:

returns a response.

Throws:

java.io.IOException - in case of network or marshal error.

api

com.sendgrid.Response api(com.sendgrid.Request request)
                   throws java.io.IOException

Class api sets up the request to the SendGrid API, this is main interface.

Parameters:

request - the request

Returns:

returns a response.

Throws:

java.io.IOException - in case of network or marshal error.