nylas/com.nylas.resources/Rules

Rules

public final class Rules extends Resource<Rule>

Nylas Rules API

The Nylas Rules API allows you to create and manage rules for Nylas Agent Accounts. Rules filter inbound mail or restrict outbound sends based on conditions and actions.

Parameters

client

The configured Nylas API client

Constructors

Rules

public Rules Rules(NylasClient client)

Functions

create

@JvmOverloads()

public final Response<Rule> create(CreateRuleRequest requestBody)

@JvmOverloads()

public final Response<Rule> create(CreateRuleRequest requestBody, RequestOverrides overrides)

Create a rule.

destroy

@JvmOverloads()

public final DeleteResponse destroy(String ruleId)

@JvmOverloads()

public final DeleteResponse destroy(String ruleId, RequestOverrides overrides)

Delete a rule.

find

@JvmOverloads()

public final Response<Rule> find(String ruleId)

@JvmOverloads()

public final Response<Rule> find(String ruleId, RequestOverrides overrides)

Return a rule.

list

@JvmOverloads()

public final ListResponse<Rule> list()

@JvmOverloads()

public final ListResponse<Rule> list(ListRulesQueryParams queryParams)

@JvmOverloads()

public final ListResponse<Rule> list(ListRulesQueryParams queryParams, RequestOverrides overrides)

Return all rules for your application.

listEvaluations

@JvmOverloads()

public final ListResponse<RuleEvaluation> listEvaluations(String grantId)

@JvmOverloads()

public final ListResponse<RuleEvaluation> listEvaluations(String grantId, ListRuleEvaluationsQueryParams queryParams)

@JvmOverloads()

public final ListResponse<RuleEvaluation> listEvaluations(String grantId, ListRuleEvaluationsQueryParams queryParams, RequestOverrides overrides)

Return rule evaluation audit records for a grant.

update

@JvmOverloads()

public final Response<Rule> update(String ruleId, UpdateRuleRequest requestBody)

@JvmOverloads()

public final Response<Rule> update(String ruleId, UpdateRuleRequest requestBody, RequestOverrides overrides)

Update a rule.