Package io.mailtrap.api.inbound
Interface InboundForwardRules
- All Known Implementing Classes:
InboundForwardRulesImpl
public interface InboundForwardRules
Interface representing the Mailtrap Inbound Email API for managing forward rules.
-
Method Summary
Modifier and TypeMethodDescriptioncreate(long inboxId, CreateInboundForwardRuleRequest request) Create a new forward rule.voiddelete(long inboxId, long ruleId) Delete a forward rule.getById(long inboxId, long ruleId) Get a forward rule by ID.getList(long inboxId) List forward rules in an inbox.update(long inboxId, long ruleId, UpdateInboundForwardRuleRequest request) Update a forward rule.
-
Method Details
-
getList
List forward rules in an inbox.- Parameters:
inboxId- the inbox ID- Returns:
- the list of forward rules
-
getById
Get a forward rule by ID.- Parameters:
inboxId- the inbox IDruleId- the forward rule ID- Returns:
- the forward rule
-
create
Create a new forward rule.- Parameters:
inboxId- the inbox IDrequest- the create request- Returns:
- the created forward rule
-
update
Update a forward rule.- Parameters:
inboxId- the inbox IDruleId- the forward rule IDrequest- the update request- Returns:
- the updated forward rule
-
delete
void delete(long inboxId, long ruleId) Delete a forward rule.- Parameters:
inboxId- the inbox IDruleId- the forward rule ID
-