Gmail API を使用して POP と IMAP の設定を構成する

このドキュメントでは、Gmail API を使用して POP プロトコルと IMAP プロトコルを管理する方法について説明します。

Gmail のメールを他のメール クライアントで読むには、POP と IMAP の 2 つの方法があります。POP は、1 台のパソコン用に設計された古いプロトコルです。POP では、クライアントがメッセージをダウンロードし、新しいメッセージをダウンロードする頻度を指定します。IMAP は複数のデバイスで動作し、メールをリアルタイムで同期します。

Gmail API の settings リソースを使用して、Gmail で POP プロトコルと IMAP プロトコルを処理する方法を構成できます。

POP

アカウントの POP 設定は、PopSettings オブジェクトを使用して管理できます。

アクセスを有効または無効にする

accessWindow フィールドを使用してアクセスを制御します。このフィールドは、POP が有効かどうかと、API が取得するメッセージを決定します。

値 効果
disabled POP 経由でアクセスできるメッセージはありません
allMail 未取得のメッセージはすべて POP でアクセス可能
fromNowOn POP でアクセスできるのは新しいメッセージのみ

メール処理

API が取得するメッセージの処理を disposition フィールドで構成します。

値 効果
archive INBOX からメッセージを移動する
leaveInInbox 何もせず、INBOX のメッセージを未読のままにする
markRead INBOX にメッセージを残して既読にする
trash メッセージを TRASH に移動する

IMAP

アカウントの IMAP 設定は、ImapSettings オブジェクトを使用して管理できます。

アクセスを有効または無効にする

ブール値の enabled フィールドを使用してアクセスを制御します。このフィールドは、アカウントで IMAP が有効になっているかどうかを決定します。

メール処理

expungeBehavior フィールドを使用して、クライアントがメッセージを削除済みとしてマークし、最後に表示された IMAP フォルダから削除したときのメッセージの処理を構成します。

値 効果
archive 削除済みとしてマークされたメッセージを INBOX から移動する
deleteForever 削除済みとしてマークされたメッセージを完全に削除する
trash 削除済みとしてマークされたメッセージを TRASH に移動する

ブール値の autoExpunge フィールドが true の場合、クライアントが IMAP でメッセージを削除済みとしてマークすると、Gmail は直ちにメッセージを削除します。それ以外の場合、メッセージは IMAP クライアントが明示的に削除をリクエストするまで残ります。