Method: users.messages.list

Kullanıcının posta kutusunda bulunan 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. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değeri kullanılabilir.

Sorgu parametreleri

Parametreler
maxResults

integer (uint32 format)

Döndürülecek maksimum mesaj 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

Listede belirli bir sonuç sayfasını almak için sayfa jetonu.

q

string

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

labelIds[]

string

Yalnızca belirtilen tüm etiket kimlikleriyle eşleşen etiketlere sahip iletileri döndürme. Bir mesaj dizisindeki mesajlar, aynı mesaj dizisindeki diğer mesajların sahip olmadığı etiketlere sahip olabilir. Daha fazla bilgi için Mesajlardaki ve ileti dizilerindeki etiketleri yönetme başlıklı makaleyi inceleyin.

includeSpamTrash

boolean

Sonuçlara SPAM ve TRASH iletilerini dahil edin.

İ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)

Mesaj listesi. Her mesaj kaynağının yalnızca bir id ve bir threadId içerdiğini unutmayın. messages.get yöntemi kullanılarak ek ileti ayrıntıları getirilebilir.

nextPageToken

string

Listede sonraki sonuç sayfasını almak için kullanılan jeton.

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 bakın.