Package io.mailtrap.api.projects

Interface Projects

All Known Implementing Classes:
ProjectsImpl
public interface Projects
Interface representing the Mailtrap Testing API for interaction with projects

  • Method Details

    • createProject

      ProjectsResponse createProject(long accountId, CreateUpdateProjectRequest request)
      Create a project
      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

      List<ProjectsResponse> getProjects(long accountId)
      List projects and their inboxes to which the API token has access.
      Parameters:
      accountId - unique account ID
      Returns:
      the list of projects with nested inboxes. permissions returns the permissions of the token for the project

    • getProject

      ProjectsResponse getProject(long accountId, long projectId)
      Get the project and its inboxes
      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

      ProjectsResponse updateProject(long accountId, long projectId, CreateUpdateProjectRequest updateRequest)
      Update project data
      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

      DeleteProjectResponse deleteProject(long accountId, long projectId)
      Delete project and its inboxes
      Parameters:
      accountId - unique account ID
      projectId - unique project ID
      Returns:
      id of the deleted project