com.axemble.vdoc.sdk.system.mail

Interface ISystemMailExtension

All Known Implementing Classes:

DefaultSystemMailExtension

public interface ISystemMailExtension

Mail extension used to build systems mail

Method Summary

Modifier and Type	Method and Description
javax.mail.internet.MimeMessage	buildLostPasswordMessage(LostPasswordConfiguration configuration) build lost password message
javax.mail.internet.MimeMessage	buildUninitializedPasswordMessage(UninitializedPasswordConfiguration configuration) build new account message
javax.mail.internet.MimeMessage	buildUpdatePasswordMessage(UpdatePasswordConfiguration configuration) build update password message
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

Method Detail

buildLostPasswordMessage

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

build lost password message

Parameters:

configuration - LostPasswordConfiguration

Returns:

mime message to send

Throws:

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

buildUpdatePasswordMessage

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

build update password message

Parameters:

configuration - UpdatePasswordConfiguration

Returns:

mime message to send

Throws:

ExternalUserException - if user is external

NonContactableUserException - if user haven't mail

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

buildUninitializedPasswordMessage

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

build new account message

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

String retrieveDefaultEmailLogo(IUser user)

Retrieve the default email logo

Parameters:

user - the current user who will receive a mail

Returns:

the logo path

retrieveDefaultEmailColor

String retrieveDefaultEmailColor(IUser user)

Retrieve the default email color

Parameters:

user - the current user who will receive a mail

Returns:

the hexadecimal color code

retrieveUninitializedPasswordLink

String retrieveUninitializedPasswordLink(UninitializedPasswordConfiguration configuration)

Retrieve the URL for uninitialized password

Parameters:

configuration - the configuration

Returns:

the full link

retrieveLostPasswordLink

String retrieveLostPasswordLink(LostPasswordConfiguration configuration)

Retrieve the URL for lost password

Parameters:

configuration - the configuration

Returns:

the full link

retrieveUpdatedPasswordPasswordLink

String retrieveUpdatedPasswordPasswordLink(UpdatePasswordConfiguration configuration)

Retrieve the URL for updated password confirmation

Parameters:

configuration - the configuration

Returns:

the full link

retrieveDefaultPlateformeLink

String retrieveDefaultPlateformeLink()

Retrieve the default login page URL

Returns:

the link