Zoom Mail

Details

ID	`Zoom Mail`
Provider	Zoom
Category	Email
From Version	6.10.0
Docker Image	`demisto/python3:3.12.13.10116658`
Supported Modules	Agentix XSIAM

README

Enables interaction with the Zoom Mail API.

Configure Zoom Mail in Cortex

Parameter	Description	Required
Server URL (e.g., https://api.zoom.us/v2)		True
Fetch incidents		False
Incident type		False
Maximum number of alerts per fetch		False
Client ID		True
Client Secret		True
Account ID		True
First fetch time		False
Trust any certificate (not secure)		False
Use system proxy settings		False
Incidents Fetch Interval		False
Fetch Mailbox	Mailbox to fetch incidents from	False
Fetch Query	Elastic query to filter messages in the specified inbox.	False
Fetch Labels	Specify the folder that the messages will be fetched from.	False
Include Threads when Fetching		False

Scopes Required

Classic Scopes

mail:read
mail:write
user:read

Granular Scopes

email:read:list_msgs
email:write:trash_msg
email:read:list_threads
email:read:thread
email:read:attachment
email:write:send_msg
email:read:profile
user:read:list_users:admin

Additional Resources

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

zoom-mail-email-move-trash

Move a message to the trash.

Base Command

zoom-mail-email-move-trash

Input

Argument Name	Description	Required
email	The target mailbox to delete the email from.	Optional
message_id	The message_id of the message to delete.	Required

Context Output

There is no context output for this command.

zoom-mail-email-list

Lists the messages in the user’s mailbox.

Base Command

zoom-mail-email-list

Input

Argument Name	Description	Required
email	The target mailbox to list emails.	Optional
query	Query to filter emails within the given mailbox.	Optional
max_results	Maximum number of emails to list.	Optional
page_token	The token for the next page of results.	Optional
include_spam_trash	Whether or not to include spam or trash messages in the results.	Optional
message_id	The immutable message ID.	Optional
format	The format to return the message with. Possible values are: full, metadata, minimal.	Optional

Context Output

Path	Type	Description
ZoomMail.Email.messages.id	string	The ID of the email message.
ZoomMail.Email.messages.threadId	string	The ID of the email thread.
ZoomMail.Email.resultSizeEstimate	number	The estimated amount of messages found.
ZoomMail.Email.messages.labelIds	string	The labels assigned to the email.
ZoomMail.Email.messages.snippet	string	A snippet of the email content.
ZoomMail.Email.messages.historyId	string	The history ID of the email.
ZoomMail.Email.messages.internalDate	date	The internal date of the email.
ZoomMail.Email.messages.expiration	number	The expiration time of the email.
ZoomMail.Email.messages.lastMoved	date	The last moved timestamp of the email.
ZoomMail.Email.messages.sendTime	date	The send time of the email.
ZoomMail.Email.messages.userScheduled	boolean	Indicates if the email was user scheduled.
ZoomMail.Email.messages.manifest	string	The manifest of the email.
ZoomMail.Email.messages.originalMime	string	The original MIME of the email.
ZoomMail.Email.messages.payload.partId	string	The part ID of the email payload.
ZoomMail.Email.messages.payload.mimeType	string	The MIME type of the email payload.
ZoomMail.Email.messages.payload.filename	string	The filename of the email payload.
ZoomMail.Email.messages.payload.headers	unknown	The headers of the email payload.
ZoomMail.Email.messages.payload.body.attachmentId	string	The attachment ID of the email body.
ZoomMail.Email.messages.payload.body.size	number	The size of the email body.
ZoomMail.Email.messages.payload.body.data	string	The data of the email body.
ZoomMail.Email.messages.payload.parts	unknown	The parts of the email payload.
ZoomMail.Email.sizeEstimate	number	The size estimate of the email.
ZoomMail.Email.raw	string	The raw content of the email.

zoom-mail-thread-list

Get an email thread.

Base Command

zoom-mail-thread-list

Input

Argument Name	Description	Required
email	The target mailbox to list emails.	Optional
thread_id	Unique identifier for the email thread you want to retrieve.	Optional
format	Specifies the format in which the email messages in the thread should be returned. Possible values are: full, metadata, minimal.	Optional
metadata_headers	When the format is set to metadata, this argument allows you to specify which email headers should be included in the response.	Optional
max_results	Default is 50.	Optional
page_token	The token for the next page of results.	Optional

Context Output

Path	Type	Description
ZoomMail.Thread.id	string	The ID of the email thread.
ZoomMail.Thread.status	string	The status of the email thread.
ZoomMail.Thread.threadName	string	The name of the email thread.
ZoomMail.Thread.messages	unknown	The messages found in the email thread.

zoom-mail-email-attachment-get

Get an email attachment.

Base Command

zoom-mail-email-attachment-get

Input

Argument Name	Description	Required
email	The email address of the inbox.	Optional
message_id	The immutable message ID.	Required
attachment_id	The immutable attachment ID.	Required

Context Output

There is no context output for this command.

zoom-mail-send-email

Sends an email message with support for plain text, HTML, and attachments.

Base Command

zoom-mail-send-email

Input

Argument Name	Description	Required
from	The sender address.	Optional
to	The recipient address.	Required
subject	The subject of the email.	Required
body	The plain text body of the email.	Optional
html_body	The HTML body of the email.	Optional
attachments	Comma-separated list of War Room entry IDs.	Optional

Context Output

Path	Type	Description
ZoomMail.Email.id	string	The id of the sent email.
ZoomMail.Email.threadId	string	The id for the thread of the sent email.

zoom-mail-mailbox-profile-get

Retrieves the mailbox profile.

Base Command

zoom-mail-mailbox-profile-get

Input

Argument Name	Description	Required
email	The target mailbox.	Optional

Context Output

Path	Type	Description
ZoomMail.Profile.status	string	The status of the mailbox profile.
ZoomMail.Profile.emailAddress	string	The email address assigned to the mailbox profile.
ZoomMail.Profile.messagesTotal	number	The total number of messages.
ZoomMail.Profile.threadsTotal	number	The total number of threads.

zoom-mail-user-list

Lists the available users.

Base Command

zoom-mail-user-list

Input

Argument Name	Description	Required
status	The status of the User.	Optional
limit	The max amount of users to return per page.	Optional
role_id	The ID for the role of the User.	Optional
page_number	The page number of results.	Optional
include_fields	Indicates whether or not to include fields.	Optional
next_token	The token used to fetch the next page.	Optional
license	Indicates if the user is licensed or not.	Optional

Context Output

Path	Type	Description
ZoomMail.User.role_id	string	The ID of the users role.
ZoomMail.User.display_name	string	The display name of the user.
ZoomMail.User.id	string	The ID of the user.
ZoomMail.User.email	unknown	The email for the user.

Configuration parameters

url — Server URL (e.g., https://api.zoom.us/v2) (required)
credentials — Client ID (required)
account_id — Account ID (required)
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings
isFetch — Fetch incidents
incidentType — Incident type
max_fetch — Maximum number of alerts per fetch
first_fetch — First fetch time
incidentFetchInterval — Incidents Fetch Interval
fetch_from — Default Mailbox
fetch_query — Fetch Query
fetch_labels — Fetch Labels
fetch_threads — Include Threads when Fetching

Commands (7)

zoom-mail-email-attachment-get
Get an email attachment.
zoom-mail-email-list
Lists the messages in the user's mailbox.
zoom-mail-email-move-trash
Move a message to the trash.
zoom-mail-mailbox-profile-get
Retrieves the mailbox profile.
zoom-mail-send-email
Sends an email message with support for plain text, HTML, and attachments.
zoom-mail-thread-list
Get an email thread.
zoom-mail-user-list
Lists the available users.

Source

ZoomMail.py ZoomMail_test.py ZoomMail.yml command_examples.txt

Download History Raw

commonfields:
  id: Zoom Mail
  version: -1
name: Zoom Mail
display: Zoom Mail
category: Email
provider: Zoom
description: Enables interaction with the Zoom Mail API.
sectionorder:
- Connect
- Collect
configuration:
- section: Connect
  display: 'Server URL (e.g., https://api.zoom.us/v2)'
  name: url
  defaultvalue: 'https://api.zoom.us/v2/'
  type: 0
  required: true
- section: Connect
  display: Client ID
  displaypassword: Client Secret
  name: credentials
  type: 9
  required: true
- section: Connect
  display: Account ID
  name: account_id
  type: 0
  required: true
- section: Connect
  advanced: true
  display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
- section: Connect
  advanced: true
  display: Use system proxy settings
  name: proxy
  type: 8
  required: false
- section: Collect
  display: Fetch incidents
  name: isFetch
  type: 8
  required: false
- section: Connect
  display: Incident type
  name: incidentType
  type: 13
  required: false
- section: Collect
  display: Maximum number of alerts per fetch
  name: max_fetch
  defaultvalue: "10"
  type: 0
  required: false
- section: Collect
  display: First fetch time
  name: first_fetch
  defaultvalue: 3 days
  type: 0
  required: false
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  defaultvalue: "1"
  type: 19
  required: false
- display: Default Mailbox
  name: fetch_from
  type: 0
  required: false
  additionalinfo: When provided, this mailbox is used for fetching as well as the default email for any command.
- display: Fetch Query
  name: fetch_query
  type: 0
  required: false
  additionalinfo: Elastic query to filter messages in the specified inbox.
- display: Fetch Labels
  name: fetch_labels
  type: 0
  required: false
  defaultvalue: "INBOX"
  additionalinfo: Specify the folder that the messages will be fetched from.
- display: Include Threads when Fetching
  name: fetch_threads
  type: 8
  required: false
  defaultvalue: "false"
  additionalinfo: When enabled, email replies (threads) are fetched as their own incident.
script:
  script: ""
  type: python
  commands:
  - name: zoom-mail-email-move-trash
    arguments:
    - name: email
      required: false
      description: The target mailbox to delete the email from.
    - name: message_id
      description: The message_id of the message to delete.
      required: true
    description: Move a message to the trash.
  - name: zoom-mail-email-list
    arguments:
    - name: email
      required: false
      description: The target mailbox to list emails.
    - name: query
      description: Query to filter emails within the given mailbox.
    - name: max_results
      description: Maximum number of emails to list.
    - name: page_token
      description: The token for the next page of results.
    - name: include_spam_trash
      description: Whether or not to include spam or trash messages in the results.
    - name: message_id
      required: false
      description: The immutable message ID.
    - name: format
      auto: PREDEFINED
      predefined:
      - full
      - metadata
      - minimal
      description: The format to return the message with.
    description: Lists the messages in the user's mailbox.
    outputs:
    - contextPath: ZoomMail.Email.messages.id
      description: The ID of the email message.
      type: string
    - contextPath: ZoomMail.Email.messages.threadId
      description: The ID of the email thread.
      type: string
    - contextPath: ZoomMail.Email.resultSizeEstimate
      description: The estimated amount of messages found.
      type: number
    - contextPath: ZoomMail.Email.messages.id
      description: The ID of the email message.
      type: string
    - contextPath: ZoomMail.Email.messages.threadId
      description: The ID of the email thread.
      type: string
    - contextPath: ZoomMail.Email.resultSizeEstimate
      description: The estimated amount of messages found.
      type: number
    - contextPath: ZoomMail.Email.messages.labelIds
      description: The labels assigned to the email.
      type: string
    - contextPath: ZoomMail.Email.messages.snippet
      description: A snippet of the email content.
      type: string
    - contextPath: ZoomMail.Email.messages.historyId
      description: The history ID of the email.
      type: string
    - contextPath: ZoomMail.Email.messages.internalDate
      description: The internal date of the email.
      type: date
    - contextPath: ZoomMail.Email.messages.expiration
      description: The expiration time of the email.
      type: number
    - contextPath: ZoomMail.Email.messages.lastMoved
      description: The last moved timestamp of the email.
      type: date
    - contextPath: ZoomMail.Email.messages.sendTime
      description: The send time of the email.
      type: date
    - contextPath: ZoomMail.Email.messages.userScheduled
      description: Indicates if the email was user scheduled.
      type: boolean
    - contextPath: ZoomMail.Email.messages.manifest
      description: The manifest of the email.
      type: string
    - contextPath: ZoomMail.Email.messages.originalMime
      description: The original MIME of the email.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.partId
      description: The part ID of the email payload.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.mimeType
      description: The MIME type of the email payload.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.filename
      description: The filename of the email payload.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.headers
      description: The headers of the email payload.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.body.attachmentId
      description: The attachment ID of the email body.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.body.size
      description: The size of the email body.
      type: number
    - contextPath: ZoomMail.Email.messages.payload.body.data
      description: The data of the email body.
      type: string
    - contextPath: ZoomMail.Email.messages.payload.parts
      description: The parts of the email payload.
      type: string
    - contextPath: ZoomMail.Email.sizeEstimate
      description: The size estimate of the email.
      type: number
    - contextPath: ZoomMail.Email.raw
      description: The raw content of the email.
      type: string
  - name: zoom-mail-thread-list
    arguments:
    - name: email
      required: false
      description: The target mailbox to list emails.
    - name: thread_id
      description: Unique identifier for the email thread you want to retrieve.
      required: true
    - name: format
      auto: PREDEFINED
      predefined:
      - full
      - metadata
      - minimal
      description: Specifies the format in which the email messages in the thread should be returned.
    - name: metadata_headers
      description: When the format is set to metadata, this argument allows you to specify which email headers should be included in the response.
    - name: max_results
      description: Default is 50.
    - name: page_token
      description: The token for the next page of results.
    description: Get an email thread.
    outputs:
    - contextPath: ZoomMail.Thread.id
      description: The ID of the email thread.
      type: string
    - contextPath: ZoomMail.Thread.status
      description: The status of the email thread.
      type: string
    - contextPath: ZoomMail.Thread.threadName
      description: The name of the email thread.
      type: string
    - contextPath: ZoomMail.Thread.messages
      description: The messages found in the email thread.
      type: unknown
  - name: zoom-mail-email-attachment-get
    arguments:
    - name: email
      required: false
      description: The email address of the inbox.
    - name: message_id
      required: true
      description: The immutable message ID.
    - name: attachment_id
      description: The immutable attachment ID.
      required: true
    description: Get an email attachment.
  - name: zoom-mail-send-email
    arguments:
    - name: from
      required: false
      description: The sender address.
    - name: to
      required: true
      description: The recipient address.
      isArray: true
    - name: subject
      description: The subject of the email.
      required: true
    - name: body
      description: The plain text body of the email.
    - name: html_body
      description: The HTML body of the email.
    - name: attachments
      description: Comma-separated list of War Room entry IDs.
      isArray: true
    description: Sends an email message with support for plain text, HTML, and attachments.
    outputs:
    - contextPath: ZoomMail.Email.id
      description: The id of the sent email.
      type: string
    - contextPath: ZoomMail.Email.threadId
      description: The id for the thread of the sent email.
      type: string
  - name: zoom-mail-mailbox-profile-get
    arguments:
    - name: email
      description: The target mailbox.
    outputs:
    - contextPath: ZoomMail.Profile.status
      description: The status of the mailbox profile.
      type: string
    - contextPath: ZoomMail.Profile.emailAddress
      description: The email address assigned to the mailbox profile.
      type: string
    - contextPath: ZoomMail.Profile.messagesTotal
      description: The total number of messages.
      type: number
    - contextPath: ZoomMail.Profile.threadsTotal
      description: The total number of threads.
      type: number
    description: Retrieves the mailbox profile.
  - name: zoom-mail-user-list
    description: Lists the available users.
    arguments:
    - name: status
      description: The status of the User.
    - name: limit
      description: The max amount of users to return per page.
    - name: role_id
      description: The ID for the role of the User.
    - name: page_number
      description: The page number of results.
    - name: include_fields
      description: Indicates whether or not to include fields.
    - name: next_token
      description: The token used to fetch the next page.
    - name: license
      description: Indicates if the user is licensed or not.
    outputs:
    - contextPath: ZoomMail.User.role_id
      description: The ID of the users role.
      type: string
    - contextPath: ZoomMail.User.display_name
      description: The display name of the user.
      type: string
    - contextPath: ZoomMail.User.id
      description: The ID of the user.
      type: string
    - contextPath: ZoomMail.User.email
      description: The email for the user.
      type: unknown
  dockerimage: demisto/python3:3.12.13.10116658
  isfetch: true
  runonce: false
  subtype: python3
fromversion: 6.10.0
tests:
- ZoomMailTest