messages.md

Messages

Full inbox/outbox management with threading, attachments, and label support.

Reading Messages

from smartschool import Smartschool, PathCredentials, MessageHeaders, Message, BoxType

session = Smartschool(PathCredentials())

# List inbox messages (default)
for header in MessageHeaders(session):
    print(f"{'[NEW] ' if header.unread else ''}From: {header.from_} - {header.subject} ({header.date})")

# List sent messages
for header in MessageHeaders(session, box_type=BoxType.SENT):
    print(f"{header.subject}")

Available box types: INBOX, DRAFT, SCHEDULED, SENT, TRASH.

Sorting

from smartschool import SortField, SortOrder

# Sort by sender, ascending
headers = MessageHeaders(session, sort_by=SortField.FROM, sort_order=SortOrder.ASC)

Available sort fields: DATE, FROM, READ_UNREAD, ATTACHMENT, FLAG.

Full Message Content

header = list(MessageHeaders(session))[0]

for msg in Message(session, header.id):
    print(f"From: {msg.from_}")
    print(f"Subject: {msg.subject}")
    print(f"Body: {msg.body}")
    print(f"Receivers: {msg.receivers}")

Attachments

from smartschool import Attachments
from pathlib import Path

for header in MessageHeaders(session):
    if header.attachment:
        for attachment in Attachments(session, header.id):
            content = attachment.download()
            Path(f"attachments/{attachment.name}").write_bytes(content)
            print(f"Downloaded: {attachment.name} ({attachment.size})")

Message Operations

Mark as Unread

from smartschool import MarkMessageUnread

result = list(MarkMessageUnread(session, msg_id=12345))[0]

Apply Labels

from smartschool import AdjustMessageLabel, MessageLabel

list(AdjustMessageLabel(session, msg_id=12345, label=MessageLabel.RED_FLAG))

Available labels: NO_FLAG, GREEN_FLAG, YELLOW_FLAG, RED_FLAG, BLUE_FLAG.

Archive and Delete

from smartschool import MessageMoveToArchive, MessageMoveToTrash

# Archive one or multiple messages
MessageMoveToArchive(session, msg_id=12345).get()
MessageMoveToArchive(session, msg_id=[12345, 67890]).get()

# Move to trash
list(MessageMoveToTrash(session, msg_id=12345))

Polling for New Messages

Use already_seen_message_ids to only get new messages:

seen_ids = []

for header in MessageHeaders(session, already_seen_message_ids=seen_ids):
    print(f"New: {header.subject}")
    seen_ids.append(header.id)