Package io.mailtrap.api.inbound
Interface InboundInboxes
- All Known Implementing Classes:
InboundInboxesImpl
public interface InboundInboxes
Interface representing the Mailtrap Inbound Email API for managing inboxes
within a folder.
-
Method Summary
Modifier and TypeMethodDescriptioncreate(long folderId, CreateInboundInboxRequest request) Create a new inbound inbox in a folder.voiddelete(long folderId, long inboxId) Delete an inbound inbox.getById(long folderId, long inboxId) Get an inbound inbox by ID.getList(long folderId) List all inboxes in an inbound folder.update(long folderId, long inboxId, UpdateInboundInboxRequest request) Rename an inbound inbox.
-
Method Details
-
getList
List all inboxes in an inbound folder.- Parameters:
folderId- the folder ID- Returns:
- the list of inboxes
-
getById
Get an inbound inbox by ID.- Parameters:
folderId- the folder IDinboxId- the inbox ID- Returns:
- the inbox
-
create
Create a new inbound inbox in a folder.- Parameters:
folderId- the folder IDrequest- the create request- Returns:
- the created inbox
-
update
Rename an inbound inbox.- Parameters:
folderId- the folder IDinboxId- the inbox IDrequest- the update request- Returns:
- the updated inbox
-
delete
void delete(long folderId, long inboxId) Delete an inbound inbox.- Parameters:
folderId- the folder IDinboxId- the inbox ID
-