@Path(value="mailTemplates") public interface MailTemplateService extends JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
create(@NotNull MailTemplateTO mailTemplateTO)
Creates a new mail template.
|
void |
delete(@NotNull String key)
Deletes the mail template matching the given key.
|
javax.ws.rs.core.Response |
getFormat(@NotNull String key,
@NotNull MailTemplateFormat format)
Gets the template for the given key and format, if available.
|
List<MailTemplateTO> |
list()
Returns a list of all mail templates.
|
MailTemplateTO |
read(@NotNull String key)
Returns mail template with matching key.
|
void |
removeFormat(@NotNull String key,
@NotNull MailTemplateFormat format)
Removes the template for the given key and format, if available.
|
void |
setFormat(@NotNull String key,
@NotNull MailTemplateFormat format,
InputStream templateIn)
Sets the template for the given key and format, if available.
|
@GET @Produces(value={"application/json","application/yaml","application/xml"}) List<MailTemplateTO> list()
@POST @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response create(@NotNull @NotNull MailTemplateTO mailTemplateTO)
mailTemplateTO
- Creates a new mail template.@GET @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) MailTemplateTO read(@NotNull @PathParam(value="key") @NotNull String key)
key
- key of mail template to be read@DELETE @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam(value="key") @NotNull String key)
key
- key for mail template to be deleted@GET @Path(value="{key}/{format}") javax.ws.rs.core.Response getFormat(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="format") @NotNull MailTemplateFormat format)
key
- mail templateformat
- template format@PUT @Path(value="{key}/{format}") @Produces(value={"application/json","application/yaml","application/xml"}) void setFormat(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="format") @NotNull MailTemplateFormat format, InputStream templateIn)
key
- mail templateformat
- template formattemplateIn
- template to be set@DELETE @Path(value="{key}/{format}") @Produces(value={"application/json","application/yaml","application/xml"}) void removeFormat(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="format") @NotNull MailTemplateFormat format)
key
- mail templateformat
- template formatCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.