Package io.mailtrap.api.contactlists

Class ContactListsImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.contactlists.ContactListsImpl

All Implemented Interfaces:

ContactLists

public class ContactListsImpl
extends ApiResource
implements ContactLists

Field Summary

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

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
ContactListsImpl(MailtrapConfig config)

Method Summary

Modifier and Type	Method	Description
ContactListResponse	createContactList(long accountId, ContactListRequest request)	Create new Contact List
void	deleteContactList(long accountId, long contactListId)	Delete existing Contact List
List<ContactListResponse>	findAll(long accountId)	Get all contact lists existing in account
List<ContactListResponse>	findAll(long accountId, @NonNull ListContactListsQueryParams queryParams)	Get all contact lists existing in account, optionally filtered by name.
ContactListResponse	getContactList(long accountId, long contactListId)	Get a contact list by ID
ContactListResponse	updateContactList(long accountId, long contactListId, ContactListRequest request)	Update existing Contact List

Methods inherited from class java.lang.Object

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

Constructor Details

ContactListsImpl

public ContactListsImpl(MailtrapConfig config)

Method Details

findAll

public List<ContactListResponse> findAll(long accountId)

Description copied from interface: ContactLists

Get all contact lists existing in account

Specified by:

findAll in interface ContactLists

Parameters:

accountId - unique account ID

Returns:

contacts list

findAll

public List<ContactListResponse> findAll(long accountId,
 @NonNull
 @NonNull ListContactListsQueryParams queryParams)

Description copied from interface: ContactLists

Get all contact lists existing in account, optionally filtered by name.

Specified by:

findAll in interface ContactLists

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

public ContactListResponse createContactList(long accountId,
 ContactListRequest request)

Description copied from interface: ContactLists

Create new Contact List

Specified by:

createContactList in interface ContactLists

Parameters:

accountId - unique account ID

request - body

Returns:

created contact list

getContactList

public ContactListResponse getContactList(long accountId,
 long contactListId)

Description copied from interface: ContactLists

Get a contact list by ID

Specified by:

getContactList in interface ContactLists

Parameters:

accountId - unique account ID

contactListId - unique contact list ID

Returns:

found contact list

updateContactList

public ContactListResponse updateContactList(long accountId,
 long contactListId,
 ContactListRequest request)

Description copied from interface: ContactLists

Update existing Contact List

Specified by:

updateContactList in interface ContactLists

Parameters:

accountId - unique account ID

contactListId - unique contact list ID

request - body

Returns:

updated contact list

deleteContactList

public void deleteContactList(long accountId,
 long contactListId)

Description copied from interface: ContactLists

Delete existing Contact List

Specified by:

deleteContactList in interface ContactLists

Parameters:

accountId - unique account ID

contactListId - unique contact list ID