org.exoplatform.outlook.mail

Class MailAPI

java.lang.Object

org.exoplatform.outlook.mail.MailAPI

public class MailAPI
extends Object

Java client for Outlook Mail REST API.
Created by The eXo Platform SAS

Version:

$Id: MailAPI.java 00000 Jun 7, 2016 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.Header	acceptJsonHeader The accept json header.
protected org.apache.http.impl.client.CloseableHttpClient	httpClient The http client.
protected org.apache.http.client.protocol.HttpClientContext	httpContext The http context.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected static String	MODELS_ERROR The Constant MODELS_ERROR.
protected static String	READ_ATTACHMENT_ERROR The Constant READ_ATTACHMENT_ERROR.
protected static String	READ_MESSAGE_ERROR The Constant READ_MESSAGE_ERROR.

Constructor Summary

Constructors

Constructor and Description
MailAPI() Instantiates a new mail API.

Method Summary

Modifier and Type	Method and Description
protected void	checkError(org.apache.http.HttpResponse response, String errorBase) Check error.
void	close() Close.
org.exoplatform.ws.frameworks.json.value.JsonValue	getAttachment(OutlookUser user, String messageId, String attachmentToken, String attachmentId) Gets the attachment.
org.exoplatform.ws.frameworks.json.value.JsonValue	getMessage(OutlookUser user, String messageId, String messageToken) Gets the message.
protected org.exoplatform.ws.frameworks.json.value.JsonValue	readJson(InputStream content) Read json.
protected String	readText(org.apache.http.HttpEntity entity) Read text.
void	reset() Reset.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

READ_ATTACHMENT_ERROR

protected static final String READ_ATTACHMENT_ERROR

The Constant READ_ATTACHMENT_ERROR.

See Also:

Constant Field Values

READ_MESSAGE_ERROR

protected static final String READ_MESSAGE_ERROR

The Constant READ_MESSAGE_ERROR.

See Also:

Constant Field Values

MODELS_ERROR

protected static final String MODELS_ERROR

The Constant MODELS_ERROR.

See Also:

Constant Field Values

httpClient

protected final org.apache.http.impl.client.CloseableHttpClient httpClient

The http client.

httpContext

protected final org.apache.http.client.protocol.HttpClientContext httpContext

The http context.

acceptJsonHeader

protected final org.apache.http.Header acceptJsonHeader

The accept json header.

Constructor Detail

MailAPI

public MailAPI()
        throws MailServerException

Instantiates a new mail API.

Throws:

MailServerException - the mail server exception

Method Detail

close

public void close()
           throws MailServerException

Close.

Throws:

MailServerException - the mail server exception

reset

public void reset()

Reset.

getAttachment

public org.exoplatform.ws.frameworks.json.value.JsonValue getAttachment(OutlookUser user,
                                                                        String messageId,
                                                                        String attachmentToken,
                                                                        String attachmentId)
                                                                 throws BadCredentialsException,
                                                                        ForbiddenException,
                                                                        MailServerException

Gets the attachment.

Parameters:

user - the user

messageId - the message id

attachmentToken - the attachment token

attachmentId - the attachment id

Returns:

the attachment

Throws:

BadCredentialsException - the bad credentials exception

ForbiddenException - the forbidden exception

MailServerException - the mail server exception

getMessage

public org.exoplatform.ws.frameworks.json.value.JsonValue getMessage(OutlookUser user,
                                                                     String messageId,
                                                                     String messageToken)
                                                              throws BadCredentialsException,
                                                                     ForbiddenException,
                                                                     MailServerException

Gets the message.

Parameters:

user - the user

messageId - the message id

messageToken - the message token

Returns:

the message

Throws:

BadCredentialsException - the bad credentials exception

ForbiddenException - the forbidden exception

MailServerException - the mail server exception

readJson

protected org.exoplatform.ws.frameworks.json.value.JsonValue readJson(InputStream content)
                                                               throws org.exoplatform.ws.frameworks.json.impl.JsonException

Read json.

Parameters:

content - the content

Returns:

the json value

Throws:

org.exoplatform.ws.frameworks.json.impl.JsonException - the json exception

readText

protected String readText(org.apache.http.HttpEntity entity)

Read text.

Parameters:

entity - the entity

Returns:

the string

checkError

protected void checkError(org.apache.http.HttpResponse response,
                          String errorBase)
                   throws BadCredentialsException,
                          ForbiddenException,
                          MailServerException

Check error.

Parameters:

response - the response

errorBase - the error base

Throws:

BadCredentialsException - the bad credentials exception

ForbiddenException - the forbidden exception

MailServerException - the mail server exception