Skip to main content

Tool to Process Smart Search Results and Identify Top Senders

Project description

Proofpoint Sender Analyzer

This tool helps identify the top senders based on smart search outbound message exports or CSV data.

Requirements:

  • Python 3.9+

Installing the Package

You can install the tool using the following command directly from Github.

pip install git+https://github.com/pfptcommunity/senderstats.git

or can install the tool using pip.

pip install senderstats

Use Cases:

Outbound message volumes and data transferred by:

  • Envelope sender
  • Header From:
  • Envelope sender and header From: for SPF alignment purposes

Summarize message volume information:

  • Estimated application email traffic based on sender volume threshold:
    • Estimated application data
    • Estimated application messages
    • Estimated application average size
    • Estimated application peak hourly volume
  • Total outbound data
    • Total outbound data
    • Total outbound messages
    • Total outbound average size
    • Total outbound peak hourly volume

Using the Tool

Export all outbound message traffic as a smart search CSV. You may need to export multiple CSVs if the data per time window exceeds 1M records. The tool can ingest multiple CSVs.

smart_search_outbound

Added support for alternate CSV formats by changing the header fields.

usage: senderstats [-h] -i <file> [<file> ...] [--from-field FromField] [--sender-field SenderField] [--msg-size SizeField] [--date-field DateField] [--date-format DateFormat] [--excluded-domains <domain> [<domain> ...]] -o
                   <xlsx> [-t THRESHOLD]

This tool helps identify the top senders based on smart search outbound message exports.

optional arguments:
  -h, --help                                           show this help message and exit
  -i <file> [<file> ...], --input <file> [<file> ...]  Smart search files to read.
  --from-field FromField                               CSV field of the header From: address. (default=Header_From)
  --sender-field SenderField                           CSV field of the From: address. (default=Message_Size)
  --msg-size SizeField                                 CSV field of message size. (default=Message_Size)
  --date-field DateField                               CSV field of message date. (default=Date)
  --date-format DateFormat                             Date format used to parse the timestamps. (default=%Y-%m-%dT%H:%M:%S.%f%z)
  --excluded-domains <domain> [<domain> ...]           Restrict domains to a set of domains.
  -o <xlsx>, --output <xlsx>                           Output file
  -t THRESHOLD, --threshold THRESHOLD                  Integer representing number of messages per day to be considered application traffic. (default=100)

image

Sample Output:

image

Sample Details (Sender + From by Volume):

image

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

senderstats-1.1.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

senderstats-1.1.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file senderstats-1.1.1.tar.gz.

File metadata

  • Download URL: senderstats-1.1.1.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for senderstats-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e21b3f852d738620eddf5ddfc35a350089814003b159d1e38b3fa20630ad49cc
MD5 9c2f3a413d56c90b79eed75f2da7c99f
BLAKE2b-256 f2d4f2bffa8ab1c0ce5ad9379664312deeca58be31109bbc1e72064a2334a5a2

See more details on using hashes here.

File details

Details for the file senderstats-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: senderstats-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for senderstats-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4fdc3bebc92913fedf1409fdfb53f01482a91329981f4f2aa6dbddf97ba96876
MD5 4480e813245712f77a8cb98862eb91d0
BLAKE2b-256 a0d9bae0c0e72c787072808b8b08aed795ac59d95da85c76bcd336ecfd489f18

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page