Method: users.messages.list

ব্যবহারকারীর মেইলবক্সে থাকা বার্তাগুলো তালিকাভুক্ত করে। আরও তথ্যের জন্য, ‘জিমেইল বার্তা তালিকা’ দেখুন।

HTTP অনুরোধ

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages

URL-টিতে gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়েছে।

পথের পরামিতি

প্যারামিটার
userId

string

ব্যবহারকারীর ইমেল ঠিকানা। প্রমাণীকৃত ব্যবহারকারীকে নির্দেশ করতে me বিশেষ মানটি ব্যবহার করা যেতে পারে।

কোয়েরি প্যারামিটার

প্যারামিটার
maxResults

integer ( uint32 format)

ফেরত পাঠানোর জন্য বার্তার সর্বোচ্চ সংখ্যা। এই ফিল্ডটির ডিফল্ট মান হলো ১০০। এই ফিল্ডের জন্য সর্বোচ্চ অনুমোদিত মান হলো ৫০০।

pageToken

string

তালিকার ফলাফলের একটি নির্দিষ্ট পৃষ্ঠা পুনরুদ্ধার করার জন্য পৃষ্ঠা টোকেন।

q

string

শুধুমাত্র নির্দিষ্ট কোয়েরির সাথে মেলে এমন মেসেজগুলোই ফেরত দেওয়া হবে। এটি জিমেইল সার্চ বক্সের মতো একই কোয়েরি ফরম্যাট সমর্থন করে। উদাহরণস্বরূপ, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" । gmail.metadata স্কোপ ব্যবহার করে এপিআই অ্যাক্সেস করার সময় প্যারামিটারটি ব্যবহার করা যাবে না।

labelIds[]

string

শুধুমাত্র সেই বার্তাগুলি ফেরত দিন যেগুলির লেবেল নির্দিষ্ট সমস্ত লেবেল আইডির সাথে মেলে। একটি থ্রেডের বার্তাগুলিতে এমন লেবেল থাকতে পারে যা একই থ্রেডের অন্য বার্তাগুলিতে নেই। আরও জানতে, বার্তা এবং থ্রেডের লেবেল পরিচালনা দেখুন।

includeSpamTrash

boolean

ফলাফলে SPAM এবং TRASH থেকে আসা বার্তাগুলোও অন্তর্ভুক্ত করুন।

অনুরোধকারী শরীর

অনুরোধের মূল অংশ অবশ্যই খালি হতে হবে।

প্রতিক্রিয়া সংস্থা

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
ক্ষেত্র
messages[]

object ( Message )

বার্তাগুলির তালিকা। উল্লেখ্য যে, প্রতিটি বার্তা রিসোর্সে শুধুমাত্র একটি id এবং একটি threadId থাকে। messages.get মেথড ব্যবহার করে বার্তার অতিরিক্ত বিবরণ পাওয়া যাবে।

nextPageToken

string

তালিকার পরবর্তী পৃষ্ঠার ফলাফল পাওয়ার টোকেন।

resultSizeEstimate

integer ( uint32 format)

ফলাফলের আনুমানিক মোট সংখ্যা।

অনুমোদনের পরিধি

নিম্নলিখিত OAuth স্কোপগুলির মধ্যে একটি প্রয়োজন:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

আরও তথ্যের জন্য, অনুমোদন নির্দেশিকা দেখুন।