Method: users.messages.import

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.

Note: This function doesn't trigger forwarding rules or filters set up by the user.

HTTP request

  • Upload URI, for media upload requests:
    POST https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/messages/import
  • Metadata URI, for metadata-only requests:
    POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/import

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

The user's email address. The special value me can be used to indicate the authenticated user.

Query parameters

Parameters
internalDateSource

enum (InternalDateSource)

Source for Gmail's internal date of the message.
neverMarkSpam

boolean

Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
processForCalendar

boolean

Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
deleted

boolean

Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.

Request body

The request body contains an instance of Message.

Response body

If successful, the response body contains an instance of Message.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.insert

For more information, see the OAuth 2.0 Overview.