---
title: "client.traffic"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://nextmail.sh/docs/ruby/reference/traffic"
area: "Ruby"
category: "Reference"
---

# client.traffic

Every method in this namespace: its signature, its parameters, what it returns and an example.

## Methods

What happened to every message at the edge of the workspace: where the mail that arrived for your addresses went, and what the receiving server said about the mail you sent.

### `traffic.list`

List one page of the traffic log

```ruby
list(domain_id: nil, direction: nil, outcomes: nil, address: nil, recipient: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::Page
```

Returns one page of the traffic log, newest first: one entry for each message and recipient at each step it took in or out of the workspace. `list_all` collects every page and `iterate` walks them lazily.

Inbound, each recipient of a message that arrived gets an entry saying where it went: `filed` in the inbox, `spam`, `routed` to a webhook, `forwarded` without a copy kept, `refused` with a bounce back to the sender, or `dropped` without one, and `reason` says why mail was refused or dropped. Outbound, each recipient of a message you sent or forwarded gets an entry for each answer from the receiving server: `delivered`, `deferred` while it keeps trying, `bounced`, `complained`, `suppressed` when it was never tried, `rejected` when it was refused before it left, and `failed` for a forward that could not be relayed.

An entry never changes once it is written, and the same step keeps the same id. Entries are kept for 30 days. `detail` holds the reply of the receiving server and `remoteMta`, `reportingMta` and `sendingIp` the servers on each side, and inbound entries carry the SPF, DKIM, DMARC, spam and virus `verdicts` the message arrived with.

Scopes: `emails:read`.

**Parameters**

- `domain_id` (`String`): Keeps one domain, by the id `domains.list` returns. A domain the key does not reach is a 404.
- `direction` (`String`): `inbound` for mail that arrived, `outbound` for mail the workspace sent or forwarded. Left out, both, as far as the key's scopes reach. `Nextmail::TRAFFIC_DIRECTIONS` holds the values.
- `outcomes` (`Array<String>`): Keeps these outcomes, such as `["bounced", "deferred"]`. `Nextmail::TRAFFIC_OUTCOMES` holds the values.
- `address` (`String`): Keeps one of your addresses: the one the mail arrived for, or the one it was sent from.
- `recipient` (`String`): Keeps one recipient, matched whole: the person you wrote to on an outbound entry, the address in the envelope on an inbound one.
- `since` (`Time, DateTime, Date or String`): Keeps entries at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
- `until` (`Time, DateTime, Date or String`): Keeps entries before this instant. It must be later than `since`.
- `limit` (`Integer`): Page size, from 1 to 100. The server defaults to 25.
- `cursor` (`String`): The `next_cursor` of the previous page. Leave it out for the first page.
- `api_key` (`String`): Overrides the client API key for this call only.

**Returns**

The `Nextmail::Page` of Hashes, with `items`, `has_more?` and `next_cursor`. Each item has `direction`, `outcome`, `reason`, `status`, `detail`, `sender`, `recipient`, `address`, `domain`, the ids of the email and thread it belongs to, the servers on each side, `verdicts`, `size` and `createdAt`.

**Example**

```ruby
page = client.traffic.list(direction: "outbound", outcomes: ["bounced", "deferred"], since: Time.now - 86_400)

page.items.each { |entry| puts [entry[:createdAt], entry[:recipient], entry[:outcome], entry[:detail]].join(" ") }
```

**Notes**

- Outbound entries need `emails:read` and inbound ones `threads:read`. A key with only one of them sees that direction alone, and asking for the other `direction` is a 403 `insufficient_scope`.
- A key or an app narrowed to particular addresses or domains sees the entries of the addresses it reaches and, for a whole domain it holds, every entry of that domain, including mail for addresses that do not exist.
- The sender and the reply are stored encrypted, so they cannot be searched. Filter by `address`, `recipient`, `outcomes`, `direction`, `domain_id` and the time.
- The cursor is opaque and holds where the last row sat. A cursor this list did not hand out is a 400 `invalid_cursor`.

Also available in: API [`GET /traffic`](https://nextmail.sh/docs/api/reference/traffic#get-traffic); TypeScript [`traffic.list()`](https://nextmail.sh/docs/sdk/reference/traffic#list); Python [`traffic.list()`](https://nextmail.sh/docs/python/reference/traffic#list); PHP [`traffic->list`](https://nextmail.sh/docs/php/reference/traffic#list); Go [`Traffic.List`](https://nextmail.sh/docs/go/reference/traffic#list); Java [`traffic().list`](https://nextmail.sh/docs/java/reference/traffic#list); C# [`Traffic.ListAsync`](https://nextmail.sh/docs/csharp/reference/traffic#list); CLI [`nextmail traffic list`](https://nextmail.sh/docs/cli/reference/traffic#traffic-list).

### `traffic.list_all`

Collect the traffic log into one array

```ruby
list_all(domain_id: nil, direction: nil, outcomes: nil, address: nil, recipient: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>
```

Walks every page of `list` and returns every entry that matches in one Array, newest first. One request per page, with the same filters on each, so narrow it with `since`, `domain_id` or `outcomes` before collecting a busy workspace.

Scopes: `emails:read`.

**Parameters**

- `domain_id` (`String`): Keeps one domain, by the id `domains.list` returns. A domain the key does not reach is a 404.
- `direction` (`String`): `inbound` for mail that arrived, `outbound` for mail the workspace sent or forwarded. Left out, both, as far as the key's scopes reach. `Nextmail::TRAFFIC_DIRECTIONS` holds the values.
- `outcomes` (`Array<String>`): Keeps these outcomes, such as `["bounced", "deferred"]`. `Nextmail::TRAFFIC_OUTCOMES` holds the values.
- `address` (`String`): Keeps one of your addresses: the one the mail arrived for, or the one it was sent from.
- `recipient` (`String`): Keeps one recipient, matched whole: the person you wrote to on an outbound entry, the address in the envelope on an inbound one.
- `since` (`Time, DateTime, Date or String`): Keeps entries at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
- `until` (`Time, DateTime, Date or String`): Keeps entries before this instant. It must be later than `since`.
- `limit` (`Integer`): Page size for each request, from 1 to 100. The server defaults to 25.
- `cursor` (`String`): Starts the walk after this cursor instead of the first page.
- `api_key` (`String`): Overrides the client API key for every page of this walk.

**Returns**

An Array of Hashes holding every matching entry, each with the fields `list` returns.

**Example**

```ruby
bounced = client.traffic.list_all(outcomes: ["bounced"], since: "2026-10-01T00:00:00Z", limit: 100)

puts bounced.map { |entry| entry[:recipient] }.uniq
```

**Notes**

- If any page fails, the error is raised and the entries already fetched are discarded.
- Outbound entries need `emails:read` and inbound ones `threads:read`, as on `list`.

Also available in: API [`GET /traffic`](https://nextmail.sh/docs/api/reference/traffic#get-traffic); TypeScript [`traffic.listAll()`](https://nextmail.sh/docs/sdk/reference/traffic#listAll); Python [`traffic.list_all()`](https://nextmail.sh/docs/python/reference/traffic#listAll); PHP [`traffic->listAll`](https://nextmail.sh/docs/php/reference/traffic#listAll); Go [`Traffic.ListAll`](https://nextmail.sh/docs/go/reference/traffic#listAll); Java [`traffic().listAll`](https://nextmail.sh/docs/java/reference/traffic#listAll); C# [`Traffic.ListAllAsync`](https://nextmail.sh/docs/csharp/reference/traffic#listAll).

### `traffic.iterate`

Stream the traffic log one entry at a time

```ruby
iterate(domain_id: nil, direction: nil, outcomes: nil, address: nil, recipient: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>
```

Returns an Enumerator that yields one entry at a time, newest first, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests. Given a block, it yields each entry to the block instead.

Scopes: `emails:read`.

**Parameters**

- `domain_id` (`String`): Keeps one domain, by the id `domains.list` returns. A domain the key does not reach is a 404.
- `direction` (`String`): `inbound` for mail that arrived, `outbound` for mail the workspace sent or forwarded. Left out, both, as far as the key's scopes reach. `Nextmail::TRAFFIC_DIRECTIONS` holds the values.
- `outcomes` (`Array<String>`): Keeps these outcomes, such as `["bounced", "deferred"]`. `Nextmail::TRAFFIC_OUTCOMES` holds the values.
- `address` (`String`): Keeps one of your addresses: the one the mail arrived for, or the one it was sent from.
- `recipient` (`String`): Keeps one recipient, matched whole: the person you wrote to on an outbound entry, the address in the envelope on an inbound one.
- `since` (`Time, DateTime, Date or String`): Keeps entries at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
- `until` (`Time, DateTime, Date or String`): Keeps entries before this instant. It must be later than `since`.
- `limit` (`Integer`): Page size for each request, from 1 to 100. The server defaults to 25.
- `cursor` (`String`): Starts the walk after this cursor instead of the first page.
- `api_key` (`String`): Overrides the client API key for every page of this walk.

**Returns**

An Enumerator of Hashes, one entry per step (or yields each one to a block).

**Example**

```ruby
client.traffic.iterate(direction: "inbound", outcomes: ["refused", "dropped"]) do |entry|
  puts [entry[:recipient], entry[:reason], entry[:detail]].join(" ")
end
```

**Notes**

- The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
- Outbound entries need `emails:read` and inbound ones `threads:read`, as on `list`.

Also available in: API [`GET /traffic`](https://nextmail.sh/docs/api/reference/traffic#get-traffic); TypeScript [`traffic.iterate()`](https://nextmail.sh/docs/sdk/reference/traffic#iterate); Python [`traffic.iterate()`](https://nextmail.sh/docs/python/reference/traffic#iterate); PHP [`traffic->iterate`](https://nextmail.sh/docs/php/reference/traffic#iterate); Go [`Traffic.Iterate`](https://nextmail.sh/docs/go/reference/traffic#iterate); Java [`traffic().iterate`](https://nextmail.sh/docs/java/reference/traffic#iterate); C# [`Traffic.IterateAsync`](https://nextmail.sh/docs/csharp/reference/traffic#iterate).