Skip to main content

Usglobalmail Python Library

fern shield pypi

The Usglobalmail Python library provides convenient access to the Usglobalmail APIs from Python.

Table of Contents

Installation

pip install usgm

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from usgm import Usgm

client = Usgm(
    token="<token>",
)

client.mails.archive(
    id="id",
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from usgm import AsyncUsgm

client = AsyncUsgm(
    token="<token>",
)


async def main() -> None:
    await client.mails.archive(
        id="id",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from usgm.core.api_error import ApiError

try:
    client.mails.archive(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from usgm import Usgm

client = Usgm(...)
response = client.mails.with_raw_response.archive(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.mails.archive(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from usgm import Usgm

client = Usgm(..., timeout=20.0)

# Override timeout for a specific method
client.mails.archive(..., request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from usgm import Usgm

client = Usgm(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Metadata

Release files for usgm 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for usgm 1.0.4
File Size Uploaded Provenance Actions
usgm-1.0.4.tar.gz 67.8 kB Without provenance Details for usgm-1.0.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for usgm 1.0.4
File Interpreter ABI Platform Actions
usgm-1.0.4-py3-none-any.whl Python 3 none any Details for usgm-1.0.4-py3-none-any.whl

Total release size: 184.3 kB

Release files / usgm-1.0.4.tar.gz

Download URL usgm-1.0.4.tar.gz
Size 67.8 kB
Tags Source
SHA-256 checksum
How to use checksums
fb0a7cf36cf95caae755c7775cce9eac368f5e0cce85f53322acf4220384793f
BLAKE2b-256 checksum
How to use checksums
d1068aaba1279f113de6666b346ed52b811a4357c7e1ee0e93ecaf7a4a1d6055
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.2

Release files / usgm-1.0.4-py3-none-any.whl

Download URL usgm-1.0.4-py3-none-any.whl
Size 116.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
33f6a5c0da9ca7286ffa64141b84fb23b88266d820f48957dd1d7208aec3f2ad
BLAKE2b-256 checksum
How to use checksums
d6105161b81bd156e79494b1a05191b471afb90e7f9606d9cbc1e820c65abfb9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.2

Security for usgm 1.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page