Package io.mailtrap.api.contacts

Interface Contacts

All Known Implementing Classes:

ContactsImpl

public interface Contacts

Method Summary

Modifier and Type	Method	Description
CreateContactResponse	createContact(long accountId, CreateContactRequest request)	Create a new contact
void	deleteContact(long accountId, String idOrEmail)	Delete contact using id or email (URL encoded)
GetContactResponse	getContact(long accountId, String idOrEmail)	Get contact using id or email (URL encoded)
UpdateContactResponse	updateContact(long accountId, String idOrEmail, UpdateContactRequest request)	Update contact using id or email (URL encoded)

Method Details

createContact

CreateContactResponse createContact(long accountId,
 CreateContactRequest request)

Create a new contact

Parameters:

accountId - unique account ID

request - required contact data

Returns:

created contact

getContact

GetContactResponse getContact(long accountId,
 String idOrEmail)

Get contact using id or email (URL encoded)

Parameters:

accountId - unique account ID

idOrEmail - contact ID or Email

Returns:

contact details

deleteContact

void deleteContact(long accountId,
 String idOrEmail)

Delete contact using id or email (URL encoded)

Parameters:

accountId - unique account ID

idOrEmail - contact ID or Email

updateContact

UpdateContactResponse updateContact(long accountId,
 String idOrEmail,
 UpdateContactRequest request)

Update contact using id or email (URL encoded)

Parameters:

accountId - unique account ID

idOrEmail - contact ID or Email

request - request body