Skip to main content
Glama

gmail.users.messages.insert

Inserts a raw or JSON-formatted email message directly into a user's Gmail mailbox without sending it, similar to IMAP APPEND and bypassing most scanning.

Instructions

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. For more information, see Create and send email messages [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting classificationLabelValues, historyId, id, internalDate, labelIds, payload, raw, sizeEstimate and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, list, modify, send, trash, untrash.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
userIdYes[URL path segment] The user's email address. The special value `me` can be used to indicate the authenticated user.me
deletedNo[query parameter] Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.false
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON Message object.
request_bodyNoRequest body of type Message: pass it via `params` (merged into the built body) or whole via `body_file`.
internalDateSourceNo[query parameter] Source for Gmail's internal date of the message. Values: `receivedTime` = Internal message date set to current time when received by Gmail.; `dateHeader` = Internal message time based on 'Date' header in email, when valid..receivedTime

Output Schema

NameRequiredDescriptionDefault
idNo
rawNo
payloadNo
snippetNo
labelIdsNo
threadIdNo
historyIdNo
internalDateNo
sizeEstimateNo
classificationLabelValuesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / body_file / description
      Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON Message object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type Message: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "classificationLabelValues": {
      +      "items": {
      +        "properties": {
      +          "fields": {
      +            "items": {
      +              "properties": {
      +                "fieldId": {
      +                  "type": "string"
      +                },
      +                "selection": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "labelId": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "historyId": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "internalDate": {
      +      "type": "string"
      +    },
      +    "labelIds": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "payload": {
      +      "properties": {
      +        "body": {
      +          "properties": {
      +            "attachmentId": {
      +              "type": "string"
      +            },
      +            "data": {
      +              "type": "string"
      +            },
      +            "size": {
      +              "type": "integer"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "filename": {
      +          "type": "string"
      +        },
      +        "headers": {
      +          "items": {
      +            "properties": {
      +              "name": {
      +                "type": "string"
      +              },
      +              "value": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "mimeType": {
      +          "type": "string"
      +        },
      +        "partId": {
      +          "type": "string"
      +        },
      +        "parts": {
      +          "items": {
      +            "properties": {
      +              "body": {
      +                "properties": {
      +                  "attachmentId": {
      +                    "type": "string"
      +                  },
      +                  "data": {
      +                    "type": "string"
      +                  },
      +                  "size": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "filename": {
      +                "type": "string"
      +              },
      +              "headers": {
      +                "items": {
      +                  "properties": {
      +                    "name": {
      +                      "type": "string"
      +                    },
      +                    "value": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "mimeType": {
      +                "type": "string"
      +              },
      +              "partId": {
      +                "type": "string"
      +              },
      +              "parts": {
      +                "items": {
      +                  "properties": {
      +                    "body": {
      +                      "type": "object"
      +                    },
      +                    "filename": {
      +                      "type": "string"
      +                    },
      +                    "headers": {
      +                      "items": {
      +                        "type": "object"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "mimeType": {
      +                      "type": "string"
      +                    },
      +                    "partId": {
      +                      "type": "string"
      +                    },
      +                    "parts": {
      +                      "items": {
      +                        "type": "object"
      +                      },
      +                      "type": "array"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "raw": {
      +      "type": "string"
      +    },
      +    "sizeEstimate": {
      +      "type": "integer"
      +    },
      +    "snippet": {
      +      "type": "string"
      +    },
      +    "threadId": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed7 schema fields changed
    • addedInput schema / properties / deleted / default
      Added value: +"false"
    • changedInput schema / properties / deleted / description
      Previous value: -"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts."New value: +"[query parameter] Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts."
    • addedInput schema / properties / internalDateSource / default
      Added value: +"receivedTime"
    • changedInput schema / properties / internalDateSource / description
      Previous value: -"Source for Gmail's internal date of the message."New value: +"[query parameter] Source for Gmail's internal date of the message. Values: `receivedTime` = Internal message date set to current time when received by Gmail.; `dateHeader` = Internal message time based on 'Date' header in email, when valid.."
    • addedInput schema / properties / userId / default
      Added value: +"me"
    • changedInput schema / properties / userId / description
      Previous value: -"The user's email address. The special value `me` can be used to indicate the authenticated user."New value: +"[URL path segment] The user's email address. The special value `me` can be used to indicate the authenticated user."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "classificationLabelValues": {
      +      "items": {
      +        "properties": {
      +          "fields": {
      +            "items": {
      +              "properties": {
      +                "fieldId": {
      +                  "type": "string"
      +                },
      +                "selection": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "labelId": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "historyId": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "internalDate": {
      +      "type": "string"
      +    },
      +    "labelIds": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "payload": {
      +      "properties": {
      +        "body": {
      +          "properties": {
      +            "attachmentId": {
      +              "type": "string"
      +            },
      +            "data": {
      +              "type": "string"
      +            },
      +            "size": {
      +              "type": "integer"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "filename": {
      +          "type": "string"
      +        },
      +        "headers": {
      +          "items": {
      +            "properties": {
      +              "name": {
      +                "type": "string"
      +              },
      +              "value": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "mimeType": {
      +          "type": "string"
      +        },
      +        "partId": {
      +          "type": "string"
      +        },
      +        "parts": {
      +          "items": {
      +            "properties": {
      +              "body": {
      +                "properties": {
      +                  "attachmentId": {
      +                    "type": "string"
      +                  },
      +                  "data": {
      +                    "type": "string"
      +                  },
      +                  "size": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "filename": {
      +                "type": "string"
      +              },
      +              "headers": {
      +                "items": {
      +                  "properties": {
      +                    "name": {
      +                      "type": "string"
      +                    },
      +                    "value": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "mimeType": {
      +                "type": "string"
      +              },
      +              "partId": {
      +                "type": "string"
      +              },
      +              "parts": {
      +                "items": {
      +                  "properties": {
      +                    "body": {
      +                      "type": "object"
      +                    },
      +                    "filename": {
      +                      "type": "string"
      +                    },
      +                    "headers": {
      +                      "items": {
      +                        "type": "object"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "mimeType": {
      +                      "type": "string"
      +                    },
      +                    "partId": {
      +                      "type": "string"
      +                    },
      +                    "parts": {
      +                      "items": {
      +                        "type": "object"
      +                      },
      +                      "type": "array"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "raw": {
      +      "type": "string"
      +    },
      +    "sizeEstimate": {
      +      "type": "integer"
      +    },
      +    "snippet": {
      +      "type": "string"
      +    },
      +    "threadId": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full behavioral burden and discloses important traits: it bypasses most scanning/classification, does not send, performs an HTTP POST that creates or triggers a change, and is refused under --readonly safety profiles. It does not cover auth scopes, size limits, or rate-limit behavior, which keeps it from a 5.

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

Conciseness3/5

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

The opening sentences are front-loaded and useful, but the latter portion becomes a run-on that includes redundant return information despite an output schema and a raw list of sibling tools without selection guidance. The phrase 'and 2 more fields' is imprecise and does not earn its place.

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

Completeness4/5

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

Given the complex nested request body, full schema coverage, and an output schema, the description provides enough context about purpose, side effects, body handling, and sibling tools. It could be more complete by explicitly routing between insert, import, and send, but the essential information for invocation is present.

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 description coverage is 100%, so the schema already documents all eight parameters, including body fields and the query parameters. The description adds a body-field summary and repeats that the body can be passed via `params` or `body_file`, but this largely duplicates the schema and does not add new parameter semantics.

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?

The description states a specific verb and resource: 'Directly inserts a message into only this user's mailbox similar to IMAP APPEND.' It also explicitly distinguishes the operation from sending: 'Does not send a message,' which helps separate it from siblings such as gmail.users.messages.send.

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?

The description clearly establishes when this tool is appropriate by comparing it to IMAP APPEND and stating it does not send a message. It also hints at the distinction from import by noting it bypasses most scanning and classification, though it does not explicitly say 'use import instead when...' or name the exact alternative conditions.

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