Interface IContactListResource

Namespace

Mailtrap.ContactLists

Assembly

Mailtrap.Abstractions.dll

Represents contact list resource.

public interface IContactListResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Deletes a contact list, represented by the current resource instance.

Task Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task

Nothing is returned upon successful deletion.

Remarks

After deletion of the contact list, represented by the current resource instance, it will no longer be available.
Thus any further operations on it will result in an error.

GetDetails(CancellationToken)

Gets details of the contact list, represented by the current resource instance.

Task<ContactList> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<ContactList>

Requested contact list details.

Update(ContactListRequest, CancellationToken)

Updates the contact list, represented by the current resource instance, with details specified by request.

Task<ContactList> Update(ContactListRequest request, CancellationToken cancellationToken = default)

Parameters

request ContactListRequest

Contact list details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<ContactList>

Updated contact list details.