Skip to main content
Glama
Sendmux

Sendmux Email Inbox API + Sending

Official
by Sendmux
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Hybrid

Get Mailbox Changes

mailbox_get_changes
Read-onlyIdempotent

Resume mailbox synchronization from a saved cursor to retrieve only new changes to messages, folders, threads, and more. Avoid ad hoc searches by using state cursors for efficient incremental updates.

Instructions

Use this to resume mailbox sync from a prior state cursor. Do not use it for ad hoc message search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum change records to return (default 50, max 500).
typesNoComma-separated list: messages, folders, threads, submissions, identities, quotas.
mailbox_idNoMailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
since_stateNoLegacy message state cursor to resume from.
quotas_since_stateNoQuota state cursor to resume from.
folders_since_stateNoFolder state cursor to resume from.
threads_since_stateNoThread state cursor to resume from.
messages_since_stateNoMessage state cursor to resume from.
identities_since_stateNoIdentity state cursor to resume from.
submissions_since_stateNoSubmission state cursor to resume from.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.0.8
    • addedOutput schema / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -true
    • addedOutput schema / properties
      Added value: +{
+  "result": {
+    "anyOf": [
+      {
+        "allOf": [
+          {
+            "properties": {
+              "meta": {
+                "additionalProperties": {},
+                "properties": {},
+                "type": "object"
+              },
+              "ok": {
+                "enum": [
+                  true
+                ],
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "ok",
+              "meta"
+            ],
+            "type": "object"
+          },
+          {
+            "properties": {
+              "data": {
+                "additionalProperties": false,
+                "properties": {
+                  "created": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "destroyed": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "has_more": {
+                    "type": "boolean"
+                  },
+                  "new_state": {
+                    "type": "string"
+                  },
+                  "old_state": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "sync_required": {
+                    "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                    "type": "boolean"
+                  },
+                  "updated": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "updated_properties": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  }
+                },
+                "required": [
+                  "old_state",
+                  "new_state",
+                  "has_more",
+                  "created",
+                  "updated",
+                  "destroyed"
+                ],
+                "type": "object"
+              },
+              "meta": {
+                "additionalProperties": false,
+                "properties": {
+                  "request_id": {
+                    "example": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx",
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "request_id"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "data"
+            ],
+            "type": "object"
+          }
+        ],
+        "unevaluatedProperties": {
+          "not": {}
+        }
+      },
+      {
+        "allOf": [
+          {
+            "properties": {
+              "meta": {
+                "additionalProperties": {},
+                "properties": {},
+                "type": "object"
+              },
+              "ok": {
+                "enum": [
+                  true
+                ],
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "ok",
+              "meta"
+            ],
+            "type": "object"
+          },
+          {
+            "properties": {
+              "data": {
+                "additionalProperties": false,
+                "properties": {
+                  "types": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "folders": {
+                        "additionalProperties": false,
+                        "properties": {
+                          "created": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "destroyed": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "has_more": {
+                            "type": "boolean"
+                          },
+                          "new_state": {
+                            "type": "string"
+                          },
+                          "old_state": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          },
+                          "sync_required": {
+                            "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                            "type": "boolean"
+                          },
+                          "updated": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "updated_properties": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "old_state",
+                          "new_state",
+                          "has_more",
+                          "created",
+                          "updated",
+                          "destroyed"
+                        ],
+                        "type": "object"
+                      },
+                      "identities": {
+                        "additionalProperties": false,
+                        "properties": {
+                          "created": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "destroyed": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "has_more": {
+                            "type": "boolean"
+                          },
+                          "new_state": {
+                            "type": "string"
+                          },
+                          "old_state": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          },
+                          "sync_required": {
+                            "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                            "type": "boolean"
+                          },
+                          "updated": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "updated_properties": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "old_state",
+                          "new_state",
+                          "has_more",
+                          "created",
+                          "updated",
+                          "destroyed"
+                        ],
+                        "type": "object"
+                      },
+                      "messages": {
+                        "additionalProperties": false,
+                        "properties": {
+                          "created": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "destroyed": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "has_more": {
+                            "type": "boolean"
+                          },
+                          "new_state": {
+                            "type": "string"
+                          },
+                          "old_state": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          },
+                          "sync_required": {
+                            "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                            "type": "boolean"
+                          },
+                          "updated": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "updated_properties": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "old_state",
+                          "new_state",
+                          "has_more",
+                          "created",
+                          "updated",
+                          "destroyed"
+                        ],
+                        "type": "object"
+                      },
+                      "quotas": {
+                        "additionalProperties": false,
+                        "properties": {
+                          "created": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "destroyed": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "has_more": {
+                            "type": "boolean"
+                          },
+                          "new_state": {
+                            "type": "string"
+                          },
+                          "old_state": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          },
+                          "sync_required": {
+                            "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                            "type": "boolean"
+                          },
+                          "updated": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "updated_properties": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "old_state",
+                          "new_state",
+                          "has_more",
+                          "created",
+                          "updated",
+                          "destroyed"
+                        ],
+                        "type": "object"
+                      },
+                      "submissions": {
+                        "additionalProperties": false,
+                        "properties": {
+                          "created": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "destroyed": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "has_more": {
+                            "type": "boolean"
+                          },
+                          "new_state": {
+                            "type": "string"
+                          },
+                          "old_state": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          },
+                          "sync_required": {
+                            "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                            "type": "boolean"
+                          },
+                          "updated": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "updated_properties": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "old_state",
+                          "new_state",
+                          "has_more",
+                          "created",
+                          "updated",
+                          "destroyed"
+                        ],
+                        "type": "object"
+                      },
+                      "threads": {
+                        "additionalProperties": false,
+                        "properties": {
+                          "created": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "destroyed": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "has_more": {
+                            "type": "boolean"
+                          },
+                          "new_state": {
+                            "type": "string"
+                          },
+                          "old_state": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          },
+                          "sync_required": {
+                            "description": "When true, refetch this resource list instead of applying the incremental arrays.",
+                            "type": "boolean"
+                          },
+                          "updated": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          },
+                          "updated_properties": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "old_state",
+                          "new_state",
+                          "has_more",
+                          "created",
+                          "updated",
+                          "destroyed"
+                        ],
+                        "type": "object"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "required": [
+                  "types"
+                ],
+                "type": "object"
+              },
+              "meta": {
+                "additionalProperties": false,
+                "properties": {
+                  "request_id": {
+                    "example": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx",
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "request_id"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "data"
+            ],
+            "type": "object"
+          }
+        ],
+        "unevaluatedProperties": {
+          "not": {}
+        }
+      }
+    ]
+  }
+}
    • addedOutput schema / required
      Added value: +[
+  "result"
+]
  2. First observedv1.0.0

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already carry the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false), so the description only needs to add context beyond that. It adds the cursor-based sync mechanism but does not describe return behavior or cursor-format expectations; output schema covers the return shape, so 3 is appropriate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with zero waste. The primary use case is front-loaded, and the exclusion follows immediately. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 10 optional parameters including 7 distinct cursor types (since_state vs. type-specific *_since_state), the description is thin. It does not explain how the legacy since_state relates to messages_since_state, folders_since_state, etc. — a genuine gap an agent could trip on. Output schema and 100% schema coverage offset this somewhat, but the multi-cursor complexity warrants more guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% — all 10 parameters have individual descriptions in the input schema, so the baseline of 3 applies. The description adds no parameter-level detail beyond the schema, though its cursor-resume framing helps contextualize the various *_since_state parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific purpose: resume mailbox sync from a prior state cursor. The verb 'resume' plus 'prior state cursor' makes the operation precise, and the explicit exclusion of ad hoc message search differentiates it from siblings like mailbox_list_messages and mailbox_search_message_snippets.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear when-to-use (resuming sync from a cursor) and an explicit when-not-to-use (ad hoc search). However, it does not name the alternative tools to use for ad hoc search, so the agent must infer which sibling handles that case.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools