Package io.mailtrap.api.projects

Class ProjectsImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.apiresource.ApiResourceWithValidation

io.mailtrap.api.projects.ProjectsImpl

All Implemented Interfaces:

Projects

public class ProjectsImpl
extends ApiResourceWithValidation
implements Projects

Field Summary

Fields inherited from class io.mailtrap.api.apiresource.ApiResourceWithValidation

customValidator

Fields inherited from class io.mailtrap.api.apiresource.ApiResource

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
ProjectsImpl(MailtrapConfig config, CustomValidator customValidator)

Method Summary

Modifier and Type	Method	Description
ProjectsResponse	createProject(long accountId, CreateUpdateProjectRequest request)	Create a project
DeleteProjectResponse	deleteProject(long accountId, long projectId)	Delete project and its inboxes
ProjectsResponse	getProject(long accountId, long projectId)	Get the project and its inboxes
List<ProjectsResponse>	getProjects(long accountId)	List projects and their inboxes to which the API token has access.
ProjectsResponse	updateProject(long accountId, long projectId, CreateUpdateProjectRequest updateRequest)	Update project data

Methods inherited from class io.mailtrap.api.apiresource.ApiResourceWithValidation

validateRequestBodyAndThrowException

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectsImpl

public ProjectsImpl(MailtrapConfig config,
 CustomValidator customValidator)

Method Details

createProject

public ProjectsResponse createProject(long accountId,
 CreateUpdateProjectRequest request)

Description copied from interface: Projects

Create a project

Specified by:

createProject in interface Projects

Parameters:

accountId - unique account ID

request - request data

Returns:

Returns attributes of the created project. permissions returns the permissions of the token for the project

getProjects

public List<ProjectsResponse> getProjects(long accountId)

Description copied from interface: Projects

List projects and their inboxes to which the API token has access.

Specified by:

getProjects in interface Projects

Parameters:

accountId - unique account ID

Returns:

the list of projects with nested inboxes. permissions returns the permissions of the token for the project

getProject

public ProjectsResponse getProject(long accountId,
 long projectId)

Description copied from interface: Projects

Get the project and its inboxes

Specified by:

getProject in interface Projects

Parameters:

accountId - unique account ID

projectId - unique project ID

Returns:

project attributes and inboxes of this project with their attributes. permissions returns the permissions of the token for the project

updateProject

public ProjectsResponse updateProject(long accountId,
 long projectId,
 CreateUpdateProjectRequest updateRequest)

Description copied from interface: Projects

Update project data

Specified by:

updateProject in interface Projects

Parameters:

accountId - unique account ID

projectId - unique project ID

updateRequest - request data

Returns:

project attributes and inboxes of this project with their attributes. permissions returns the permissions of the token for the project

deleteProject

public DeleteProjectResponse deleteProject(long accountId,
 long projectId)

Description copied from interface: Projects

Delete project and its inboxes

Specified by:

deleteProject in interface Projects

Parameters:

accountId - unique account ID

projectId - unique project ID

Returns:

id of the deleted project