com.mailgun.api.v3

Interface MailgunTemplatesApi

All Superinterfaces:

MailgunApi

public interface MailgunTemplatesApi
extends MailgunApi

Templates Api.

This API allows you to store predefined templates and use them to send messages using the Sending API.

The API has the following limitations:

 100 templates per domain
 10 versions per template
 100Kb max template size
 

See Also:

Templates

Method Summary

Modifier and Type	Method and Description
TemplateWithMessageResponse	createNewTemplateVersion(String domain, String templateName, TemplateVersionRequest request) Create a new version of a template.
feign.Response	createNewTemplateVersionFeignResponse(String domain, String templateName, TemplateVersionRequest request) Create a new version of a template.
ResponseWithMessage	deleteAllTemplatesInDomain(String domain) Delete all stored templates for the domain.
feign.Response	deleteAllTemplatesInDomainFeignResponse(String domain) Delete all stored templates for the domain.
TemplateVersionResponse	deleteSpecificTemplateVersion(String domain, String templateName, String templateVersion) Delete a specific version of the template.
feign.Response	deleteSpecificTemplateVersionFeignResponse(String domain, String templateName, String templateVersion) Delete a specific version of the template.
TemplateStatusResponse	deleteTemplate(String domain, String name) Delete the template.
feign.Response	deleteTemplateFeignResponse(String domain, String name) Delete the template.
TemplateWithVersionResponse	getActiveTemplateVersionContent(String domain, String name) Returns the content of the active version of the template with metadata information.
feign.Response	getActiveTemplateVersionContentFeignResponse(String domain, String name) Returns the content of the active version of the template with metadata information.
TemplatesResult	getAllTemplates(String domain) Returns a list of stored templates for the domain (limit to 10 entries).
TemplatesResult	getAllTemplates(String domain, PagingWithPivot queryOptions) Returns a list of stored templates for the domain with paging.
feign.Response	getAllTemplatesFeignResponse(String domain) Returns a list of stored templates for the domain (limit to 10 entries).
feign.Response	getAllTemplatesFeignResponse(String domain, PagingWithPivot queryOptions) Returns a list of stored templates for the domain with paging.
TemplateAllVersionsResponse	getAllTemplateVersions(String domain, String templateName) Returns a list of stored versions of the template (limit to 10 entries).
TemplateAllVersionsResponse	getAllTemplateVersions(String domain, String templateName, PagingWithPivot queryOptions) Returns a list of stored versions of the template.
feign.Response	getAllTemplateVersionsFeignResponse(String domain, String templateName) Returns a list of stored versions of the template (limit to 10 entries).
feign.Response	getAllTemplateVersionsFeignResponse(String domain, String templateName, PagingWithPivot queryOptions) Returns a list of stored versions of the template.
TemplateWithVersionResponse	getSpecifiedVersionTemplateContent(String domain, String templateName, String tag) Retrieve information and content of specified version of the template.
feign.Response	getSpecifiedVersionTemplateContentFeignResponse(String domain, String templateName, String tag) Retrieve information and content of specified version of the template.
TemplateResponse	getTemplate(String domain, String name) Returns metadata information about a stored template.
feign.Response	getTemplateFeignResponse(String domain, String name) Returns metadata information about a stored template.
TemplateWithMessageResponse	storeNewTemplate(String domain, TemplateRequest request) This API stores a new template, including its name, description and (optionally) the template content.
feign.Response	storeNewTemplateFeignResponse(String domain, TemplateRequest request) This API stores a new template, including its name, description and (optionally) the template content.
TemplateVersionResponse	updateSpecificTemplateVersion(String domain, String templateName, String tag, UpdateTemplateVersionRequest request) Update information or content of the specific version of the template.
feign.Response	updateSpecificTemplateVersionFeignResponse(String domain, String templateName, String tag, UpdateTemplateVersionRequest request) Update information or content of the specific version of the template.
TemplateStatusResponse	updateTemplate(String domain, String name, String description) Update the metadata information of the template.
feign.Response	updateTemplateFeignResponse(String domain, String name, String description) Update the metadata information of the template.

Methods inherited from interface com.mailgun.api.MailgunApi

getApiVersion

Method Detail

getAllTemplates

TemplatesResult getAllTemplates(String domain)

Returns a list of stored templates for the domain (limit to 10 entries).

Parameters:

domain - Name of the domain

Returns:

TemplatesResult

getAllTemplatesFeignResponse

feign.Response getAllTemplatesFeignResponse(String domain)

Returns a list of stored templates for the domain (limit to 10 entries).

Parameters:

domain - Name of the domain

Returns:

Response

getAllTemplates

TemplatesResult getAllTemplates(String domain,
                                PagingWithPivot queryOptions)

Returns a list of stored templates for the domain with paging.

Parameters:

domain - Name of the domain

queryOptions - PagingWithPivot

Returns:

TemplatesResult

getAllTemplatesFeignResponse

feign.Response getAllTemplatesFeignResponse(String domain,
                                            PagingWithPivot queryOptions)

Returns a list of stored templates for the domain with paging.

Parameters:

domain - Name of the domain

queryOptions - PagingWithPivot

Returns:

Response

getTemplate

TemplateResponse getTemplate(String domain,
                             String name)

Returns metadata information about a stored template.

Parameters:

domain - Name of the domain

name - Name of the template

Returns:

TemplateResponse

getTemplateFeignResponse

feign.Response getTemplateFeignResponse(String domain,
                                        String name)

Returns metadata information about a stored template.

Parameters:

domain - Name of the domain

name - Name of the template

Returns:

Response

getActiveTemplateVersionContent

TemplateWithVersionResponse getActiveTemplateVersionContent(String domain,
                                                            String name)

Returns the content of the active version of the template with metadata information.

Parameters:

domain - Name of the domain

name - Name of the template

Returns:

TemplateWithVersionResponse

getActiveTemplateVersionContentFeignResponse

feign.Response getActiveTemplateVersionContentFeignResponse(String domain,
                                                            String name)

Returns the content of the active version of the template with metadata information.

Parameters:

domain - Name of the domain

name - Name of the template

Returns:

Response

storeNewTemplate

TemplateWithMessageResponse storeNewTemplate(String domain,
                                             TemplateRequest request)

This API stores a new template, including its name, description and (optionally) the template content.

If the template content is provided, a new version is automatically created and becomes the active version.

Parameters:

domain - Name of the domain

request - TemplateRequest

Returns:

TemplateWithMessageResponse

storeNewTemplateFeignResponse

feign.Response storeNewTemplateFeignResponse(String domain,
                                             TemplateRequest request)

This API stores a new template, including its name, description and (optionally) the template content.

If the template content is provided, a new version is automatically created and becomes the active version.

Parameters:

domain - Name of the domain

request - TemplateRequest

Returns:

Response

updateTemplate

TemplateStatusResponse updateTemplate(String domain,
                                      String name,
                                      String description)

Update the metadata information of the template.

Parameters:

domain - Name of the domain

name - Name of the template

description - Updated description of the template

Returns:

TemplateStatusResponse

updateTemplateFeignResponse

feign.Response updateTemplateFeignResponse(String domain,
                                           String name,
                                           String description)

Update the metadata information of the template.

Parameters:

domain - Name of the domain

name - Name of the template

description - Updated description of the template

Returns:

Response

deleteTemplate

TemplateStatusResponse deleteTemplate(String domain,
                                      String name)

Delete the template.

NOTE: This method deletes all versions of the specified template.

Parameters:

domain - Name of the domain

name - Name of the template

Returns:

TemplateStatusResponse

deleteTemplateFeignResponse

feign.Response deleteTemplateFeignResponse(String domain,
                                           String name)

Delete the template.

NOTE: This method deletes all versions of the specified template.

Parameters:

domain - Name of the domain

name - Name of the template

Returns:

Response

deleteAllTemplatesInDomain

ResponseWithMessage deleteAllTemplatesInDomain(String domain)

Delete all stored templates for the domain.

Parameters:

domain - Name of the domain

Returns:

ResponseWithMessage

deleteAllTemplatesInDomainFeignResponse

feign.Response deleteAllTemplatesInDomainFeignResponse(String domain)

Delete all stored templates for the domain.

Parameters:

domain - Name of the domain

Returns:

Response

getAllTemplateVersions

TemplateAllVersionsResponse getAllTemplateVersions(String domain,
                                                   String templateName)

Returns a list of stored versions of the template (limit to 10 entries).

Parameters:

domain - Name of the domain

templateName - Name of the template

Returns:

TemplateAllVersionsResponse

getAllTemplateVersionsFeignResponse

feign.Response getAllTemplateVersionsFeignResponse(String domain,
                                                   String templateName)

Returns a list of stored versions of the template (limit to 10 entries).

Parameters:

domain - Name of the domain

templateName - Name of the template

Returns:

Response

getAllTemplateVersions

TemplateAllVersionsResponse getAllTemplateVersions(String domain,
                                                   String templateName,
                                                   PagingWithPivot queryOptions)

Returns a list of stored versions of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

queryOptions - PagingWithPivot

Returns:

TemplateAllVersionsResponse

getAllTemplateVersionsFeignResponse

feign.Response getAllTemplateVersionsFeignResponse(String domain,
                                                   String templateName,
                                                   PagingWithPivot queryOptions)

Returns a list of stored versions of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

queryOptions - PagingWithPivot

Returns:

Response

getSpecifiedVersionTemplateContent

TemplateWithVersionResponse getSpecifiedVersionTemplateContent(String domain,
                                                               String templateName,
                                                               String tag)

Retrieve information and content of specified version of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

tag - Tag of the template version

Returns:

TemplateWithVersionResponse

getSpecifiedVersionTemplateContentFeignResponse

feign.Response getSpecifiedVersionTemplateContentFeignResponse(String domain,
                                                               String templateName,
                                                               String tag)

Retrieve information and content of specified version of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

tag - Tag of the template version

Returns:

Response

createNewTemplateVersion

TemplateWithMessageResponse createNewTemplateVersion(String domain,
                                                     String templateName,
                                                     TemplateVersionRequest request)

Create a new version of a template. If the template does not contain any other versions, the first version becomes active.

Parameters:

domain - Name of the domain

templateName - Name of the template

request - TemplateVersionRequest

Returns:

TemplateWithMessageResponse

createNewTemplateVersionFeignResponse

feign.Response createNewTemplateVersionFeignResponse(String domain,
                                                     String templateName,
                                                     TemplateVersionRequest request)

Create a new version of a template. If the template does not contain any other versions, the first version becomes active.

Parameters:

domain - Name of the domain

templateName - Name of the template

request - TemplateVersionRequest

Returns:

Response

updateSpecificTemplateVersion

TemplateVersionResponse updateSpecificTemplateVersion(String domain,
                                                      String templateName,
                                                      String tag,
                                                      UpdateTemplateVersionRequest request)

Update information or content of the specific version of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

tag - Tag of the template version

request - UpdateTemplateVersionRequest

Returns:

TemplateVersionResponse

updateSpecificTemplateVersionFeignResponse

feign.Response updateSpecificTemplateVersionFeignResponse(String domain,
                                                          String templateName,
                                                          String tag,
                                                          UpdateTemplateVersionRequest request)

Update information or content of the specific version of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

tag - Tag of the template version

request - UpdateTemplateVersionRequest

Returns:

Response

deleteSpecificTemplateVersion

TemplateVersionResponse deleteSpecificTemplateVersion(String domain,
                                                      String templateName,
                                                      String templateVersion)

Delete a specific version of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

templateVersion - Template version tag

Returns:

TemplateVersionResponse

deleteSpecificTemplateVersionFeignResponse

feign.Response deleteSpecificTemplateVersionFeignResponse(String domain,
                                                          String templateName,
                                                          String templateVersion)

Delete a specific version of the template.

Parameters:

domain - Name of the domain

templateName - Name of the template

templateVersion - Template version tag

Returns:

Response