Sha256: 73cb7637956fea9906099f88e815bda6b1d37d2052d2c30e015a2ebdfae3ba35

Contents?: true

Size: 1.26 KB

Versions: 4

Compression:

Stored size: 1.26 KB

Contents

# Rules Actions

Details on the various actions that can be performed on the Rules resource, including the expected parameters and the potential responses.

##### Contents

*   [CreateRule](#createrule)
*   [EnableRule](#enablerule)
*   [DisableRule](#disablerule)
*   [GetAllRules](#getallrules)
*   [GetRule](#getrule)
*   [DeleteRule](#deleterule)

<br/>

## CreateRule

Creates a Rule

```ruby
result = client.rules.create_rule(
  domainId: my_domain_id,
  ruleToPost: my_rule_to_post
)

puts result
```

<br/>

## EnableRule

Enables an existing Rule

```ruby
result = client.rules.enable_rule(
  domainId: my_domain_id
  ruleId: my_rule_id)

puts result
```

<br/>

## DisableRule

Disables an existing Rule

```ruby
result = client.rules.disable_rule(
  domainId: my_domain_id
  ruleId: my_rule_id)

puts result
```

<br/>

## GetAllRules

Fetches all Rules for a Domain

```ruby
result = client.rules.get_all_rules(domainId: my_domain_id)

puts result
```

<br/>

## GetRule

Fetches a specific rule for a Domain

```ruby
result = client.rules.get_rule(
  domainId: my_domain_id
  ruleId: my_rule_id)

puts result
```

<br/>

## DeleteRule

Deletes a specific rule for a Domain

```ruby
result = client.rules.delete_rule(
  domainId: my_domain_id
  ruleId: my_rule_id)

puts result
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
mailinator_client-1.0.4 docs/rules.md
mailinator_client-1.0.3 docs/rules.md
mailinator_client-1.0.2 docs/rules.md
mailinator_client-1.0.1 docs/rules.md