Gmail

Gmail API and user management (This integration replaces the Gmail functionality in the GoogleApps API and G Suite integration).

Category

Email

Pack

Gmail

Configuration parameters

• adminEmail — Email of user with admin privileges (required)
• query — Events search query
• queryUserKey — Events user key
• gappsID — Immutable Google Apps ID
• isFetch — Fetch incidents
• insecure — Trust any certificate (not secure)
• proxy — Use system proxy settings
• incidentType — Incident type
• incidentFetchInterval — Incidents Fetch Interval
• fetch_time — First fetch timestamp, in days.
• fetch_limit — Maximum number of emails to pull per fetch
• legacy_name — Use legacy attachment name

Commands (35)

• gmail-add-delete-filter — Adds a rule for email deletion by address.
• gmail-add-filter — Adds a new filter.
• gmail-create-user — Creates a new Gmail user.
• gmail-delegate-user-mailbox — Adds a delegate to the mailbox, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user and must be added using their primary email address, and not an email alias.
• gmail-delete-mail — Deletes an email in the user's mailbox.
• gmail-delete-user — Deletes a Gmail user.
• gmail-forwarding-address-add — Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. The special value "me" can be used to indicate the authenticated user.
• gmail-forwarding-address-get — Gets the specified forwarding address or a list of the forwarding addresses for the specified account.
• gmail-forwarding-address-list — Lists the forwarding addresses for the specified account.
• gmail-forwarding-address-remove — Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.
• gmail-forwarding-address-update — Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
• gmail-get-attachments — Retrieves attachments from a sent Gmail message.
• gmail-get-autoreply — Returns the auto-reply message set for the user-account.
• gmail-get-mail — Retrieves the Gmail message sent to a specified user.
• gmail-get-role — Gets details of a specific role.
• gmail-get-thread — Returns all messages in a thread.
• gmail-get-tokens-for-user — Lists all tokens associated with a specified user.
• gmail-get-user — Gets information for a specified user.
• gmail-get-user-roles — Retrieves a list of all Google roles for a specified user.
• gmail-hide-user-in-directory — Hides a user's contact information in the Global Directory, for example email address and profile information.
• gmail-list-filters — Lists all filters in a user's mailbox.
• gmail-list-labels — Lists all labels in the user's mailbox.
• gmail-list-users — Lists all Google users in a domain.
• gmail-move-mail — Moves an email to a different folder.
• gmail-move-mail-to-mailbox — Moves an email to a different mailbox.
• gmail-remove-delegated-mailbox — Removes a delegate from the mailbox without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user using their primary email address, and not an email alias.
• gmail-remove-filter — Removes a Filter.
• gmail-revoke-user-role — Revokes a role for a specified Google user.
• gmail-search — Searches for Gmail records for a specific Google user.
• gmail-search-all-mailboxes — Searches the Gmail records for all Google users. (For more than 2500 accounts, use with the `Search all mailboxes - Gmail with polling` playbook).
• gmail-send-as-add — Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This command is only available to service account clients who have been delegated domain-wide authority.
• gmail-set-autoreply — Sets the auto-reply for the user. Note: If the body is not set, the current body will be deleted.
• gmail-set-password — Sets the password for the user.
• reply-mail — Replies to a mail using Gmail.
• send-mail — Sends mail using Gmail.