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)
SendGrid(java.lang.String apiKey, java.lang.Boolean test)
SendGrid(java.lang.String apiKey, com.sendgrid.Client client)

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)
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()
java.lang.String	getLibraryVersion()
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders()
java.lang.String	getVersion()
void	initializeSendGrid(java.lang.String apiKey)
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)
void	setHost(java.lang.String host)
void	setVersion(java.lang.String 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)

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)

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)

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)

getLibraryVersion

public java.lang.String getLibraryVersion()

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getRequestHeaders

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

addRequestHeader

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

removeRequestHeader

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

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String 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.

Throws:

java.io.IOException

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.

Throws:

java.io.IOException