Method: users.messages.list

Kullanıcının posta kutusundaki iletileri listeler.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
userId

string

Kullanıcının e-posta adresi. me özel değeri, kimliği doğrulanmış kullanıcıyı belirtmek için kullanılabilir.

Sorgu parametreleri

Parametreler
maxResults

integer (uint32 format)

Döndürülecek maksimum ileti sayısı. Bu alanın varsayılan değeri 100'dür. Bu alan için izin verilen maksimum değer 500'dür.

pageToken

string

Sayfa jetonu 'nu kullanın.

q

string

Yalnızca belirtilen sorguyla eşleşen iletileri döndürür. Gmail arama kutusuyla aynı sorgu biçimini destekler. Örneğin, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". gmail.metadata kapsamı kullanılarak API'ye erişilirken parametre kullanılamaz.

labelIds[]

string

Yalnızca belirtilen tüm etiket kimlikleriyle eşleşen etiketlere sahip iletileri döndürür. Bir ileti dizisindeki iletilerin etiketleri, aynı ileti dizisindeki diğer iletilerde bulunmaz. Daha fazla bilgi edinmek için İletiler ve mesaj dizilerindeki etiketleri yönetme başlıklı makaleyi inceleyin.

includeSpamTrash

boolean

Sonuçlara SPAM ve TRASH tarafından gönderilen iletileri dahil et.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Alanlar
messages[]

object (Message)

İleti listesi. Her mesaj kaynağının yalnızca bir id ve threadId içerdiğini unutmayın. Ek ileti ayrıntıları, messages.get yöntemi kullanılarak alınabilir.

nextPageToken

string

Jeton, listedeki sonuçların sonraki sayfasını almak için kullanılır.

resultSizeEstimate

integer (uint32 format)

Tahmini toplam sonuç sayısı.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.