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 The group drive parrten.
static String	MESSAGE_NODETYPE The message nodetype.
static String	PERSONAL_DRIVE_PARRTEN The 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 title, 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) Gets the folder.
Folder	getFolder(String path) Gets the folder.
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() Gets the user documents.
List<OutlookSpace>	getUserSpaces() Gets the user spaces.
List<File>	saveAttachment(Folder destFolder, OutlookUser user, String comment, String messageId, String attachmentToken, String... attachmentIds) Save attachment.
List<File>	saveAttachment(OutlookSpace space, Folder folder, OutlookUser user, String comment, String messageId, String attachmentToken, String... attachmentIds) Save attachment.

Field Detail

PERSONAL_DRIVE_PARRTEN

static final String PERSONAL_DRIVE_PARRTEN

The personal drive parrten.

See Also:

Constant Field Values

GROUP_DRIVE_PARRTEN

static final String GROUP_DRIVE_PARRTEN

The group drive parrten.

See Also:

Constant Field Values

MESSAGE_NODETYPE

static final String MESSAGE_NODETYPE

The 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 title,
                            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

title - the title

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:

user - OutlookUser

messageId - String email message ID

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

Gets the folder.

Parameters:

path - the path

Returns:

the folder

Throws:

OutlookException - the outlook exception

javax.jcr.RepositoryException - the repository exception

getFolder

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

Gets the folder.

Parameters:

parent - the parent

path - the path

Returns:

the folder

Throws:

OutlookException - the outlook exception

javax.jcr.RepositoryException - the repository exception

saveAttachment

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

Save attachment.

Parameters:

space - the space

folder - the folder

user - the user

comment - the comment

messageId - the message id

attachmentToken - the attachment token

attachmentIds - the attachment ids

Returns:

the list

Throws:

OutlookSpaceException - the outlook space exception

OutlookException - the outlook exception

javax.jcr.RepositoryException - the repository exception

saveAttachment

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

Save attachment.

Parameters:

destFolder - the dest folder

user - the user

comment - the comment

messageId - the message id

attachmentToken - the attachment token

attachmentIds - the attachment ids

Returns:

the list

Throws:

OutlookException - the outlook exception

javax.jcr.RepositoryException - the repository exception

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

javax.jcr.RepositoryException - when storage error

OutlookException - when error

getUserSpaces

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

Gets the user spaces.

Returns:

the user spaces

Throws:

OutlookSpaceException - the outlook space exception

javax.jcr.RepositoryException - the repository exception

OutlookException - the outlook exception

getUserDocuments

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

Gets the user documents.

Returns:

the user documents

Throws:

javax.jcr.RepositoryException - the repository exception

OutlookException - the outlook exception