com.mailjet.client

Class MailjetRequest

java.lang.Object

com.mailjet.client.MailjetRequest

public class MailjetRequest
extends Object

Author:

Guillaume Badi - Mailjet

Constructor Summary

Constructors

Constructor and Description
MailjetRequest(Resource res) Make a Mailjet request with a single resource.
MailjetRequest(Resource res, long id) In case of a simple view.
MailjetRequest(Resource res, long id, long actionid) Build a Request with an actionID
MailjetRequest(Resource res, String id) In case of a simple view.

Method Summary

Modifier and Type	Method and Description
MailjetRequest	append(String key, Object value) Append a value to the body[key]
String	buildUrl() Build the call URL with query string parameters
MailjetRequest	filter(String key, int value) Add a String/int filter to the _filters hash
MailjetRequest	filter(String key, String value) Add a String-String filter to the the _filters hash
String	getBody() Body getter
org.json.JSONObject	getBodyJSON() Body JSON getter
String	getContentType() Returns the appropriate Content-Type according to the resource/action
MailjetRequest	property(String key, Object value) Add a property to the body JSONObject
String	queryString() Build a query string using the _filters hash
MailjetRequest	setBody(HashMap<String,Object> json) Use an HashMap to build the body
MailjetRequest	setBody(org.json.JSONObject json) Pass a JSONObject formatted json as the request body
MailjetRequest	setBody(String json) Pass a String formatted json as the request body
MailjetRequest	setData(String path)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MailjetRequest

public MailjetRequest(Resource res)

Make a Mailjet request with a single resource.

Parameters:

res -

MailjetRequest

public MailjetRequest(Resource res,
                      long id)

In case of a simple view. Call a single resource with a single ID

Parameters:

res -

id -

MailjetRequest

public MailjetRequest(Resource res,
                      String id)

In case of a simple view. Call a single resource with a single ID

Parameters:

res -

id -

MailjetRequest

public MailjetRequest(Resource res,
                      long id,
                      long actionid)

Build a Request with an actionID

Parameters:

res - the resource object

id - the resource ID

actionid - the resource action ID

Method Detail

setData

public MailjetRequest setData(String path)
                       throws IOException

Throws:

IOException

setBody

public MailjetRequest setBody(String json)

Pass a String formatted json as the request body

Parameters:

json -

Returns:

the request itself

setBody

public MailjetRequest setBody(org.json.JSONObject json)

Pass a JSONObject formatted json as the request body

Parameters:

json -

Returns:

the request itself

setBody

public MailjetRequest setBody(HashMap<String,Object> json)

Use an HashMap to build the body

Parameters:

json -

Returns:

the request itself

getBody

public String getBody()

Body getter

Returns:

the stringified body

getBodyJSON

public org.json.JSONObject getBodyJSON()

Body JSON getter

Returns:

the body as JSONObject

getContentType

public String getContentType()

Returns the appropriate Content-Type according to the resource/action

Returns:

Content-Type

buildUrl

public String buildUrl()
                throws MalformedURLException,
                       UnsupportedEncodingException

Build the call URL with query string parameters

Returns:

url

Throws:

MalformedURLException

UnsupportedEncodingException

append

public MailjetRequest append(String key,
                             Object value)

Append a value to the body[key]

Parameters:

key - the key

value - the value to be pushed

Returns:

the Mailjet Request itslef

filter

public MailjetRequest filter(String key,
                             String value)

Add a String-String filter to the the _filters hash

Parameters:

key -

value -

Returns:

the request itself

filter

public MailjetRequest filter(String key,
                             int value)

Add a String/int filter to the _filters hash

Parameters:

key -

value -

Returns:

the request itself

queryString

public String queryString()
                   throws UnsupportedEncodingException

Build a query string using the _filters hash

Returns:

a query string

Throws:

UnsupportedEncodingException

property

public MailjetRequest property(String key,
                               Object value)

Add a property to the body JSONObject

Parameters:

key -

value -

Returns:

the request itself

toString

public String toString()

Overrides:

toString in class Object