com.axemble.vdoc.sdk.mail

Class DefaultSystemMailExtension

java.lang.Object

com.axemble.vdoc.sdk.mail.DefaultSystemMailExtension

All Implemented Interfaces:

ISystemMailExtension

public class DefaultSystemMailExtension
extends Object
implements ISystemMailExtension

Default mail extension for password management

Field Summary

Fields

Modifier and Type	Field and Description
protected com.axemble.vdoc.core.services.ConfigurationService	configurationService
protected com.axemble.vdp.localization.structures.LocalizationService	localizationService
static String	TEXT_PLAIN

Constructor Summary

Constructors

Constructor and Description
DefaultSystemMailExtension() Runtime constructor with default dependencies
DefaultSystemMailExtension(com.axemble.vdp.localization.structures.LocalizationService localizationService, com.axemble.vdoc.core.services.ConfigurationService configurationService) Constructor with dependency injection

Method Summary

Modifier and Type	Method and Description
javax.mail.internet.MimeMessage	buildLostPasswordMessage(LostPasswordConfiguration configuration) Build mail with redirect url to the confirm screen.
javax.mail.internet.MimeMessage	buildUninitializedPasswordMessage(UninitializedPasswordConfiguration configuration) build new account message
javax.mail.internet.MimeMessage	buildUpdatePasswordMessage(UpdatePasswordConfiguration configuration) Build mail with newly generated password
static boolean	canBeContacted(IUser user) Test if a user have a valid email adress
String	retrieveDefaultEmailColor(IUser user) Retrieve the default email color
String	retrieveDefaultEmailLogo(IUser user) Retrieve the default email logo
String	retrieveDefaultPlateformeLink() Retrieve the default login page URL
String	retrieveLostPasswordLink(LostPasswordConfiguration configuration) Retrieve the URL for lost password
String	retrieveUninitializedPasswordLink(UninitializedPasswordConfiguration configuration) Retrieve the URL for uninitialized password
String	retrieveUpdatedPasswordPasswordLink(UpdatePasswordConfiguration configuration) Retrieve the URL for updated password confirmation
protected void	setNewPasswordMessage(javax.mail.internet.MimeMessage mimeMessage, UpdatePasswordConfiguration configuration)
protected void	setUninitializedPasswordMessage(javax.mail.internet.MimeMessage mimeMessage, UninitializedPasswordConfiguration configuration)

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_PLAIN

public static final String TEXT_PLAIN

See Also:

Constant Field Values

localizationService

protected final com.axemble.vdp.localization.structures.LocalizationService localizationService

configurationService

protected final com.axemble.vdoc.core.services.ConfigurationService configurationService

Constructor Detail

DefaultSystemMailExtension

public DefaultSystemMailExtension()

Runtime constructor with default dependencies

DefaultSystemMailExtension

public DefaultSystemMailExtension(com.axemble.vdp.localization.structures.LocalizationService localizationService,
                                  com.axemble.vdoc.core.services.ConfigurationService configurationService)

Constructor with dependency injection

Parameters:

localizationService - how to resolve static string.

configurationService - configuration service

Method Detail

canBeContacted

public static boolean canBeContacted(IUser user)

Test if a user have a valid email adress

Parameters:

user - user

Returns:

true if user can be contacted (valid email address) else false

setNewPasswordMessage

protected void setNewPasswordMessage(javax.mail.internet.MimeMessage mimeMessage,
                                     UpdatePasswordConfiguration configuration)
                              throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

setUninitializedPasswordMessage

protected void setUninitializedPasswordMessage(javax.mail.internet.MimeMessage mimeMessage,
                                               UninitializedPasswordConfiguration configuration)
                                        throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

buildLostPasswordMessage

public final javax.mail.internet.MimeMessage buildLostPasswordMessage(LostPasswordConfiguration configuration)
                                                               throws javax.mail.MessagingException

Build mail with redirect url to the confirm screen.

Specified by:

buildLostPasswordMessage in interface ISystemMailExtension

Parameters:

configuration - the lost password mail configuration

Returns:

the mime message with body, to and from

Throws:

javax.mail.MessagingException - if there is a problem with mime message

buildUpdatePasswordMessage

public final javax.mail.internet.MimeMessage buildUpdatePasswordMessage(UpdatePasswordConfiguration configuration)
                                                                 throws ExternalUserException,
                                                                        NonContactableUserException,
                                                                        javax.mail.MessagingException

Build mail with newly generated password

Specified by:

buildUpdatePasswordMessage in interface ISystemMailExtension

Parameters:

configuration - the mail configuration

Returns:

the mime message with body, to and from

Throws:

ExternalUserException - if user is external

NonContactableUserException - if user haven't mail

javax.mail.MessagingException - if there is a problem with mime message

buildUninitializedPasswordMessage

public javax.mail.internet.MimeMessage buildUninitializedPasswordMessage(UninitializedPasswordConfiguration configuration)
                                                                  throws javax.mail.MessagingException,
                                                                         NonContactableUserException

Description copied from interface: ISystemMailExtension

build new account message

Specified by:

buildUninitializedPasswordMessage in interface ISystemMailExtension

Parameters:

configuration - UninitializedPasswordConfiguration

Returns:

mime message to send

Throws:

javax.mail.MessagingException - if there is a problem with mime message

NonContactableUserException - if user haven't mail

retrieveDefaultEmailLogo

public String retrieveDefaultEmailLogo(IUser user)

Description copied from interface: ISystemMailExtension

Retrieve the default email logo

Specified by:

retrieveDefaultEmailLogo in interface ISystemMailExtension

Parameters:

user - the current user who will receive a mail

Returns:

the logo path

retrieveDefaultEmailColor

public String retrieveDefaultEmailColor(IUser user)

Description copied from interface: ISystemMailExtension

Retrieve the default email color

Specified by:

retrieveDefaultEmailColor in interface ISystemMailExtension

Parameters:

user - the current user who will receive a mail

Returns:

the hexadecimal color code

retrieveUninitializedPasswordLink

public String retrieveUninitializedPasswordLink(UninitializedPasswordConfiguration configuration)

Description copied from interface: ISystemMailExtension

Retrieve the URL for uninitialized password

Specified by:

retrieveUninitializedPasswordLink in interface ISystemMailExtension

Parameters:

configuration - the configuration

Returns:

the full link

retrieveLostPasswordLink

public String retrieveLostPasswordLink(LostPasswordConfiguration configuration)

Description copied from interface: ISystemMailExtension

Retrieve the URL for lost password

Specified by:

retrieveLostPasswordLink in interface ISystemMailExtension

Parameters:

configuration - the configuration

Returns:

the full link

retrieveUpdatedPasswordPasswordLink

public String retrieveUpdatedPasswordPasswordLink(UpdatePasswordConfiguration configuration)

Description copied from interface: ISystemMailExtension

Retrieve the URL for updated password confirmation

Specified by:

retrieveUpdatedPasswordPasswordLink in interface ISystemMailExtension

Parameters:

configuration - the configuration

Returns:

the full link

retrieveDefaultPlateformeLink

public String retrieveDefaultPlateformeLink()

Description copied from interface: ISystemMailExtension

Retrieve the default login page URL

Specified by:

retrieveDefaultPlateformeLink in interface ISystemMailExtension

Returns:

the link