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

Listedeki belirli bir sonuç sayfasını almak için sayfa jetonu.
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". Bu 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ür. Bir ileti dizisindeki iletiler, aynı ileti dizisindeki diğer iletilerde bulunmayan etiketlere sahip olabilir. Daha fazla bilgi edinmek için İletiler ve ileti dizilerindeki etiketleri yönetme başlıklı makaleye bakın.
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)

Mesaj 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

Listedeki sonuçların sonraki 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ılavuzunu inceleyin.