REST Resource: customers.quarantinedMessages

リソース: QuarantinedMessage

QuarantinedMessage リソースは、管理検疫に保持されているメール メッセージを表します。

JSON 表現 
{
  "name": string,
  "messageId": string,
  "messageOwner": string,
  "quarantines": [
    string
  ],
  "receiveTime": string,
  "direction": enum (Direction),
  "state": enum (State),
  "retentionExpireTime": string,
  "triggeredRules": [
    {
      object (TriggeredRule)
    }
  ],
  "content": {
    object (MessageContent)
  },
  "rawMessage": string
}
フィールド
name

string

ID。検疫されたメールのリソース名。形式: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}
messageId

string

出力専用。基盤となる Gmail メッセージの不変 ID。
messageOwner

string

出力専用。このメッセージのオーナーのメールアドレス。
quarantines[]

string

出力専用。このメールが属する検疫のリソース名。形式: customers/{customer_id}/quarantines/{quarantine_id}
receiveTime

string (Timestamp format)

出力専用。メッセージが受信されたときのタイムスタンプ。
direction

enum (Direction)

出力専用。メッセージの方向（INBOUND、OUTBOUND など）。
state

enum (State)

出力専用。メッセージの現在の処理状態。
retentionExpireTime

string (Timestamp format)

出力専用。このメッセージが保持されるタイムスタンプ。
triggeredRules[]

object (TriggeredRule)

出力専用。検疫の原因となったルールに関する情報。
content

object (MessageContent)

出力専用。検疫されたメールの詳細なコンテンツとメタデータ。
rawMessage

string (bytes format)

出力専用。RFC 2822 形式で base64url エンコードされた文字列のメール メッセージ全体。RAW コンテンツ タイプが選択されている場合に返されます。

方向

メッセージの方向。

列挙型
DIRECTION_UNSPECIFIED 指定なし。
INBOUND 検疫されたメールがユーザーに受信された。
OUTBOUND 検疫されたメールはユーザーによって送信された。

州

メッセージの現在の処理状態。

列挙型
STATE_UNSPECIFIED 指定なし。
PENDING_TRIAGE メールが検疫対象になっている。
RELEASED メールが検疫対象から外されました。
DENIED 検疫中にメールが拒否されました。

TriggeredRule

メールが検疫に送信される原因となった特定のルールに関する情報。

JSON 表現 
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
フィールド
policyId

string

確立されたルールが関連付けられているポリシー ID。
ruleId

string

確立された特定のルールの ID。
displayName

string

確立されたルールの名前または説明。

MessageContent

検疫されたメール メッセージの内容に関する詳細情報。

JSON 表現 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "body": string,
  "subject": string,
  "labels": [
    string
  ],
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
フィールド
headers[]

object (Header)

メール メッセージのヘッダー。
attachments[]

object (Attachment)

メール メッセージ内の添付ファイル。
body

string

メール メッセージの書式なしテキストの本文またはスニペット。
subject

string

メール メッセージの件名。
labels[]

string

メールに適用されている標準ラベル（「QUARANTINE」など）。
classificationLabelValues[]

object (ClassificationLabelValue)

メールに適用された分類ラベルの値。Google Workspace アカウントにのみ存在します。

添付ファイル

メール メッセージ内の添付ファイル。

JSON 表現 
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
フィールド
filename

string

添付ファイルのファイル名。
mimeType

string

添付ファイルの MIME タイプ（例: "application/pdf"）。
sizeBytes

string (int64 format)

添付ファイルのサイズ（バイト単位）。
attachmentId

string

添付ファイルのコンテンツを取得するために使用される固有識別子。

ClassificationLabelValue

メールに適用された分類ラベル。

JSON 表現 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
フィールド
labelId

string

正規または未加工の英数字の分類ラベル ID。
fields[]

object (ClassificationLabelFieldValue)

指定された分類ラベル ID のフィールド値。

ClassificationLabelFieldValue

分類ラベルのフィールド値。

JSON 表現 
{
  "fieldId": string,
  "selection": string
}
フィールド
fieldId

string

分類ラベル値のフィールド ID。
selection

string

選択オプションの選択肢 ID。

メソッド

batchDeny

 メッセージのリストを非同期で拒否します。

batchRelease

 メッセージのリストを非同期で解放します。

deny

 検疫からメッセージを拒否します。

get

 検疫されたメールのメタデータとコンテンツを取得します。

list

 特定のフィルタ条件を使用して、検疫されたメッセージをクエリします。

release

 検疫からメールを解除して、受信者に配信します。
特定の検索クエリを使用して検疫されたメールを検索します。