org.exoplatform.outlook

Interface OutlookService

All Known Implementing Classes:

OutlookServiceImpl

public interface OutlookService

Created by The eXo Platform SAS

Version:

$Id: OutlookService.java 00000 Mar 4, 2016 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROUP_DRIVE_PARRTEN
static String	MESSAGE_NODETYPE
static String	PERSONAL_DRIVE_PARRTEN

Method Summary

Modifier and Type	Method and Description
OutlookMessage	buildMessage(String messageId, OutlookUser user, OutlookEmail from, List<OutlookEmail> to, Calendar created, Calendar modified, String subject, String body) Build Outlook message object.
OutlookEmail	getAddress(String email, String displayName) Build Outlook Email address object.
Folder	getFolder(Folder parent, String path)
Folder	getFolder(String path)
OutlookMessage	getMessage(OutlookUser user, String messageId, String messageToken) Read Outlook message from server.
OutlookSpace	getSpace(String groupId) Return Office space handler.
OutlookUser	getUser(String email, String userName, String ewsUrl) Build Outlook user object and associate it with current user in eXo portal.
UserDocuments	getUserDocuments()
List<OutlookSpace>	getUserSpaces()
List<File>	saveAttachment(Folder destFolder, OutlookUser user, String comment, String messageId, String attachmentToken, String... attachmentIds)
List<File>	saveAttachment(OutlookSpace space, Folder folder, OutlookUser user, String comment, String messageId, String attachmentToken, String... attachmentIds)

Field Detail

PERSONAL_DRIVE_PARRTEN

static final String PERSONAL_DRIVE_PARRTEN

See Also:

Constant Field Values

GROUP_DRIVE_PARRTEN

static final String GROUP_DRIVE_PARRTEN

See Also:

Constant Field Values

MESSAGE_NODETYPE

static final String MESSAGE_NODETYPE

See Also:

Constant Field Values

Method Detail

getUser

OutlookUser getUser(String email,
                    String userName,
                    String ewsUrl)
             throws OutlookException,
                    javax.jcr.RepositoryException

Build Outlook user object and associate it with current user in eXo portal.

Parameters:

email - email

userName - user name

ewsUrl - Exchange web-service URL

Returns:

OutlookUser object to access Outlook Mail API

Throws:

OutlookException - Outlook exception

javax.jcr.RepositoryException - storage exception

getAddress

OutlookEmail getAddress(String email,
                        String displayName)
                 throws OutlookException

Build Outlook Email address object.

Parameters:

email - email

displayName - user display name

Returns:

OutlookEmail

Throws:

OutlookException - when error

buildMessage

OutlookMessage buildMessage(String messageId,
                            OutlookUser user,
                            OutlookEmail from,
                            List<OutlookEmail> to,
                            Calendar created,
                            Calendar modified,
                            String subject,
                            String body)
                     throws OutlookException

Build Outlook message object.

Parameters:

messageId - String email message ID

user - OutlookUser

from - OutlookEmail

to - OutlookEmail

created - Calendar

modified - Calendar

subject - String message subject

body - String message body

Returns:

OutlookMessage

Throws:

OutlookException - when error

getMessage

OutlookMessage getMessage(OutlookUser user,
                          String messageId,
                          String messageToken)
                   throws OutlookException

Read Outlook message from server.

Parameters:

messageId - String email message ID

user - OutlookUser

messageToken - String secure token to access message on Exchange server

Returns:

OutlookMessage

Throws:

OutlookException - when error

getFolder

Folder getFolder(String path)
          throws OutlookException,
                 javax.jcr.RepositoryException

Throws:

OutlookException

javax.jcr.RepositoryException

getFolder

Folder getFolder(Folder parent,
                 String path)
          throws OutlookException,
                 javax.jcr.RepositoryException

Throws:

OutlookException

javax.jcr.RepositoryException

saveAttachment

List<File> saveAttachment(OutlookSpace space,
                          Folder folder,
                          OutlookUser user,
                          String comment,
                          String messageId,
                          String attachmentToken,
                          String... attachmentIds)
                   throws OutlookSpaceException,
                          OutlookException,
                          javax.jcr.RepositoryException

Throws:

OutlookSpaceException

OutlookException

javax.jcr.RepositoryException

saveAttachment

List<File> saveAttachment(Folder destFolder,
                          OutlookUser user,
                          String comment,
                          String messageId,
                          String attachmentToken,
                          String... attachmentIds)
                   throws OutlookException,
                          javax.jcr.RepositoryException

Throws:

OutlookException

javax.jcr.RepositoryException

getSpace

OutlookSpace getSpace(String groupId)
               throws OutlookSpaceException,
                      javax.jcr.RepositoryException,
                      OutlookException

Return Office space handler.

Parameters:

groupId - String email message ID

Returns:

OutlookSpace

Throws:

OutlookSpaceException - when space access error happen

OutlookException - when error

javax.jcr.RepositoryException - when storage error

getUserSpaces

List<OutlookSpace> getUserSpaces()
                          throws OutlookSpaceException,
                                 javax.jcr.RepositoryException,
                                 OutlookException

Throws:

OutlookSpaceException

javax.jcr.RepositoryException

OutlookException

getUserDocuments

UserDocuments getUserDocuments()
                        throws javax.jcr.RepositoryException,
                               OutlookException

Throws:

javax.jcr.RepositoryException

OutlookException