Package org.apache.fineract.infrastructure.campaigns.email.api

Class EmailApiResource

java.lang.Object

org.apache.fineract.infrastructure.campaigns.email.api.EmailApiResource

@Path("/v1/email")
@Consumes("application/json")
@Produces("application/json")
@Component
public class EmailApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
EmailApiResource()

Method Summary

Modifier and Type	Method	Description
String	create(String apiRequestBodyAsJson)
String	delete(Long resourceId)
String	retrieveAllEmailByStatus(Integer offset, Integer limit, Integer status, String orderBy, String sortOrder, org.apache.fineract.infrastructure.core.api.DateParam fromDateParam, org.apache.fineract.infrastructure.core.api.DateParam toDateParam, String locale, String rawDateFormat, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveAllEmails(jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveFailedEmail(Integer offset, Integer limit, String orderBy, String sortOrder, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(Long resourceId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrievePendingEmail(Integer offset, Integer limit, String orderBy, String sortOrder, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveSentEmail(Integer offset, Integer limit, String orderBy, String sortOrder, jakarta.ws.rs.core.UriInfo uriInfo)
String	update(Long resourceId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmailApiResource

public EmailApiResource()

Method Details

retrieveAllEmails

@GET
public String retrieveAllEmails(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrievePendingEmail

@GET
@Path("pendingEmail")
public String retrievePendingEmail(@QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveSentEmail

@GET
@Path("sentEmail")
public String retrieveSentEmail(@QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveAllEmailByStatus

@GET
@Path("messageByStatus")
public String retrieveAllEmailByStatus(@QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("status")
 Integer status,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @QueryParam("fromDate")
 org.apache.fineract.infrastructure.core.api.DateParam fromDateParam,
 @QueryParam("toDate")
 org.apache.fineract.infrastructure.core.api.DateParam toDateParam,
 @QueryParam("locale")
 String locale,
 @QueryParam("dateFormat")
 String rawDateFormat,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveFailedEmail

@GET
@Path("failedEmail")
public String retrieveFailedEmail(@QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

create

@POST
public String create(String apiRequestBodyAsJson)

retrieveOne

@GET
@Path("{resourceId}")
public String retrieveOne(@PathParam("resourceId")
 Long resourceId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

update

@PUT
@Path("{resourceId}")
public String update(@PathParam("resourceId")
 Long resourceId,
 String apiRequestBodyAsJson)

delete

@DELETE
@Path("{resourceId}")
public String delete(@PathParam("resourceId")
 Long resourceId)