Skip to main content

Search all mailboxes - Gmail with polling

This Playbook is part of the Gmail Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.5.0 and later.

This playbook searches Gmail records for all Google users. It is intended for large companies with over 2500 Google users.


This playbook uses the following sub-playbooks, integrations, and scripts.


Search in mailboxes Gmail (Loop) with polling


This playbook does not use any integrations.




This playbook does not use any commands.

Playbook Inputs#

NameDescriptionDefault ValueRequired
afterSearch for messages sent after a specific date. For example, 2018/05/06Optional
beforeSearch for messages sent before a specific date. For example, 2018/05/09Optional
fieldsEnables partial responses to be retrieved in a comma-separated list. For more information, see\#PartialResponse.Optional
filenameAttachments with a certain name or file type. For example, "pdf" or "report.pdf"Optional
fromSpecifies the sender. For example, "john"Optional
toSpecifies the receiver. For example, "john"Optional
has-attachmentsWhether to search for messages sent with attachments.Optional
inMessages in any folder, including Spam and Trash. For example, shoppingOptional
include-spam-trashIncludes messages from SPAM and TRASH in the results. (Default: false)Optional
labels-idsReturns messages with labels that match all of the specified label IDs in a comma-separated list.Optional
subjectWords in the subject line. For example, "alert"Optional
queryReturns messages matching the specified query. Supports the same query format as the Gmail search box. For example, " rfc822msgid: is:unread". For more syntax information,see ""Optional

Playbook Outputs#

Gmail.MailboxesThe Gmail mailbox.unknown
Gmail.IDThe inner ID of the Gmail message.unknown
Gmail.ThreadIdThe thread ID.unknown
Gmail.FormatThe MIME type of the email.unknown
Gmail.LabelsThe labels of a specific email.unknown
Gmail.ToThe email address of the receiver.unknown
Gmail.FromThe email address of the sender.unknown
Gmail.CcThe additional recipient email address (CC).unknown
Gmail.BccThe additional recipient email address (BCC).unknown
Gmail.SubjectThe subject of the specific email.unknown
Gmail.BodyThe content of the email.unknown
Gmail.AttachmentsThe attachments of the email. IDs are separated by commas.unknown
Gmail.HeadersAll headers of a specific mail (list).unknown

Playbook Image#

Search all mailboxes - Gmail with polling