lemmy_get_private_messages {remmy}

Get / fetch private messages.

Description

HTTP.GET /private_message/list

Usage

lemmy_get_private_messages(
  unread_only = NULL,
  page = NULL,
  limit = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

unread_only

(Optional) A logical value.

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

Default: "https://lemmy.world". Change the default instance by setting the lemmy_instance options().

Value

A list of length 1:

<list>
`-private_messages: <list>
  `-[Each element]: <list>
    |-private_message: <list>
    | |-id: A numeric value
    | |-creator_id: A numeric value
    | |-recipient_id: A numeric value
    | |-content: A character value
    | |-deleted: A logical value
    | |-read: A logical value
    | |-published: A character value
    | |-updated: (Optional) A character value
    | |-ap_id: A character value
    | `-local: A logical value
    |-creator: <list>
    | |-id: A numeric value
    | |-name: A character value
    | |-display_name: (Optional) A character value
    | |-avatar: (Optional) A character value
    | |-banned: A logical value
    | |-published: A character value
    | |-updated: (Optional) A character value
    | |-actor_id: A character value
    | |-bio: (Optional) A character value
    | |-local: A logical value
    | |-banner: (Optional) A character value
    | |-deleted: A logical value
    | |-inbox_url: A character value
    | |-matrix_user_id: (Optional) A character value
    | |-admin: A logical value
    | |-bot_account: A logical value
    | |-ban_expires: (Optional) A character value
    | `-instance_id: A numeric value
    `-recipient: <list>
      |-id: A numeric value
      |-name: A character value
      |-display_name: (Optional) A character value
      |-avatar: (Optional) A character value
      |-banned: A logical value
      |-published: A character value
      |-updated: (Optional) A character value
      |-actor_id: A character value
      |-bio: (Optional) A character value
      |-local: A logical value
      |-banner: (Optional) A character value
      |-deleted: A logical value
      |-inbox_url: A character value
      |-matrix_user_id: (Optional) A character value
      |-admin: A logical value
      |-bot_account: A logical value
      |-ban_expires: (Optional) A character value
      `-instance_id: A numeric value