Package io.mailtrap.api.contactlists

Interface ContactLists

All Known Implementing Classes:
ContactListsImpl
public interface ContactLists

  • Method Details

    • findAll

      List<ContactListResponse> findAll(long accountId)
      Get all contact lists existing in account
      Parameters:
      accountId - unique account ID
      Returns:
      contacts list

    • findAll

      List<ContactListResponse> findAll(long accountId, ListContactListsQueryParams queryParams)
      Get all contact lists existing in account, optionally filtered by name.
      Parameters:
      accountId - unique account ID
      queryParams - additional query parameters. The search value filters contact lists by name using a case-insensitive prefix match
      Returns:
      contacts list

    • createContactList

      ContactListResponse createContactList(long accountId, ContactListRequest request)
      Create new Contact List
      Parameters:
      accountId - unique account ID
      request - body
      Returns:
      created contact list

    • getContactList

      ContactListResponse getContactList(long accountId, long contactListId)
      Get a contact list by ID
      Parameters:
      accountId - unique account ID
      contactListId - unique contact list ID
      Returns:
      found contact list

    • updateContactList

      ContactListResponse updateContactList(long accountId, long contactListId, ContactListRequest request)
      Update existing Contact List
      Parameters:
      accountId - unique account ID
      contactListId - unique contact list ID
      request - body
      Returns:
      updated contact list

    • deleteContactList

      void deleteContactList(long accountId, long contactListId)
      Delete existing Contact List
      Parameters:
      accountId - unique account ID
      contactListId - unique contact list ID