REST Resource: users.messages

संसाधन: मैसेज

ईमेल मैसेज.

JSON के काेड में दिखाना
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
फ़ील्ड
id

string

ईमेल का बदला न जा सकने वाला आईडी.

threadId

string

उस थ्रेड का आईडी जिससे मैसेज जुड़ा है. किसी थ्रेड में मैसेज या ड्राफ़्ट जोड़ने के लिए, इन शर्तों को पूरा करना ज़रूरी है:

  1. अनुरोध किए गए threadId की जानकारी, आपके अनुरोध के साथ सबमिट किए गए Message या Draft.Message में दी गई होनी चाहिए.
  2. References और In-Reply-To हेडर, RFC 2822 स्टैंडर्ड के मुताबिक सेट किए जाने चाहिए.
  3. Subject हेडर मेल खाने चाहिए.

labelIds[]

string

इस मैसेज पर लागू किए गए लेबल के आईडी की सूची.

snippet

string

मैसेज के टेक्स्ट का छोटा हिस्सा.

historyId

string

यह उस इतिहास के आखिरी रिकॉर्ड का आईडी है जिसने इस मैसेज में बदलाव किया था.

internalDate

string (int64 format)

मैसेज बनाए जाने का इंटरनल टाइमस्टैंप (epoch ms). इससे इनबॉक्स में मैसेज के क्रम का पता चलता है. एसएमटीपी से मिले सामान्य ईमेल के लिए, यह उस समय को दिखाता है जब Google ने मैसेज को स्वीकार किया था. यह Date हेडर से ज़्यादा भरोसेमंद होता है. हालांकि, एपीआई से माइग्रेट किए गए ईमेल के लिए, क्लाइंट इसे Date हेडर के आधार पर कॉन्फ़िगर कर सकता है.

payload

object (MessagePart)

मैसेज के हिस्सों में पार्स किया गया ईमेल स्ट्रक्चर.

sizeEstimate

integer

मैसेज का अनुमानित साइज़, बाइट में.

raw

string (bytes format)

पूरा ईमेल मैसेज, आरएफ़सी 2822 के हिसाब से फ़ॉर्मैट किया गया है. साथ ही, इसे base64url के ज़रिए एन्कोड किया गया है. format=RAW पैरामीटर की वैल्यू देने पर, messages.get और drafts.get के जवाबों में यह वैल्यू दिखती है.

base64 कोड में बदली गई स्ट्रिंग.

classificationLabelValues[]

object (ClassificationLabelValue)

मैसेज पर क्लासिफ़िकेशन लेबल की वैल्यू. Google Drive Labels API का इस्तेमाल करके, उपलब्ध क्लासिफ़िकेशन लेबल स्कीमा के बारे में क्वेरी की जा सकती है. हर क्लासिफ़िकेशन लेबल आईडी यूनीक होना चाहिए. अगर डुप्लीकेट आईडी दिए जाते हैं, तो सिर्फ़ एक आईडी को रखा जाएगा. साथ ही, यह आईडी किसी भी आईडी को चुना जा सकता है. इसका इस्तेमाल सिर्फ़ Google Workspace खातों के लिए किया जाता है. हर अनुरोध में, क्लासिफ़िकेशन लेबल की ज़्यादा से ज़्यादा 20 वैल्यू शामिल की जा सकती हैं. अगर कैटगरी के लेबल की वैल्यू, तय सीमा से ज़्यादा है, तो अनुरोध पूरा नहीं होगा.

MessagePart

एक MIME मैसेज का हिस्सा.

JSON के काेड में दिखाना
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
फ़ील्ड
partId

string

मैसेज के हिस्से का बदला नहीं जा सकने वाला आईडी.

mimeType

string

मैसेज के हिस्से का MIME टाइप.

filename

string

अटैचमेंट की फ़ाइल का नाम. यह सिर्फ़ तब मौजूद होता है, जब मैसेज का यह हिस्सा किसी अटैचमेंट को दिखाता है.

headers[]

object (Header)

इस मैसेज के हिस्से पर मौजूद हेडर की सूची. पूरे मैसेज पेलोड को दिखाने वाले टॉप-लेवल मैसेज पार्ट में, RFC 2822 के स्टैंडर्ड ईमेल हेडर शामिल होंगे. जैसे, To, From, और Subject.

body

object (MessagePartBody)

इस हिस्से के लिए मैसेज का मुख्य हिस्सा. कंटेनर MIME मैसेज के हिस्सों के लिए, यह खाली हो सकता है.

parts[]

object (MessagePart)

इस हिस्से के चाइल्ड MIME मैसेज के हिस्से. यह सिर्फ़ कंटेनर MIME मैसेज के हिस्सों पर लागू होता है. जैसे, multipart/*. text/plain जैसे नॉन-कंटेनर MIME मैसेज पार्ट टाइप के लिए, यह फ़ील्ड खाली होता है. ज़्यादा जानकारी के लिए, आरएफ़सी 1521 देखें.

JSON के काेड में दिखाना
{
  "name": string,
  "value": string
}
फ़ील्ड
name

string

: सेपरेटर से पहले मौजूद हेडर का नाम. उदाहरण के लिए, To.

value

string

: सेपरेटर के बाद हेडर की वैल्यू. उदाहरण के लिए, someuser@example.com.

ClassificationLabelValue

ईमेल मैसेज पर लागू किए गए क्लासिफ़िकेशन लेबल. क्लासिफ़िकेशन लेबल, Gmail इनबॉक्स के लेबल से अलग होते हैं. इसका इस्तेमाल सिर्फ़ Google Workspace खातों के लिए किया जाता है. डेटा को अलग-अलग ग्रुप में बांटने वाले लेबल के बारे में ज़्यादा जानें.

JSON के काेड में दिखाना
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
फ़ील्ड
labelId

string

ज़रूरी है. कैननिकल या रॉ अल्फ़ान्यूमेरिक क्लासिफ़िकेशन लेबल आईडी. यह Google Drive के लेबल संसाधन के आईडी फ़ील्ड से मैप होता है.

fields[]

object (ClassificationLabelFieldValue)

दिए गए क्लासिफ़िकेशन लेबल आईडी के लिए फ़ील्ड की वैल्यू.

ClassificationLabelFieldValue

क्लासिफ़िकेशन लेबल के लिए फ़ील्ड वैल्यू.

JSON के काेड में दिखाना
{
  "fieldId": string,
  "selection": string
}
फ़ील्ड
fieldId

string

ज़रूरी है. क्लासिफ़िकेशन लेबल की वैल्यू के लिए फ़ील्ड आईडी. यह Google Drive Label.Field ऑब्जेक्ट के आईडी फ़ील्ड से मैप होता है.

selection

string

चुने गए विकल्प के लिए, चुनने के विकल्प का आईडी. इस फ़ील्ड को सिर्फ़ तब सेट किया जाना चाहिए, जब Google Drive Label.Field ऑब्जेक्ट में फ़ील्ड टाइप SELECTION हो. यह Google Drive Label.Field.SelectionOptions संसाधन के आईडी फ़ील्ड से मैप करता है.

तरीके

batchDelete

यह मैसेज आईडी के हिसाब से कई मैसेज मिटाता है.

batchModify

यह फ़ंक्शन, चुने गए मैसेज के लेबल और क्लासिफ़िकेशन लेबल की वैल्यू में बदलाव करता है.

delete

यह विकल्प, चुने गए मैसेज को तुरंत और हमेशा के लिए मिटा देता है.

get

यह कुकी, तय किया गया मैसेज दिखाती है.

import

यह फ़ंक्शन, मैसेज को सिर्फ़ इस उपयोगकर्ता के मेलबॉक्स में इंपोर्ट करता है. साथ ही, ईमेल डिलीवरी के लिए स्टैंडर्ड स्कैनिंग और कैटगरी तय करने की सुविधा का इस्तेमाल करता है. यह सुविधा, एसएमटीपी के ज़रिए ईमेल पाने की सुविधा की तरह ही होती है.

insert

यह सीधे तौर पर सिर्फ़ इस उपयोगकर्ता के मेलबॉक्स में मैसेज डालता है. यह IMAP APPEND की तरह काम करता है. इसमें ज़्यादातर स्कैनिंग और क्लासिफ़िकेशन को अनदेखा किया जाता है.

list

उपयोगकर्ता के मेलबॉक्स में मौजूद मैसेज की सूची दिखाता है.

modify

यह फ़ंक्शन, चुने गए मैसेज के लेबल और क्लासिफ़िकेशन लेबल की वैल्यू में बदलाव करता है.

send

To, Cc, और Bcc हेडर में मौजूद लोगों को चुना गया मैसेज भेजता है.

trash

इस तरीके का इस्तेमाल करके, चुने गए मैसेज को ट्रैश में ले जाया जाता है.

untrash

इस तरीके से, ट्रैश से चुना गया मैसेज हटा दिया जाता है.