Python SDK

1
import os
2
from usgm import Usgm
3
4
usgm = Usgm(token=os.environ["USGM_API_KEY"])  # never hard-code the key

1
# Your account profile
2
account = usgm.account.get()
3
print(account.email, account.status)
4
5
# List mail, one page at a time (cursor pagination)
6
cursor = None
7
while True:
8
    page = usgm.mails.list(cursor=cursor)
9
    for mail in page.data:
10
        print(mail.id, mail.sender_name)
11
    cursor = page.next_cursor
12
    if cursor is None:
13
        break
14
15
# Fetch one item
16
mail = usgm.mails.get(id="80421")
17
18
# Create a folder
19
folder = usgm.folders.create(name="Taxes")

1
import asyncio
2
from usgm import AsyncUsgm
3
4
usgm = AsyncUsgm(token=os.environ["USGM_API_KEY"])
5
6
async def main():
7
    page = await usgm.mails.list()
8
    for mail in page.data:
9
        print(mail.id)
10
11
asyncio.run(main())

1
from usgm.core.api_error import ApiError
2
3
try:
4
    usgm.mails.get(id="does-not-exist")
5
except ApiError as err:
6
    # `body` is the RFC 9457 problem+json payload (code, request_id, detail, …)
7
    print(err.status_code, err.body)
8
    raise