category: Email provider: Google sectionorder: - Connect - Collect commonfields: id: Gmail version: -1 configuration: - display: Email of user with admin privileges displaypassword: Service account private key file contents (JSON) additionalinfo: See the Help tab for details on creating a Service Account file. name: adminEmail required: true type: 9 section: Connect - display: Events search query name: query type: 0 additionalinfo: Used for searching emails in the inbox. The query language follows the Gmail query specification. For example, "from:example@demisto.com is:unread". section: Collect defaultvalue: "label:Inbox" required: false - display: Events user key name: queryUserKey type: 0 additionalinfo: Use this to specify the email account to search for messages with the search query. By default, the integration uses the email address specified in the credentials. section: Collect advanced: true required: false - display: Immutable Google Apps ID additionalinfo: See the Help tab for details on the Immutable Google Apps ID. name: gappsID type: 0 section: Connect advanced: true required: false - display: Fetch incidents name: isFetch type: 8 section: Collect required: false supportedModules: - agentix - xsiam - display: Trust any certificate (not secure) name: insecure type: 8 section: Connect advanced: true required: false - display: Use system proxy settings name: proxy type: 8 section: Connect advanced: true required: false - display: Incident type name: incidentType type: 13 section: Connect required: false supportedModules: - agentix - xsiam - display: Incidents Fetch Interval name: incidentFetchInterval defaultvalue: '1' required: false type: 19 section: Collect advanced: true supportedModules: - agentix - xsiam - defaultvalue: 1 days display: First fetch timestamp, in days. name: fetch_time type: 0 section: Collect required: false - display: Maximum number of emails to pull per fetch name: fetch_limit type: 0 defaultvalue: "50" section: Collect additionalinfo: A maximum of 200 emails per fetch (even if a higher number is configured). The default is 50. required: false - display: Use legacy attachment name name: legacy_name section: Collect type: 8 advanced: true defaultvalue: 'false' description: Gmail API and user management (This integration replaces the Gmail functionality in the GoogleApps API and G Suite integration). display: Gmail name: Gmail script: commands: - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true description: Lists all labels in the user's mailbox. name: gmail-list-labels outputs: - contextPath: GmailLabel.UserID description: The UserID the label belongs to. type: String - contextPath: GmailLabel.Name description: The name of the label. type: String - contextPath: GmailLabel.ID description: The label ID. type: String - contextPath: GmailLabel.Type description: The label type. type: String - contextPath: GmailLabel.MessageListVisibility description: The label message list visibility. type: String - contextPath: GmailLabel.LabelListVisibility description: The label list visibility. type: String - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true description: Deletes a Gmail user. name: gmail-delete-user - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true description: Lists all tokens associated with a specified user. name: gmail-get-tokens-for-user - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - auto: PREDEFINED defaultValue: basic description: 'The subset of fields to fetch for the user. Can be: "basic": Do not include any custom fields for the user (default), "custom": Includes custom fields from schemas requested in custom-field-mask, "full": Includes all fields associated with the user.' name: projection predefined: - basic - custom - full - auto: PREDEFINED defaultValue: admin_view description: Whether to fetch the administrator or public view of the user. Can be admin_view (default), which includes both administrator and domain-public fields; or "domain_public", which includes user fields that are publicly visible to other users in the domain. name: view-type-public-domain predefined: - admin_view - domain_public - description: A comma separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. name: custom-field-mask description: Gets information for a specified user. name: gmail-get-user outputs: - contextPath: Account.Type description: The account type. For example, "AD", "LocalOS", "Google", "AppleID", and so on. type: String - contextPath: Account.ID description: The unique ID for the account (integration specific). For AD accounts this is the Distinguished Name (DN). type: String - contextPath: Account.DisplayName description: The display name. type: string - contextPath: Account.Gmail.Address description: The email assigned with the current account. type: string - contextPath: Account.Email.Address description: The email address of the account. type: String - contextPath: Account.Domain description: The domain of the account. type: String - contextPath: Account.Username description: The account username in the relevant system. type: String - contextPath: Account.OrganizationUnit description: The Organization Unit (OU) of the account. type: String - contextPath: Account.Group description: Groups to which the account belongs (integration specific). For example, for AD, these are the groups in which the account is a member. type: String - contextPath: Account.VisibleInDirectory description: Whether the account is visible in the directory. type: Boolean - contextPath: Account.CustomerId description: The customer unique ID. type: String - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true description: Retrieves a list of all Google roles for a specified user. name: gmail-get-user-roles outputs: - contextPath: Gmail.Role.RoleAssignmentId description: The unique ID of the role assignment. type: String - contextPath: Gmail.Role.ScopeType description: The scope type of the role. type: String - contextPath: Gmail.Role.Kind description: The kind of the Role. type: String - contextPath: Gmail.Role.OrgUnitId description: The organization the user was assigned to. type: String - contextPath: Gmail.Role.ID description: The inner role ID. type: String - contextPath: Gmail.Role.AssignedTo description: The user ID who was assigned to the role. type: String - arguments: - description: The ID of the email to retrieve. You can get the ID by running the gmail-search command, or by fetching mails and copy the incident.labels.Email/ID value from the fetched incident context. name: message-id required: true - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true description: Retrieves attachments from a sent Gmail message. name: gmail-get-attachments outputs: - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.Name description: The name of the file. type: String - contextPath: File.SSDeep description: The SSDeep hash of the file (same as displayed in file entries). type: String - contextPath: File.Type description: 'File type, for example: "PE".' type: string - contextPath: File.Size description: File size. type: number - contextPath: File.EntryID description: The EntryID of the file. type: String - contextPath: File.Extension description: 'The file extension. For example: "xls".' type: String - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The ID of the email to retrieve. You can get the ID by running the gmail-search command, or by fetching mails and copy the incident.labels.Email/ID value from the fetched incident context. name: message-id required: true - auto: PREDEFINED defaultValue: full description: 'The format to return the message. Can be: "full": Returns the full email message data with body content parsed in the payload field; the raw field is not used. (default) / "metadata": Returns only the email message ID, labels, and email headers / "minimal": Returns only the email message ID and labels; does not return the email headers, body, or payload / "raw": Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used.' name: format predefined: - full - metadata - minimal - raw - auto: PREDEFINED defaultValue: false description: Whether to include the attachment entries in the result or not. name: include-attachments predefined: - 'False' - 'True' description: Retrieves the Gmail message sent to a specified user. name: gmail-get-mail outputs: - contextPath: Gmail.ID description: The inner ID of the Gmail message. type: String - contextPath: Gmail.ThreadId description: The thread ID. type: string - contextPath: Gmail.Format description: The MIME type of email. type: string - contextPath: Gmail.Labels description: The labels of the specific email. type: string - contextPath: Gmail.To description: The email address of the receiver. type: String - contextPath: Gmail.From description: The email address of the sender. type: String - contextPath: Gmail.Cc description: Additional recipient email address (CC). type: string - contextPath: Gmail.Bcc description: Additional recipient email address (BCC). type: string - contextPath: Gmail.Subject description: The subject of the email. type: string - contextPath: Gmail.Body description: The content of the email. type: string - contextPath: Gmail.Attachments.ID description: The email attachment ID (as appear in gmail). type: Unknown - contextPath: Gmail.Attachments.Name description: The email attachment name. type: Unknown - contextPath: Gmail.Headers description: All headers of the specific email (list). type: unknown - contextPath: Gmail.Mailbox description: The email mailbox. type: string - contextPath: Email.To description: The recipient of the email. type: String - contextPath: Email.From description: The sender of the email. type: String - contextPath: Email.CC description: Additional recipient email address (CC). type: String - contextPath: Email.BCC description: Additional recipient email address (BCC). type: String - contextPath: Email.Format description: The format of the email. type: String - contextPath: Email.Body/HTML description: The HTML version of the email. type: String - contextPath: Email.Body/Text description: The plain-text version of the email. type: String - contextPath: Email.Subject description: The subject of the email. type: String - contextPath: Email.Headers description: The headers of the email. type: String - contextPath: Email.Attachments.ID description: The email attachment ID (as appear in gmail). type: Unknown - contextPath: Email.Attachments.Name description: The email attachment name. type: Unknown - contextPath: Email.Date description: The date the email was received. type: String - contextPath: File.MD5 description: Relevant only when include-attachments is set to True. The MD5 hash of the file. type: String - contextPath: File.SHA1 description: Relevant only when include-attachments is set to True. The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: Relevant only when include-attachments is set to True. The SHA256 hash of the file. type: String - contextPath: File.Name description: Relevant only when include-attachments is set to True. The name of the file. type: String - contextPath: File.SSDeep description: Relevant only when include-attachments is set to True. The SSDeep hash of the file (same as displayed in file entries). type: String - contextPath: File.Type description: 'Relevant only when include-attachments is set to True. File type, for example: "PE".' type: string - contextPath: File.Size description: Relevant only when include-attachments is set to True. File size. type: number - contextPath: File.EntryID description: The EntryID of the file. type: String - contextPath: File.Extension description: 'The file extension. For example: "xls".' type: String - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: 'Returns messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". For more syntax information see "https://support.google.com/mail/answer/7190?hl=en".' name: query - defaultValue: '100' description: The maximum number of results to return. Default is 100. Maximum is 500. Can be 1 to 500, inclusive. name: max-results - description: 'Enables partial responses to be retrieved, separated by commas. Valid fields are only from the following list: Type, Mailbox, ThreadId, Labels, Headers, Attachments, RawData, Format, Subject, From, To, Body, Cc, Bcc, Date, Html, Attachment Names.' isArray: true name: fields - description: Returns messages with labels that match all of the specified label IDs in a comma-separated list. name: labels-ids - description: Page token to retrieve a specific page of results in the list. name: page-token - auto: PREDEFINED defaultValue: 'False' description: 'Include messages from SPAM and TRASH in the results. (Default: false).' name: include-spam-trash predefined: - 'False' - 'True' - description: Specifies the sender. For example, "john". name: from - description: Specifies the receiver. For example, "john". name: to - description: Words in the subject line. For example, "alert". name: subject - description: Attachments with a certain name or file type. For example, "pdf" or "report.pdf". name: filename - description: 'Messages in any folder, including Spam and Trash. For example: shopping.' name: in - description: 'Search for messages sent after a specific date. For example: 2018/05/06.' name: after - description: 'Search for messages sent before a specific date. for example: 2018/05/09.' name: before - auto: PREDEFINED description: Whether to search for messages sent with attachments (boolean value). name: has-attachments predefined: - 'True' - 'False' description: Searches for Gmail records for a specific Google user. name: gmail-search outputs: - contextPath: Gmail.ID description: The inner ID of the Gmail message. type: string - contextPath: Gmail.ThreadId description: The thread ID. type: string - contextPath: Gmail.Format description: The MIME type of email. type: string - contextPath: Gmail.Labels description: The labels of the specific email. type: string - contextPath: Gmail.To description: The email address of the receiver. type: string - contextPath: Gmail.From description: The email address of the sender. type: string - contextPath: Gmail.Cc description: The additional recipient email address (CC). type: string - contextPath: Gmail.Bcc description: The additional recipient email address (BCC). type: string - contextPath: Gmail.Subject description: The subject of the specific email. type: string - contextPath: Gmail.Body description: The content of the email. type: string - contextPath: Gmail.Attachments description: The attachments of the email. Includes ID and Name fields. type: Unknown - contextPath: Gmail.Attachments.ID description: The email attachment ID (as appear in gmail). type: Unknown - contextPath: Gmail.Attachments.Name description: The email attachment name. type: Unknown - contextPath: Gmail.Headers description: All headers of a specific email (list). type: unknown - contextPath: Gmail.Mailbox description: The email mailbox. type: string - contextPath: Email.To description: The recipient of the email. type: String - contextPath: Email.From description: The sender of the email. type: String - contextPath: Email.CC description: The additional recipient email address (CC). type: String - contextPath: Email.BCC description: The additional recipient email address (BCC). type: String - contextPath: Email.Format description: The format of the email. type: String - contextPath: Email.Body/HTML description: The HTML version of the email. type: String - contextPath: Email.Body/Text description: The plain-text version of the email. type: String - contextPath: Email.Subject description: The subject of the email. type: String - contextPath: Email.Headers description: The headers of the email. type: String - contextPath: Email.Attachments.entryID description: Comma-separated email attachment IDs. type: Unknown - contextPath: Email.Date description: The date the email was received. type: String - contextPath: GmailEmails.NextPageToken description: Token to retrieve the next page of results. type: String - arguments: - description: 'Returns messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". For more syntax information,see "https://support.google.com/mail/answer/7190?hl=en".' name: query - defaultValue: '100' description: The maximum number of results to return. Default is 100. Maximum is 500. Can be 1 to 500, inclusive. name: max-results - description: 'Enables partial responses to be retrieved, separated by commas. Valid fields are only from the following list: Type, Mailbox, ThreadId, Labels, Headers, Attachments, RawData, Format, Subject, From, To, Body, Cc, Bcc, Date, Html, Attachment Names.' isArray: true name: fields - description: Returns messages with labels that match all of the specified label IDs in a comma-separated list. name: labels-ids - description: Page token to retrieve a specific page of results in the list. name: page-token - auto: PREDEFINED defaultValue: 'False' description: 'Includes messages from SPAM and TRASH in the results. (Default: false).' name: include-spam-trash predefined: - 'False' - 'True' - description: Specifies the sender. For example, "john". name: from - description: Specifies the receiver. For example, "john". name: to - description: Words in the subject line. For example, "alert". name: subject - description: Attachments with a certain name or file type. For example, "pdf" or "report.pdf". name: filename - description: Messages in any folder, including Spam and Trash. For example, shopping. name: in - description: Search for messages sent after a specific date. For example, 2018/05/06. name: after - description: Search for messages sent before a specific date. For example, 2018/05/09. name: before - auto: PREDEFINED description: Whether to search for messages sent with attachments. name: has-attachments predefined: - 'False' - 'True' - auto: PREDEFINED defaultValue: true description: Whether to return only mailboxes which contain the email. Default is "True". name: show-only-mailboxes predefined: - "false" - "true" - description: Accounts to search in. name: list_accounts - description: Used to track search progress. name: search_from - description: Used to track search progress. name: search_to description: Searches the Gmail records for all Google users. (For more than 2500 accounts, use with the `Search all mailboxes - Gmail with polling` playbook). polling: true name: gmail-search-all-mailboxes outputs: - contextPath: Gmail.ID description: The inner ID of the Gmail message. type: string - contextPath: Gmail.ThreadId description: The thread ID. type: string - contextPath: Gmail.Format description: The MIME type of the email. type: string - contextPath: Gmail.Labels description: The labels of a specific email. type: string - contextPath: Gmail.To description: The email address of the receiver. type: string - contextPath: Gmail.From description: The email address of the sender. type: string - contextPath: Gmail.Cc description: The additional recipient email address (CC). type: string - contextPath: Gmail.Bcc description: The additional recipient email address (BCC). type: string - contextPath: Gmail.Subject description: The subject of the specific email. type: string - contextPath: Gmail.Body description: The content of the email. type: string - contextPath: Gmail.Attachments description: The attachments of the email. IDs are separated by commas. type: unknown - contextPath: Gmail.Headers description: All headers of a specific mail (list). type: unknown - contextPath: Gmail.Mailboxes description: The Gmail mailboxes in which emails matching the query were found. type: String - contextPath: Gmail.UnsearchedAcounts description: A list of accounts that were not searched due to an error accessing them. type: String - contextPath: PageToken.NextPageToken description: Fetches the next list of accounts that will be searched. type: String - contextPath: SearchFromAccountIndex description: A search is performed from an account index (Enables the search process to be followed). type: String - contextPath: SearchToAccountIndex description: A search is performed to an account index (Enables the search process to be followed). type: String - contextPath: Email.To description: The recipient of the email. type: String - contextPath: Email.From description: The sender of the email. type: String - contextPath: Email.CC description: The additional recipient email address (CC). type: String - contextPath: Email.BCC description: The additional recipient email address (BCC). type: String - contextPath: Email.Format description: The format of the email. type: String - contextPath: Email.Body/HTML description: The HTML version of the email. type: String - contextPath: Email.Body/Text description: The plain-text version of the email. type: String - contextPath: Email.Subject description: The subject of the email. type: String - contextPath: Email.Headers description: The headers of the email. type: String - contextPath: Email.Attachments.entryID description: Email Attachments. IDs are separated by commas. type: Unknown - contextPath: Email.Date description: The date the email was received. type: String - arguments: - auto: PREDEFINED description: 'The subset of fields to fetch for the user. Can be "basic": Do not include any custom fields for the user. (default), "custom": Include custom fields from schemas requested in customFieldMask, "full": Include all fields associated with this user.' name: projection predefined: - basic - custom - full - default: true description: The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter. name: domain - description: The unique ID for the customer's Google account. Default is the value specified in the integration configuration. For a multi-domain account, to fetch all groups for a customer, use this field instead of domain. name: customer - description: Maximum number of results to return. Default is 100. Maximum is 500. Can be 1 to 500, inclusive. name: max-results - description: A comma-separated list of schema names. All fields from these schemas are fetched. Must be set when projection=custom. name: custom-field-mask - description: Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users name: query - auto: PREDEFINED description: If true, retrieves the list of deleted users. Default is false. name: show-deleted predefined: - 'False' - 'True' - auto: PREDEFINED description: How to sort the results. Can be ASCENDING/DESCENDING. name: sort-order predefined: - ASCENDING - DESCENDING - description: Token to authorize and authenticate the action. name: token - auto: PREDEFINED defaultValue: admin_view description: Whether to fetch either the administrator or public view of the user. Can be admin_view (default), which includes both administrator and domain-public fields or "domain_public"(includes fields for the user that are publicly visible to other users in the domain). name: view-type-public-domain predefined: - admin_view - domain_public - description: Token to specify next page in the list. name: page-token description: Lists all Google users in a domain. name: gmail-list-users outputs: - contextPath: Account.Type description: The account type. For example, "AD", "LocalOS", "Google", or "AppleID". type: String - contextPath: Account.ID description: The unique ID for the account (integration specific). For AD accounts this is the Distinguished Name (DN). type: String - contextPath: Account.DisplayName description: The display name. type: String - contextPath: Account.Gmail.Address description: The email assigned with the current account. type: string - contextPath: Account.Email.Adderss description: The email address of the account. type: String - contextPath: Account.Groups description: Groups to which the account belongs (integration specific). For example, for AD these are the groups in which the account is member. type: String - contextPath: Account.Domain description: The domain of the account. type: String - contextPath: Account.Username description: The username of the account. type: String - contextPath: Account.OrganizationUnit description: The Organization Unit (OU) of the account. type: String - arguments: - description: The user's email address. The special value me can be used to indicate the authenticated user. name: user-id - description: The immutable ID of the role assignment. name: role-assignment-id required: true description: Revokes a role for a specified Google user. name: gmail-revoke-user-role - arguments: - default: true description: The user's primary email address. The primary email address must be unique and cannot be an alias of another user. name: email required: true - description: The user's first name. name: first-name required: true - description: The user's last name. name: family-name required: true - description: Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. name: password required: true description: Creates a new Gmail user. name: gmail-create-user outputs: - contextPath: Account.Type description: The account type. For example, "AD", "LocalOS", "Google", or "AppleID". type: String - contextPath: Account.ID description: The unique ID for the account (integration specific). For AD accounts this is the Distinguished Name (DN). type: String - contextPath: Account.DisplayName description: The display name. type: string - contextPath: Account.Gmail.Address description: The email assigned with the current account. type: string - contextPath: Account.Email.Address description: The email address of the account. type: String - contextPath: Account.Username description: The username of the account. type: String - contextPath: Account.Groups description: Groups to which the account belongs (integration specific). For example, for AD these are groups in which the account is a member. type: String - contextPath: Account.Domain description: The domain of the account. type: String - contextPath: Account.OrganizationUnit description: The Organization Unit (OU) of the account. type: String - arguments: - default: true description: The user's email address. The special value me can be used to indicate the authenticated user. name: user-id required: true - description: The ID of the email to delete. You can get the ID by running the gmail-search command, or by fetching mails and copy the incident.labels.Email/ID value from the fetched incident context. name: message-id required: true - auto: PREDEFINED description: Whether to delete the email permanently or move it to trash (default). name: permanent predefined: - 'False' - 'True' description: Deletes an email in the user's mailbox. name: gmail-delete-mail - arguments: - default: true description: The user's email address. The special value me can be used to indicate the authenticated user. name: user-id required: true - description: The ID of the thread to retrieve. name: thread-id required: true - auto: PREDEFINED defaultValue: full description: 'The format in which to return the message. Can be: "full": Returns the full email message data with body content parsed in the payload field; the raw field is not used. (default) / "metadata": Returns only email message ID, labels, and email headers / "minimal": Returns only email message ID and labels; does not return the email headers, body, or payload / "raw": Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used.' name: format predefined: - full - metadata - minimal - raw description: Returns all messages in a thread. name: gmail-get-thread outputs: - contextPath: Gmail.ID description: The inner ID of the Gmail message. type: string - contextPath: Gmail.ThreadId description: The thread ID. type: string - contextPath: Gmail.Format description: The MIME type of email. type: string - contextPath: Gmail.Labels description: The labels of the specific email. type: string - contextPath: Gmail.To description: The email address of the receiver. type: string - contextPath: Gmail.From description: The email address of the sender. type: string - contextPath: Gmail.Cc description: The additional recipient email address (CC). type: string - contextPath: Gmail.Bcc description: The additional recipient email address (BCC). type: string - contextPath: Gmail.Subject description: The subject of a specific email. type: string - contextPath: Gmail.Body description: The content of the email. type: string - contextPath: Gmail.Attachments description: The attachments of the email. IDs are separated by commas. type: unknown - contextPath: Gmail.Headers description: All headers of the specific email (list). type: unknown - contextPath: Gmail.Mailbox description: The Gmail mailbox. type: string - contextPath: Email.To description: The recipient of the email. type: String - contextPath: Email.From description: The sender of the email. type: String - contextPath: Email.CC description: The additional recipient email address (CC). type: String - contextPath: Email.BCC description: The additional recipient email address (BCC). type: String - contextPath: Email.Format description: The format of the email. type: String - contextPath: Email.Body/HTML description: The HTML version of the email. type: String - contextPath: Email.Body/Text description: The plain-text version of the email. type: String - contextPath: Email.Subject description: The subject of the email. type: String - contextPath: Email.Headers description: The headers of the email. type: String - contextPath: Email.Attachments.entryID description: Email Attachments. IDs are separated by commas. type: Unknown - contextPath: Email.Date description: The date the email was received. type: String - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The ID of the email to retrieve. You can get the ID by running the gmail-search command, or by fetching mails and copy the incident.labels.Email/ID value from the fetched incident context. name: message-id required: true - description: A comma-separated list of labels to add to the email. isArray: true name: add-labels - description: A comma-separated list of labels to remove from the email. isArray: true name: remove-labels description: Moves an email to a different folder. name: gmail-move-mail outputs: - contextPath: Gmail.ID description: The inner ID of the Gmail message. type: string - contextPath: Gmail.ThreadId description: The thread ID. type: string - contextPath: Gmail.Format description: The MIME type of email. type: string - contextPath: Gmail.Labels description: The labels of the specific email. type: string - contextPath: Gmail.To description: The Gmail address of the receiver. type: string - contextPath: Gmail.From description: The Gmail address of the sender. type: string - contextPath: Gmail.Cc description: The additional recipient email address (CC). type: string - contextPath: Gmail.Bcc description: The additional recipient email address (BCC). type: string - contextPath: Gmail.Subject description: The subject of the specific email. type: string - contextPath: Gmail.Body description: The content of the email. type: string - contextPath: Gmail.Attachments description: The attachments of the email. IDs are separated by commas. type: unknown - contextPath: Gmail.Headers description: All headers of the specific email (list). type: unknown - contextPath: Gmail.Mailbox description: The Gmail mailbox. type: string - contextPath: Email.To description: The recipient of the email. type: String - contextPath: Email.From description: The sender of the email. type: String - contextPath: Email.CC description: The additional recipient email address (CC). type: Unknown - contextPath: Email.BCC description: The additional recipient email address (BCC). type: Unknown - contextPath: Email.Format description: The format of the email. type: String - contextPath: Email.Body/HTML description: The HTML version of the email. type: String - contextPath: Email.Body/Text description: The plain-text version of the email. type: String - contextPath: Email.Subject description: The subject of the email. type: String - contextPath: Email.Headers description: The headers of the email. type: String - contextPath: Email.Attachments.entryID description: Email attachments. IDs are separated by commas. type: Unknown - contextPath: Email.Date description: The date the email was received. type: String - arguments: - default: true description: The source user's email address. The "me" special value can be used to indicate the authenticated user. name: src-user-id required: true - description: The ID of the email to retrieve. You can get the ID by running the gmail-search command, or by fetching mails and copy the incident.labels.Email/ID value from the fetched incident context. name: message-id required: true - description: The destination user's email address. The "me" special value can be used to indicate the authenticated user. name: dst-user-id required: true description: Moves an email to a different mailbox. name: gmail-move-mail-to-mailbox outputs: - contextPath: Gmail.ID description: The inner ID of the Gmail message. type: string - contextPath: Gmail.ThreadId description: The thread ID. type: string - contextPath: Gmail.Format description: The MIME type of email. type: string - contextPath: Gmail.Labels description: The labels of the specific email. type: string - contextPath: Gmail.To description: The Gmail address of the receiver. type: string - contextPath: Gmail.From description: The Gmail address of the sender. type: string - contextPath: Gmail.Cc description: The additional recipient email address (CC). type: string - contextPath: Gmail.Bcc description: The additional recipient email address (BCC). type: string - contextPath: Gmail.Subject description: The subject of the specific email. type: string - contextPath: Gmail.Body description: The content of the email. type: string - contextPath: Gmail.Attachments description: The attachments of the email. IDs are separated by commas. type: unknown - contextPath: Gmail.Headers description: All headers of specific the email (list). type: unknown - contextPath: Gmail.Mailbox description: The Gmail mailbox. type: string - contextPath: Email.To description: The recipient of the email. type: String - contextPath: Email.From description: The sender of the email. type: String - contextPath: Email.CC description: The additional recipient email address (CC). type: String - contextPath: Email.BCC description: The additional recipient email address (BCC). type: String - contextPath: Email.Format description: The format of the email. type: String - contextPath: Email.Body/HTML description: The HTML version of the email. type: String - contextPath: Email.Body/Text description: The plain-text version of the email. type: String - contextPath: Email.Subject description: The subject of the email. type: String - contextPath: Email.Headers description: The headers of the email. type: String - contextPath: Email.Attachments.entryID description: Emails attachments. IDs are separated by commas. type: Unknown - contextPath: Email.Date description: The date the email was received. type: String - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The email address to block messages. name: email-address required: true description: Adds a rule for email deletion by address. name: gmail-add-delete-filter - arguments: - default: true description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The sender's display name or email address. name: from - description: The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive. name: to - description: The email subject. name: subject - description: Returns messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com is:unread". name: query - description: Whether the message has any attachments. name: has-attachments - description: The size of the entire RFC822 message in bytes, including all headers and attachments. name: size - description: A comma-separated list of labels to add to the message. name: add-labels - description: A comma-separated list of labels to remove from the message. name: remove-labels - description: The email address that the message is to be forwarded to. The email needs to be configured as a forwarding address, see https://support.google.com/mail/answer/10957?hl=en#null. name: forward - auto: PREDEFINED description: The message size in bytes compared to the size field. name: size-comparison predefined: - larger - smaller description: Adds a new filter. name: gmail-add-filter outputs: - contextPath: Gmail.Filter.ID description: The filter ID. type: String - contextPath: Gmail.Filter.Mailbox description: The mailbox containing the filter. type: String - contextPath: Gmail.Filter.Criteria description: The filter criteria. type: Unknown - contextPath: Gmail.Filter.Action description: The filter action. type: Unknown - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The limit of the results list. Default is 100. name: limit - description: The list filters associated with the email address. name: address description: Lists all filters in a user's mailbox. name: gmail-list-filters outputs: - contextPath: Gmail.Filter.ID description: The filter ID. type: String - contextPath: Gmail.Filter.Mailbox description: The mailbox containing the filter. type: String - contextPath: Gmail.Filter.Criteria description: The filter criteria. type: Unknown - contextPath: Gmail.Filter.Action description: The filter action. type: Unknown - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: A comma-separated list of filter IDs (can be retrieve using `gmail-list-filters` command). isArray: true name: filter_ids required: true description: Removes a Filter. name: gmail-remove-filter - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - auto: PREDEFINED defaultValue: 'true' description: Whether to hide the user's visibility in the Global Directory. Can be true to show the user in the directory (default) or false to hide the user. name: visible-globally predefined: - 'true' - 'false' description: Hides a user's contact information in the Global Directory, for example email address and profile information. name: gmail-hide-user-in-directory outputs: - contextPath: Account.Type description: The account type. For example, "AD", "LocalOS", "Google", "AppleID", and so on. type: String - contextPath: Account.ID description: The unique ID for the account (integration specific). For AD accounts this is the Distinguished Name (DN). type: String - contextPath: Account.DisplayName description: The display name. type: String - contextPath: Account.Email.Address description: The email address of the account. type: String - contextPath: Account.Gmail.Address description: The email assigned with current account. type: Unknown - contextPath: Account.Domain description: The domain of the account. type: String - contextPath: Account.Username description: The username of the account. type: String - contextPath: Account.OrganizationUnit description: The Organization Unit (OU) of the account. type: String - contextPath: Account.VisibleInDirectory description: Whether the account is visible in the Global Directory. type: Boolean - contextPath: Account.Groups description: Groups in which the account belongs (integration specific). For example, for AD these are groups of which the account is memberOf. type: String - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: A string formatted password for the user. Depends on the password policy of the organization. name: password required: true description: Sets the password for the user. name: gmail-set-password - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true description: Returns the auto-reply message set for the user-account. name: gmail-get-autoreply outputs: - contextPath: Account.Gmail.AutoReply.EnableAutoReply description: A flag that controls whether Gmail automatically replies to messages. type: Boolean - contextPath: Account.Gmail.AutoReply.ResponseBody description: Response body in plain text format. type: String - contextPath: Account.Gmail.AutoReply.ResponseSubject description: Optional text to add to the subject line in vacation responses. To enable auto-replies, the response subject or the response body must not be empty. type: String - contextPath: Account.Gmail.AutoReply.RestrictToContact description: A flag that determines whether responses are sent to recipients who are not in the user's list of contacts. type: String - contextPath: Account.Gmail.AutoReply.RestrictToDomain description: A flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. type: String - contextPath: Account.Gmail.Address description: Email assigned with the current account. type: String - arguments: - description: The user's email address. The "me" special value me can be used to indicate the authenticated user. name: user-id required: true - auto: PREDEFINED defaultValue: 'true' description: Whether Gmail automatically replies to messages. Set to true to automatically reply (default). name: enable-autoReply predefined: - 'true' - 'false' - description: Optional text to add to the subject line in vacation responses. To enable auto-replies, either the response subject or the response body must not be empty. name: response-subject - description: Response body in plain text format. name: response-body - description: Sets the away/vacation message by passing a War Room entryID of the file for the given user. name: response-body-entry-id - description: Sets a start date for the vacation message to be enabled for the given user. The valid format is YYYY-MM-DD or Epoch time in milliseconds. name: start-time - description: Sets an end date for the vacation message to be enabled for the given user. The valid format is YYYY-MM-DD or Epoch time in milliseconds. name: end-time - auto: PREDEFINED defaultValue: 'false' description: Whether to send away/vacation messages to users in the contact list when set to true. name: contacts-only predefined: - 'true' - 'false' - auto: PREDEFINED defaultValue: 'false' description: Whether to prevent sending away/vacation messages to recipients who are outside of the user's domain when set to true. name: domain-only predefined: - 'true' - 'false' - auto: PREDEFINED defaultValue: Text description: Whether message response body type is text or HTML. name: response-body-type predefined: - HTML - Text description: 'Sets the auto-reply for the user. Note: If the body is not set, the current body will be deleted.' name: gmail-set-autoreply outputs: - contextPath: Account.Gmail.AutoReply.EnableAutoReply description: A flag that controls whether Gmail automatically replies to messages. type: Boolean - contextPath: Account.Gmail.AutoReply.ResponseBody description: Response body in plain text format. type: String - contextPath: Account.Gmail.AutoReply.ResponseSubject description: Optional text to add to the subject line in vacation responses. To enable auto-replies, either the response subject or the response body must not be empty. type: String - contextPath: Account.Gmail.AutoReply.RestrictToContact description: Determines whether responses are sent to recipients who are not in the user's list of contacts. type: String - contextPath: Account.Gmail.AutoReply.RestrictToDomain description: Determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. type: String - contextPath: Account.Gmail.Address description: Email assigned with the current account. type: String - contextPath: Account.Gmail.AutoReply.ResponseBodyHtml description: Response body in HTML format. type: String - contextPath: Account.Gmail.AutoReply.StartTime description: Start time for sending auto-replies. type: Number - contextPath: Account.Gmail.AutoReply.EndTime description: End time for sending auto-replies. type: Number - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The email address of the delegate. name: delegate-email required: true description: 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. name: gmail-delegate-user-mailbox - arguments: - description: The email addresses of the receiver. isArray: true name: to required: true - description: The email address of the sender. name: from - description: The sender Name that appears on the receiver side. name: senderDisplayName - description: The content (body) of the email to be sent in plain text. name: body - description: The subject for the email to be sent. name: subject required: true - description: A comma-separated list of IDs of War Room entries that contain the files that need be attached to the email. isArray: true name: attachIDs - description: The additional recipient email address (CC). isArray: true name: cc - description: The additional recipient email address (BCC). isArray: true name: bcc - description: The content (body) of the email to be sent in HTML format. name: htmlBody - description: Choose true if you wish to handle html body as MimeMultipart. name: force_handle_htmlBody auto: PREDEFINED defaultValue: 'false' predefined: - 'false' - 'true' - description: |- The address that needs to be used to reply to the message. name: replyTo - description: |- A comma-separated list of new names to rename attachments corresponding to the order that they were attached to the email. Examples - To rename first and third file attachNames=new_fileName1,,new_fileName3 To rename second and fifth files attachNames=,new_fileName2,,,new_fileName5. isArray: true name: attachNames - description: |- A comma-separated list of CID images to embed attachments inside the email. isArray: true name: attachCIDs - description: |- Textual name for an attached file. Multiple files are supported as a comma-separated list. For example, transientFile="t1.txt,temp.txt,t3.txt" transientFileContent="test 2,temporary file content,third file content" transientFileCID="t1.txt@xxx.yyy,t2.txt@xxx.zzz"). isArray: true name: transientFile - description: |- Content for the attached file. Multiple files are supported as a comma-separated list. For example, transientFile="t1.txt,temp.txt,t3.txt" transientFileContent="test 2,temporary file content,third file content" transientFileCID="t1.txt@xxx.yyy,t2.txt@xxx.zzz"). isArray: true name: transientFileContent - description: |- CID image for an attached file to include within the email body. Multiple files are supported as a comma-separated list. (e.g. transientFile="t1.txt,temp.txt,t3.txt" transientFileContent="test 2,temporary file content,third file content" transientFileCID="t1.txt@xxx.yyy,t2.txt@xxx.zzz"). isArray: true name: transientFileCID - description: 'A CSV list of additional headers in the format: headerName=headerValue. For example: "headerName1=headerValue1,headerName2=headerValue2".' name: additionalHeader isArray: true - description: |- 'Replaces {varname} variables with values from this parameter. Expected values are in the form of a JSON document. For example, {"varname" :{"value" "some value", "key": "context key"}}. Each var name can either be provided with the value or a context key to retrieve the value. Note that only context data is accessible for this argument, while incident fields are not.' name: templateParams - description: Whether message response body type is text or HTML. name: bodyType auto: PREDEFINED predefined: - 'HTML' - 'Text' defaultValue: Text - description: Indicates whether to render the email body. name: renderBody auto: PREDEFINED predefined: - 'true' - 'false' description: Sends mail using Gmail. name: send-mail outputs: - contextPath: Gmail.SentMail.ID description: The immutable ID of the message. type: String - contextPath: Gmail.SentMail.Labels description: The list of IDs of labels applied to this message. type: String - contextPath: Gmail.SentMail.ThreadId description: The ID of the thread in which the message belongs. type: String - contextPath: Gmail.SentMail.To description: The recipient of the email. type: String - contextPath: Gmail.SentMail.From description: The sender of the email. type: Unknown - contextPath: Gmail.SentMail.Cc description: The additional recipient email address (CC). type: String - contextPath: Gmail.SentMail.Bcc description: The additional recipient email address (BCC). type: String - contextPath: Gmail.SentMail.Subject description: The subject of the email. type: String - contextPath: Gmail.SentMail.Body description: The plain-text version of the email. type: Unknown - contextPath: Gmail.SentMail.MailBox description: The mailbox from which the mail was sent. type: String - arguments: - description: The email addresses of the recipients. isArray: true name: to required: true - description: The email address of the sender. name: from - description: The contents (body) of the email to be sent in plain text. name: body - description: The subject of the email to be sent. Should be the same as the subject of the email you are replying to in order for the reply to be a part of the same conversation. name: subject required: true - description: A comma-separated list of message IDs to reply to. isArray: true name: inReplyTo required: true - description: A comma-separated list of message IDs to refer to. isArray: true name: references - description: A comma-separated list of IDs of War Room entries that contain the files that need to be attached to the email. isArray: true name: attachIDs - description: The additional recipient email addresses (CC). isArray: true name: cc - description: The additional recipient email addresses (BCC). isArray: true name: bcc - description: The content (body) of the email to be sent in HTML format. name: htmlBody - description: The address that needs to be used to reply to the message. name: replyTo - description: |- A comma-separated list of new names used to rename attachments corresponding to the order in which they were attached to the email. Examples - To rename the first and third file: attachNames=new_fileName1,,new_fileName3 To rename the second and fifth files: attachNames=,new_fileName2,,,new_fileName5. isArray: true name: attachNames - description: A comma-separated list of CID images to embed as attachments inside the email. isArray: true name: attachCIDs - description: |- Textual name for an attached file. Multiple files are supported as a comma-separated list. For example, transientFile="t1.txt,temp.txt,t3.txt" transientFileContent="test2,temporary file content,third file content" transientFileCID="t1.txt@xxx.yyy,t2.txt@xxx.zzz"). isArray: true name: transientFile - description: |- Content for the attached file. Multiple files are supported as a comma-separated list. For example, transientFile="t1.txt,temp.txt,t3.txt" transientFileContent="test2,temporary file content,third file content" transientFileCID="t1.txt@xxx.yyy,t2.txt@xxx.zzz"). isArray: true name: transientFileContent - description: |- CID image for an attached file to include within the email body. Multiple files are supported as a comma-separated list. (e.g. transientFile="t1.txt,temp.txt,t3.txt" transientFileContent="test 2,temporary file content,third file content" transientFileCID="t1.txt@xxx.yyy,t2.txt@xxx.zzz"). isArray: true name: transientFileCID - description: 'A comma-separated list of additional headers in the format: headerName=headerValue. For example: "headerName1=headerValue1,headerName2=headerValue2".' isArray: true name: additionalHeader - description: |- 'Replaces {varname} variables with values from this parameter. Expected values are in the form of a JSON document. For example, {"varname" :{"value" "some value", "key": "context key"}}. Each var name can either be provided with the value or a context key to retrieve the value. Note that only context data is accessible for this argument, while incident fields are not.' name: templateParams - auto: PREDEFINED defaultValue: Text description: Whether message response body type is text or HTML. name: bodyType predefined: - HTML - Text - description: Indicates whether to render the email body. name: renderBody description: Replies to a mail using Gmail. name: reply-mail outputs: - contextPath: Gmail.SentMail.ID description: The immutable ID of the message. type: String - contextPath: Gmail.SentMail.Labels description: The list of IDs of the labels applied to this message. type: String - contextPath: Gmail.SentMail.ThreadId description: The ID of the thread in which the message belongs. type: String - contextPath: Gmail.SentMail.To description: The recipients of the email. type: String - contextPath: Gmail.SentMail.From description: The sender of the email. type: Unknown - contextPath: Gmail.SentMail.Cc description: The additional recipient email addresses (CC). type: String - contextPath: Gmail.SentMail.Bcc description: The additional recipient email addresses (BCC). type: String - contextPath: Gmail.SentMail.Subject description: The subject of the email. type: String - contextPath: Gmail.SentMail.Body description: The plain-text version of the email. type: Unknown - contextPath: Gmail.SentMail.MailBox description: The mailbox from which the mail was sent. type: String - arguments: - description: The user's email address. The "me" special value can be used to indicate the authenticated user. name: user-id required: true - description: The email address to remove from delegation. name: removed-mail required: true description: 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. name: gmail-remove-delegated-mailbox - arguments: - description: The ID of the role. Can be retrieved using the get-user-roles command. name: role-id required: true - description: The immutable Google Apps ID. name: customer-id description: Gets details of a specific role. name: gmail-get-role outputs: - contextPath: Gmail.Role.ETag description: The ETag of the resource. type: String - contextPath: Gmail.Role.IsSuperAdminRole description: Indicates whether the role is a super admin role. type: Boolean - contextPath: Gmail.Role.IsSystemRole description: Indicates whether the role is a pre-defined system role. type: Boolean - contextPath: Gmail.Role.Kind description: The kind of the role. type: String - contextPath: Gmail.Role.Description description: The description of the role. type: String - contextPath: Gmail.Role.ID description: The ID of the role. type: String - contextPath: Gmail.Role.Name description: The name of the role. type: String - contextPath: Gmail.Role.Privilege.ServiceID description: The ID of the service this privilege is for. type: String - contextPath: Gmail.Role.Privilege.Name description: The name of the privilege. type: String - arguments: - description: A comma-separated list of emails addresses to which messages can be forwarded. isArray: true name: forwarding_email required: true - description: The user email address or the user id, use the !gmail-list-users command, in order to get the user id. name: user_id required: true description: 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. name: gmail-forwarding-address-add outputs: - contextPath: Gmail.ForwardingAddress.forwardingEmail description: An email address to which messages can be forwarded. type: String - contextPath: Gmail.ForwardingAddress.userId description: The user's email address. type: String - contextPath: Gmail.ForwardingAddress.verificationStatus description: Indicates whether this address has been verified and is usable for forwarding. type: String - arguments: - description: The state that a message should be left in after it has been forwarded. name: disposition auto: PREDEFINED predefined: - 'archive' - 'leaveInInbox' - 'markRead' - 'trash' - description: A comma-separated list of emails addresses to which messages can be forwarded. isArray: true name: forwarding_email required: true - description: The user email address or the user ID, use the !gmail-list-users command, in order to get the user ID. name: user_id required: true description: |- Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. name: gmail-forwarding-address-update outputs: - contextPath: Gmail.ForwardingAddress.forwardingEmail description: An email address to which messages can be forwarded. type: String - contextPath: Gmail.ForwardingAddress.userId description: The user's email address. type: String - contextPath: Gmail.ForwardingAddress.Disposition description: The state that a message should be left in after it has been forwarded. type: String - contextPath: Gmail.ForwardingAddress.Enabled description: Indicates whether all incoming mail is automatically forwarded to another address. type: Boolean - arguments: - description: The user's email address. name: user_id required: true - description: The email address that appears in the "From:" header for email sent using this alias. name: send_as_email required: true - description: The name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail. name: display_name - description: An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. name: signature - description: An optional email address that is included in a "Reply-To:" header for email sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. name: reply_to_address - auto: PREDEFINED defaultValue: 'false' description: Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address. Default is "false". name: is_default predefined: - 'true' - 'false' - auto: PREDEFINED defaultValue: 'false' description: Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. Default is "false". name: treat_as_alias predefined: - 'true' - 'false' - description: The hostname of the SMTP service. Required for SMTP configuration. name: smtp_host - description: The port of the SMTP service. Required for SMTP configuration. name: smtp_port - description: The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings. name: smtp_username - description: The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings. name: smtp_password - auto: PREDEFINED description: |- The protocol that will be used to secure communication with the SMTP service. Required for SMTP configuration. Available Options: SECURITY_MODE_UNSPECIFIED - Unspecified security mode. NONE - Communication with the remote SMTP service is unsecured. Requires port 25. SSL - Communication with the remote SMTP service is secured using SSL. STARTTLS - Communication with the remote SMTP service is secured using STARTTLS. name: smtp_securitymode predefined: - SECURITY_MODE_UNSPECIFIED - NONE - SSL - STARTTLS description: |- 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. name: gmail-send-as-add outputs: - contextPath: Gmail.SendAs.userId description: The user's email address. type: String - contextPath: Gmail.SendAs.sendAsEmail description: The updated send-as alias. type: String - contextPath: Gmail.SendAs.signature description: An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. type: String - contextPath: Gmail.SendAs.isPrimary description: Whether this address is the primary address used to login to the account. type: Boolean - contextPath: Gmail.SendAs.isDefault description: Whether this address is selected as the default "From:" address in situations. type: Boolean - contextPath: Gmail.SendAs.treatAsAlias description: Whether Gmail should treat this address as an alias for the user's primary email address. type: Boolean - contextPath: Gmail.SendAs.smtpMsaHost description: The hostname of the SMTP service. type: String - contextPath: Gmail.SendAs.smtpMsaPort description: The port of the SMTP service. type: String - contextPath: Gmail.SendAs.smtpMsaSecurityMode description: The protocol that will be used to secure communication with the SMTP service. type: String - contextPath: Gmail.SendAs.verificationStatus description: Indicates whether this address has been verified for use as a send-as alias. type: String - contextPath: Gmail.SendAs.replyToAddress description: A name that appears in the "From:" header for email sent using this alias. type: String - arguments: - description: The user email address or the user id, use the !gmail-list-users command, in order to get the user id. name: user_id required: true - description: The forwarding address to be retrieved. name: forwarding_email required: true description: Gets the specified forwarding address or a list of the forwarding addresses for the specified account. name: gmail-forwarding-address-get outputs: - contextPath: Gmail.ForwardingAddress.userId description: The user email address or the user id, use the !gmail-list-users command, in order to get the user id. type: String - contextPath: Gmail.ForwardingAddress.forwardingEmail description: An email address to which messages can be forwarded. type: String - arguments: - description: The user email address or the user id, use the !gmail-list-users command, in order to get the user id. name: user_id required: true - description: The forwarding address to be retrieved. name: forwarding_email required: true description: 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. name: gmail-forwarding-address-remove - arguments: - description: The user email address or the user ID, use the !gmail-list-users command, in order to get the user ID. The special value "me" can be used to indicate the authenticated user. name: user_id required: true - description: The maximum number of addresses to return. The default value is 50. name: limit description: Lists the forwarding addresses for the specified account. name: gmail-forwarding-address-list outputs: - contextPath: Gmail.ForwardingAddress.forwardingEmail description: An email address to which messages can be forwarded. type: String - contextPath: Gmail.ForwardingAddress.verificationStatus description: Indicates whether this address has been verified and is usable for forwarding. type: String dockerimage: demisto/google-api-py3:1.0.0.10182333 isfetch: true runonce: false script: '-' subtype: python3 type: python tests: - Gmail Convert Html Test - GmailTest fromversion: 5.0.0