Package org.exoplatform.mailintegration.service

Interface MailIntegrationService

public interface MailIntegrationService

Method Summary

Modifier and Type	Method	Description
javax.mail.Store	connect(MailIntegrationSetting mailIntegrationSetting)	Connect to a mail integration setting
MailIntegrationSetting	createMailIntegrationSetting(MailIntegrationSetting mailIntegrationSetting)	Creates a new mail integration setting
void	deleteMailIntegrationSetting(long mailIntegrationSettingId, long userIdentityId)	Deletes a mail integration setting
MailIntegrationSetting	getMailIntegrationSetting(long mailIntegrationSettingId)	Retrieves mail integration setting by its technical identify and user identity identifier.
List<MailIntegrationSetting>	getMailIntegrationSettingsByUserId(long userIdentityId)	Retrieves mail integration setting by its technical user identity identifier.
MessageRestEntity	getMessageById(long mailIntegrationSettingId, String messageId, long userIdentityId)	Retrieves message object by its technical identifier and the mail integration setting technical identifier
void	sendMailIntegrationNotifications()	Send mail integration notification
MailIntegrationSetting	updateMailIntegrationSetting(MailIntegrationSetting mailIntegrationSetting, long userIdentityId)	Update mail integration setting

Method Detail

createMailIntegrationSetting

MailIntegrationSetting createMailIntegrationSetting(MailIntegrationSetting mailIntegrationSetting)

Creates a new mail integration setting

Parameters:

mailIntegrationSetting - MailIntegrationSetting object to create

Returns:

created MailIntegrationSetting with generated technical identifier

getMailIntegrationSettingsByUserId

List<MailIntegrationSetting> getMailIntegrationSettingsByUserId(long userIdentityId)

Retrieves mail integration setting by its technical user identity identifier.

Parameters:

userIdentityId - User identity getting the mail integration setting

Returns:

A List of MailIntegrationSetting objects

getMailIntegrationSetting

MailIntegrationSetting getMailIntegrationSetting(long mailIntegrationSettingId)

Retrieves mail integration setting by its technical identify and user identity identifier.

Parameters:

mailIntegrationSettingId - MailIntegrationSetting technical identifier to retrieve

Returns:

MailIntegrationSetting object

deleteMailIntegrationSetting

void deleteMailIntegrationSetting(long mailIntegrationSettingId,
                                  long userIdentityId)
                           throws IllegalAccessException

Deletes a mail integration setting

Parameters:

mailIntegrationSettingId - MailIntegrationSetting technical identifier to delete

userIdentityId - User identity deleting the mail integration setting

Throws:

IllegalAccessException - when the user is not authorized to delete mail integration setting

connect

javax.mail.Store connect(MailIntegrationSetting mailIntegrationSetting)

Connect to a mail integration setting

Parameters:

mailIntegrationSetting - MailIntegrationSetting object to connect

Returns:

connected store

sendMailIntegrationNotifications

void sendMailIntegrationNotifications()

Send mail integration notification

getMessageById

MessageRestEntity getMessageById(long mailIntegrationSettingId,
                                 String messageId,
                                 long userIdentityId)
                          throws IllegalAccessException

Retrieves message object by its technical identifier and the mail integration setting technical identifier

Parameters:

mailIntegrationSettingId - MailIntegrationSetting technical identifier

messageId - Message technical identifier

userIdentityId - User identity getting the message

Returns:

Message object

Throws:

IllegalAccessException - when the user is not authorized to get message

updateMailIntegrationSetting

MailIntegrationSetting updateMailIntegrationSetting(MailIntegrationSetting mailIntegrationSetting,
                                                    long userIdentityId)
                                             throws IllegalAccessException

Update mail integration setting

Parameters:

mailIntegrationSetting - MailIntegrationSetting object to update

userIdentityId - User identity updating the mail integration setting

Returns:

updated MailIntegrationSetting object

Throws:

IllegalAccessException - when the user is not authorized to update mail integration setting