com.axemble.vdoc.sdk.utils

Interface IMailUtils

public interface IMailUtils

IMailUtils Use this utils to manipulate mails and mails' templates through Process

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOKMARK_CONTENT
static String	BOOKMARK_DETAILS
static String	BOOKMARK_DIRECT_LINK_LABEL
static String	BOOKMARK_FOOTER_TEXT
static String	BOOKMARK_LINK
static String	BOOKMARK_LINK_LABEL
static String	BOOKMARK_LOGO
static String	BOOKMARK_PRIMARY_COLOR
static String	BOOKMARK_SERVER_BASE_URL
static String	BOOKMARK_SUBJECT
static String	BOOKMARK_USER

Method Summary

Modifier and Type	Method and Description
IMailTemplate	buildMailTemplate(String language, IResource resource, Map<String,Object> parameters) Build a Mail template object form a given resource and pa map parameter The template is translated in the current user language, and all the bookmarks are replaced from the map parameters
String	retrieveMailTemplateContent(String language, IResource template) Retrieve the content of a mail template Choose the default value if it is not override
IStorageResource	retrieveMailTemplateFromReference(IContext context, String templateRef) Retrieve a mailTemplate resource in the data universe of the Platform management application from its reference
String	retrieveMailTemplateSubject(String language, IResource template) Retrieve the subject of a mail template Choose the default value if it is not overrides
void	updateMailTemplateContent(String language, IResource template, String newValue) Update the content of a mail template Choose the default value if it is not override
void	updateMailTemplateSubject(String language, IResource template, String newValue) Update the subject of a mail template Choose the default value if it is not override

Field Detail

BOOKMARK_USER

static final String BOOKMARK_USER

See Also:

Constant Field Values

BOOKMARK_LOGO

static final String BOOKMARK_LOGO

See Also:

Constant Field Values

BOOKMARK_SUBJECT

static final String BOOKMARK_SUBJECT

See Also:

Constant Field Values

BOOKMARK_CONTENT

static final String BOOKMARK_CONTENT

See Also:

Constant Field Values

BOOKMARK_DETAILS

static final String BOOKMARK_DETAILS

See Also:

Constant Field Values

BOOKMARK_LINK_LABEL

static final String BOOKMARK_LINK_LABEL

See Also:

Constant Field Values

BOOKMARK_LINK

static final String BOOKMARK_LINK

See Also:

Constant Field Values

BOOKMARK_PRIMARY_COLOR

static final String BOOKMARK_PRIMARY_COLOR

See Also:

Constant Field Values

BOOKMARK_DIRECT_LINK_LABEL

static final String BOOKMARK_DIRECT_LINK_LABEL

See Also:

Constant Field Values

BOOKMARK_SERVER_BASE_URL

static final String BOOKMARK_SERVER_BASE_URL

See Also:

Constant Field Values

BOOKMARK_FOOTER_TEXT

static final String BOOKMARK_FOOTER_TEXT

See Also:

Constant Field Values

Method Detail

retrieveMailTemplateFromReference

IStorageResource retrieveMailTemplateFromReference(IContext context,
                                                   String templateRef)

Retrieve a mailTemplate resource in the data universe of the Platform management application from its reference

Parameters:

context - the current context

templateRef - the template's reference

Returns:

the mailTemplate resource

buildMailTemplate

IMailTemplate buildMailTemplate(String language,
                                IResource resource,
                                Map<String,Object> parameters)

Build a Mail template object form a given resource and pa map parameter The template is translated in the current user language, and all the bookmarks are replaced from the map parameters

Parameters:

language - the given language

resource - the given resource

parameters - the parameters to replace the bookmarks

Returns:

the template

retrieveMailTemplateSubject

String retrieveMailTemplateSubject(String language,
                                   IResource template)

Retrieve the subject of a mail template Choose the default value if it is not overrides

Parameters:

language - the language to display

template - the mail template resource

Returns:

the subject translated

retrieveMailTemplateContent

String retrieveMailTemplateContent(String language,
                                   IResource template)

Retrieve the content of a mail template Choose the default value if it is not override

Parameters:

language - the language to display

template - the mail template resource

Returns:

the content translated

updateMailTemplateSubject

void updateMailTemplateSubject(String language,
                               IResource template,
                               String newValue)

Update the subject of a mail template Choose the default value if it is not override

Parameters:

language - the language to update

template - the mail template resource

newValue - the new value

updateMailTemplateContent

void updateMailTemplateContent(String language,
                               IResource template,
                               String newValue)

Update the content of a mail template Choose the default value if it is not override

Parameters:

language - the language to update

template - the mail template resource

newValue - the new value