JmailClient - Jmail Data API

コンストラクタ

JmailClient(cache=True)

新しいクライアントインスタンスを生成します。

パラメータ

bool

デフォルト:"True"

ローカルの ETag ベースのファイルキャッシュを ~/.cache/jmail/ 配下で有効にします。常に最新データをダウンロードするには False に設定します。

使用例

from jmail import JmailClient

# デフォルト: キャッシュが有効
client = JmailClient()

# キャッシュを無効化
client = JmailClient(cache=False)

メソッド

メソッド	戻り値	説明
`manifest()`	`dict`	データセットメタデータを含む API マニフェスト
`emails(slim)`	`DataFrame`	メールアーカイブ
`documents(include_text)`	`DataFrame`	ドキュメントのメタデータ／テキスト
`photos()`	`DataFrame`	写真のメタデータ
`people()`	`DataFrame`	識別済み人物
`photo_faces()`	`DataFrame`	顔のバウンディングボックス
`imessage_conversations()`	`DataFrame`	iMessage 会話
`imessage_messages()`	`DataFrame`	iMessage メッセージ
`star_counts()`	`DataFrame`	クラウドソーシングによるスター数
`release_batches()`	`DataFrame`	リリースバッチ情報
`url(dataset, fmt)`	`str`	データセットの生 URL

`manifest()`

データセットのメタデータとチェックサムを含む API マニフェストを取得します。

manifest = client.manifest()
print(manifest)

戻り値: dict — data.jmail.world/v1/manifest.json から取得した JSON を解析した結果

`url(dataset, fmt="parquet")`

データセットファイルの生のURLを取得します。DuckDB、Polars、その他HTTP経由でParquetを読み込めるツールに直接渡すのに便利です。

url = client.url("emails-slim")
# "https://data.jmail.world/v1/emails-slim.parquet"

url = client.url("documents", fmt="ndjson.gz")
# "https://data.jmail.world/v1/documents.ndjson.gz"

str

必須

データセット名。次のいずれかです: emails, emails-slim, documents, photos, people, photo_faces, imessage_conversations, imessage_messages, star_counts, release_batches.

str

デフォルト:"parquet"

ファイル形式。parquet または ndjson.gz のいずれかです。

戻り値: str — 完全な URL を表す文字列

​コンストラクタ

​パラメータ

​使用例

​メソッド

​manifest()

​url(dataset, fmt="parquet")

コンストラクタ

パラメータ

使用例

メソッド

`manifest()`

`url(dataset, fmt="parquet")`