Message.getThreadsInFolder

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Returns all of a user's messages and threads from the Inbox. The user needs to grant the calling application the read_mailbox extended permission.

This method is a wrapper around the thread and message FQL tables; you can achieve more fine-grained control by using those two FQL tables in conjunction with the fql.multiquery API call.

Applications must pass a valid session key or a user ID.

Parameters

RequiredNameTypeDescription
optional session_key string The session key of the logged in user. The session key is automatically included by our PHP client. Applications must specify either a valid session key for the current user or a uid..
folder_id int The ID of the folder you want to return. The ID can be one of: 0 (for Inbox), 1 (for Outbox), or 4 (for Updates).
uid int Indicates whether to include notifications that have already been read. By default, notifications a user has read are not included.
limit int Indicates the number of threads to return.
offset int Indicates how many threads to skip from the most recent thread.

Response

On success, returns an array of threads, where each contains an array of messages. Or else it returns an error code.

Notes

  • To get started, as a developer you can access the Inbox APIs via the read_mailbox permission in order to develop and test your application. To launch your application to all users, please apply to the Inbox API whitelist here.
  • You can call this method using a session secret, and not the application secret (for example, for a Facebook Connect site or desktop application).

See Also

reference