category: Messaging and Conferencing
provider: Open Source
sectionorder:
- Connect
- Collect
commonfields:
  id: Mail Listener v2
  version: -1
configuration:
- display: Mail Server Hostname / IP address
  name: MailServerURL
  required: true
  type: 0
  section: Connect
- defaultvalue: '143'
  display: IMAP Port
  name: port
  required: true
  type: 0
  section: Connect
- display: Username
  name: credentials
  required: true
  type: 9
  section: Connect
- displaypassword: Client Certificate And Private Key (List of PEMs)
  display: ""
  name: clientCertAndKey
  required: false
  section: Connect
  type: 9
  advanced: true
  hiddenusername: true
- defaultvalue: INBOX
  display: Incoming mail folder
  name: folder
  required: true
  type: 0
  section: Connect
- display: Fetch incidents
  name: isFetch
  type: 8
  section: Collect
  required: false
- display: Incident type
  name: incidentType
  type: 13
  section: Connect
  required: false
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  defaultvalue: '1'
  required: false
  type: 19
  section: Collect
  advanced: true
- display: Fetch mails from these senders addresses only (eg. admin@demo.com,test@demo.com)
  name: permittedFromAdd
  type: 0
  section: Collect
  advanced: true
  required: false
- display: Fetch mails from these domains only (eg. demo.com, test.com)
  name: permittedFromDomain
  type: 0
  section: Collect
  advanced: true
  required: false
- defaultvalue: 'false'
  additionalinfo: Whether to query search with headers when filtering by sender's email address.
  display: Query search with headers
  name: with_headers
  type: 8
  section: Collect
  advanced: true
  required: false
- defaultvalue: 1 hour
  display: First fetch time
  name: first_fetch
  type: 0
  section: Collect
  required: false
- defaultvalue: '50'
  display: The maximum number of incidents to fetch each time
  name: limit
  type: 0
  section: Collect
  required: false
- display: Delete processed emails
  name: delete_processed
  type: 8
  section: Collect
  advanced: true
  required: false
- display: Include raw body in incidents
  name: Include_raw_body
  type: 8
  section: Collect
  advanced: true
  required: false
- display: Save the email .eml file
  name: save_file
  type: 8
  section: Collect
  advanced: true
  required: false
- display: Fetch by email date
  name: date_fetch
  type: 8
  defaultvalue: 'true'
  section: Collect
  advanced: true
  required: false
  additionalinfo: Whether to fetch by email date.
- defaultvalue: 'true'
  display: Use TLS for connection (defaults to True)
  name: TLS_connection
  type: 8
  section: Connect
  advanced: true
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  section: Connect
  advanced: true
  required: false
description: Listens to a mailbox and enables incident triggering via e-mail.
display: Mail Listener v2
name: Mail Listener v2
script:
  commands:
  - description: Retrieves emails according to the configuration.
    name: mail-listener-list-emails
    outputs:
    - contextPath: MailListener.EmailPreview.Subject
      description: The subject of the email.
      type: String
    - contextPath: MailListener.EmailPreview.Date
      description: The date when the mail was received.
      type: Date
    - contextPath: MailListener.EmailPreview.To
      description: The recipient of the email.
      type: String
    - contextPath: MailListener.EmailPreview.From
      description: The sender of the email.
      type: String
    - contextPath: MailListener.EmailPreview.ID
      description: The ID of the email.
      type: string
  - arguments:
    - description: The message ID retrieved from the 'mail-listener-list-emails' command.
      name: message-id
      required: true
    description: Retrieves an email by email ID.
    name: mail-listener-get-email
    outputs:
    - contextPath: MailListener.Email.to
      description: The recipients of the email.
      type: String
    - contextPath: MailListener.Email.cc
      description: The cc of the email.
      type: String
    - contextPath: MailListener.Email.bcc
      description: The bcc of the email.
      type: String
    - contextPath: MailListener.Email.from
      description: The sender of the email.
      type: String
    - contextPath: MailListener.Email.format
      description: The format of the email.
      type: String
    - contextPath: MailListener.Email.text
      description: The plain text of the email.
      type: String
    - contextPath: MailListener.Email.HTML
      description: The HTML display of the email, if it exists.
      type: String
    - contextPath: MailListener.Email.subject
      description: The subject of the email.
      type: String
    - contextPath: MailListener.Email.attachments
      description: The attachments of the email, if it exists.
      type: String
    - contextPath: MailListener.Email.headers
      description: The headers of the email.
      type: String
  - arguments:
    - description: The message ID retrieved from the 'mail-listener-list-emails' command.
      name: message-id
      required: true
    description: Fetches an email by message ID and returns the information in an eml file format.
    name: mail-listener-get-email-as-eml
  dockerimage: demisto/py3-tools:1.0.0.10120494
  isfetch: true
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- Mail-Listener Test Playbook
defaultmapperin: mail-listener-mapper
defaultclassifier: mail-listener
fromversion: 5.0.0