Package com.axemble.vdoc.sdk.utils
Interface IMailUtils
public interface IMailUtils
IMailUtils
Use this utils to manipulate mails and mails' templates through Process
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionBuild 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 parametersretrieveMailTemplateContent
(String language, IResource template) Retrieve the content of a mail template Choose the default value if it is not overrideretrieveMailTemplateFromReference
(IContext context, String templateRef) Retrieve a mailTemplate resource in the data universe of the Platform management application from its referenceretrieveMailTemplateSubject
(String language, IResource template) Retrieve the subject of a mail template Choose the default value if it is not overridesvoid
updateMailTemplateContent
(String language, IResource template, String newValue) Update the content of a mail template Choose the default value if it is not overridevoid
updateMailTemplateSubject
(String language, IResource template, String newValue) Update the subject of a mail template Choose the default value if it is not override
-
Field Details
-
BOOKMARK_USER
- See Also:
-
BOOKMARK_LOGO
- See Also:
-
BOOKMARK_SUBJECT
- See Also:
-
BOOKMARK_CONTENT
- See Also:
-
BOOKMARK_DETAILS
- See Also:
-
BOOKMARK_LINK_LABEL
- See Also:
-
BOOKMARK_LINK
- See Also:
-
BOOKMARK_PRIMARY_COLOR
- See Also:
-
BOOKMARK_BASE_LINK_COLOR
- See Also:
-
BOOKMARK_DIRECT_LINK_LABEL
- See Also:
-
BOOKMARK_SERVER_BASE_URL
- See Also:
-
BOOKMARK_FOOTER_TEXT
- See Also:
-
-
Method Details
-
retrieveMailTemplateFromReference
Retrieve a mailTemplate resource in the data universe of the Platform management application from its reference- Parameters:
context
- the current contexttemplateRef
- the template's reference- Returns:
- the mailTemplate resource
-
buildMailTemplate
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 languageresource
- the given resourceparameters
- the parameters to replace the bookmarks- Returns:
- the template
-
retrieveMailTemplateSubject
Retrieve the subject of a mail template Choose the default value if it is not overrides- Parameters:
language
- the language to displaytemplate
- the mail template resource- Returns:
- the subject translated
-
retrieveMailTemplateContent
Retrieve the content of a mail template Choose the default value if it is not override- Parameters:
language
- the language to displaytemplate
- the mail template resource- Returns:
- the content translated
-
updateMailTemplateSubject
Update the subject of a mail template Choose the default value if it is not override- Parameters:
language
- the language to updatetemplate
- the mail template resourcenewValue
- the new value
-
updateMailTemplateContent
Update the content of a mail template Choose the default value if it is not override- Parameters:
language
- the language to updatetemplate
- the mail template resourcenewValue
- the new value
-