sedex 1.0.0

SEDEX Messagebox Manager

SEDEX Messagebox Manager

Purpose

This module simplifies the management of your message boxes with asynchronous data exchange via SEDEX.

You can search your inbox for specific message types or receiving times, clean up your inbox or send messages. All this with a few simple lines of Python.

This module never interferes with the SEDEX core functionality of secure data transmission but simplifies the management of in- and outbox.

Install

pip install sedex

That's it.

Versions

Version	Release Notes
1.0.0	universal package for py2 and py3
0.1.5	optional outbox parameter
0.1.4	detailed documentation
0.1.3	filter for latest message
0.1.2	publication for testing
0.1.1	initial publication

Examples

Get started

Create instance by specifying in- and outbox.

from sedex import semebo

messagebox = semebo.MessageBox(inbox=r"C:\sedex\inbox", outbox=r"C:\sedex\outbox")

Search for Messages

Scan your inbox for messages fullfilling secified criteria.

Get all messages received within the last 24h:

import datetime

for message in messagebox.scan_inbox(
    from_date=datetime.datetime.now() - datetime.timedelta(hours=24)
):
    print(message.data_file,
          message.envelope.sender_id,
          message.envelope.message_type)

Get the most recent message with message type 1819:

message = messagebox.scan_inbox(message_type=1819, latest=True):
print(message.data_file,
      message.envelope.sender_id,
      message.envelope.message_date)

Send Messages

Send the entire content of a folder:

data = r"C:\delivery\ready_to_ship"
transfer_id, envelope = messagebox.send_data(
    file_or_folder=data, 
    recipient_id="CH1848",
    sender_id="Z!1819",
    message_type=1819
)
print(transfer_id,
      envelope.message_id,
      envelope.message_date)

Clean-up Inbox

List candidates older than a week to preview cleanup:

messagebox.purge_inbox(older_than_days=7, dry_run=True)