Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt

Use this file to discover all available pages before exploring further.

Transfert

Gérer les règles et adresses de transfert. Les exemples utilisent le mode code A2A. MCP expose le même mode code via son outil execute.

Fonctions

forwarding.activate

forwarding.activate(account_id: str, forwarding_id: str, active: bool) -> ForwardingRule
Transfert: forwarding.activate.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/active
NomTypeRequis
account_idstroui
forwarding_idstroui
activebooloui
ChampTypeRequis
activebooloui
created_atstroui
idstroui
scope_idstroui
scope_type"account" | "workspace" | "domain"oui
target_emailstroui
updated_atstroui
verification_requiredbooloui
verification_state"internal" | "pending" | "verified" | "expired"oui
verification_expires_atstr | nullnon
verification_sent_atstr | nullnon
verification_verified_atstr | nullnon
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.activate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", active=true)"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.activate",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.activate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", active=true)"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.activate\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

forwarding.add

forwarding.add(account_id: str, target_email: str, domain?: str | null, workspace_id?: str | null) -> ForwardingRule
Transfert: forwarding.add.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/forwarding
NomTypeRequis
account_idstroui
target_emailstroui
domainstr | nullnon
workspace_idstr | nullnon
ChampTypeRequis
activebooloui
created_atstroui
idstroui
scope_idstroui
scope_type"account" | "workspace" | "domain"oui
target_emailstroui
updated_atstroui
verification_requiredbooloui
verification_state"internal" | "pending" | "verified" | "expired"oui
verification_expires_atstr | nullnon
verification_sent_atstr | nullnon
verification_verified_atstr | nullnon
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\", domain=\"example.com\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.add",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\", domain=\"example.com\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.add\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

forwarding.delete

forwarding.delete(account_id: str, forwarding_id: str) -> {}
Transfert: forwarding.delete.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiqueDELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id}
NomTypeRequis
account_idstroui
forwarding_idstroui
ChampTypeRequis
result{}oui
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

forwarding.list

forwarding.list(account_id: str, page?: int, page_size?: int) -> Page[ForwardingRule]
Transfert: forwarding.list.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.viewAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.view
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiqueGET /v1/public/accounts/{account_id}/forwarding
NomTypeRequis
account_idstroui
pageintnon
page_sizeintnon
ChampTypeRequis
items[{"active": bool, "created_at": str, "id": str, "scope_id": str, "scope_type": "account" | "workspace" | "domain", "target_email": str, "updated_at": str, "verification_required": bool, "verification_state": "internal" | "pending" | "verified" | "expired", "verification_expires_at"?: str | null, "verification_sent_at"?: str | null, "verification_verified_at"?: str | null}]oui
pageintoui
page_sizeintoui
totalintoui
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.list",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.list\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

forwarding.update

forwarding.update(account_id: str, forwarding_id: str, target_email: str) -> ForwardingRule
Transfert: forwarding.update.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}
NomTypeRequis
account_idstroui
forwarding_idstroui
target_emailstroui
ChampTypeRequis
activebooloui
created_atstroui
idstroui
scope_idstroui
scope_type"account" | "workspace" | "domain"oui
target_emailstroui
updated_atstroui
verification_requiredbooloui
verification_state"internal" | "pending" | "verified" | "expired"oui
verification_expires_atstr | nullnon
verification_sent_atstr | nullnon
verification_verified_atstr | nullnon
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.update",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\")"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.update\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

forwarding.verification.confirm

forwarding.verification.confirm(account_id: str, forwarding_id: str, code: str) -> ForwardingRule
Transfert: forwarding.verification.confirm.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirm
NomTypeRequis
account_idstroui
forwarding_idstroui
codestroui
ChampTypeRequis
verifiedbooloui
forwarding_idstr | nullnon
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.verification.confirm(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", code=\"<string>\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.verification.confirm",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.verification.confirm(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", code=\"<string>\")"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.verification.confirm\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

forwarding.verification.send

forwarding.verification.send(account_id: str, forwarding_id: str) -> ForwardingRule
Transfert: forwarding.verification.send.
PropriétéValeurPropriétéValeur
Autorisation requiseforwarding.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitéforwarding.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/send
NomTypeRequis
account_idstroui
forwarding_idstroui
ChampTypeRequis
cooldown_secondsintoui
sentbooloui
expires_atstr | nullnon
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.verification.send(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.verification.send",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.verification.send(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Réponse:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.verification.send\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}