com.atlassian.jira.mail

Interface MailTemplatesService

All Known Implementing Classes:

DefaultMailTemplatesService

@ExperimentalApi
public interface MailTemplatesService

Interface to work with email templates files Intended to work with both: single and batched emails Used in REST API plugin to create a possibility to change email templates

Since:

v8.14

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Void>	applyEmailTemplates() If the temporary folder with email templates is present, it will replace the production templates with temporary ones
ServiceOutcome<File>	getEmailTemplatesZip() Returns a zip file of the templates folder used for single notifications email.
ServiceOutcome<Void>	revertEmailTemplatesToDefault() Replaces all currently used templates (stored in Shared Jira Home) with default templates.
ServiceOutcome<Void>	uploadEmailTemplates(InputStream templatesStream) Saves a stream to disk and unzips it's content to the temporary templates folder.

Method Detail

uploadEmailTemplates

ServiceOutcome<Void> uploadEmailTemplates(InputStream templatesStream)

Saves a stream to disk and unzips it's content to the temporary templates folder. Then performs validation to check existence of root templates.

Returns:

Valid ServiceOutcome when templates were unzipped and all root files exists Invalid ServiceOutcome with errors otherwise

applyEmailTemplates

ServiceOutcome<Void> applyEmailTemplates()

If the temporary folder with email templates is present, it will replace the production templates with temporary ones

Returns:

Valid ServiceOutcome when templates replaced Invalid ServiceOutcome with errors otherwise

getEmailTemplatesZip

ServiceOutcome<File> getEmailTemplatesZip()

Returns a zip file of the templates folder used for single notifications email.

Returns:

Zipped file of templates folder.

revertEmailTemplatesToDefault

ServiceOutcome<Void> revertEmailTemplatesToDefault()

Replaces all currently used templates (stored in Shared Jira Home) with default templates. If templates were modified then all changes will be overridden.

Returns:

Valid ServiceOutcome when templates replaced Invalid ServiceOutcome with errors otherwise