com.sendgrid

Class SendGrid

java.lang.Object

com.sendgrid.SendGrid

public class SendGrid
extends java.lang.Object

Class SendGrid allows for quick and easy access to the SendGrid API.

Constructor Summary

Constructors

Constructor and Description
SendGrid(java.lang.String apiKey) Construct a new SendGrid API wrapper.
SendGrid(java.lang.String apiKey, java.lang.Boolean test) Construct a new SendGrid API wrapper.
SendGrid(java.lang.String apiKey, com.sendgrid.Client client) Construct a new SendGrid API wrapper.

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) Add a new request header.
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() Get the SendGrid host (api.sendgrid.com by default).
java.lang.String	getLibraryVersion() Retrieve the current library version.
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders() Obtain the request headers.
java.lang.String	getVersion() Get the API version.
void	initializeSendGrid(java.lang.String apiKey) Initialize the client.
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) Remove a request header.
void	setHost(java.lang.String host) Set the SendGrid host.
void	setVersion(java.lang.String version) Set the API version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendGrid

public SendGrid(java.lang.String apiKey)

Construct a new SendGrid API wrapper.

Parameters:

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

SendGrid

public SendGrid(java.lang.String apiKey,
                java.lang.Boolean test)

Construct a new SendGrid API wrapper.

Parameters:

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

test - is true if you are unit testing

SendGrid

public SendGrid(java.lang.String apiKey,
                com.sendgrid.Client client)

Construct a new SendGrid API wrapper.

Parameters:

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

client - the Client to use (allows to customize its configuration)

Method Detail

initializeSendGrid

public void initializeSendGrid(java.lang.String apiKey)

Initialize the client.

Parameters:

apiKey - the user's API key.

getLibraryVersion

public java.lang.String getLibraryVersion()

Retrieve the current library version.

Returns:

the current version.

getVersion

public java.lang.String getVersion()

Get the API version.

Returns:

the current API versioin (v3 by default).

setVersion

public void setVersion(java.lang.String version)

Set the API version.

Parameters:

version - the new version.

getRequestHeaders

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

Obtain the request headers.

Returns:

the request headers.

addRequestHeader

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

Add a new request header.

Parameters:

key - the header key.

value - the header value.

Returns:

the new set of request headers.

removeRequestHeader

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

Remove a request header.

Parameters:

key - the header key to remove.

Returns:

the new set of request headers.

getHost

public java.lang.String getHost()

Get the SendGrid host (api.sendgrid.com by default).

Returns:

the SendGrid host.

setHost

public void setHost(java.lang.String host)

Set the SendGrid host.

Parameters:

host - the new SendGrid host.

makeCall

public 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 to make.

Returns:

the response object.

Throws:

java.io.IOException - in case of a network error.

api

public 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 object.

Returns:

the response object.

Throws:

java.io.IOException - in case of a network error.