Method mark_read

praw/models/inbox.py:99–129

Mark Comments or Messages as read. :param items: A list containing instances of :class:`.Comment` and/or :class:`.Message` to be marked as read relative to the authorized user's inbox. Requests are batched at 25 items (reddit limit). For example, to

(self, items: list[models.Comment | models.Message])

        self._reddit.post(API_PATH["read_all_messages"])

    def mark_read(self, items: list[models.Comment | models.Message]) -> None:
        """Mark Comments or Messages as read.

        :param items: A list containing instances of :class:`.Comment` and/or
            :class:`.Message` to be marked as read relative to the authorized user's
            inbox.

        Requests are batched at 25 items (reddit limit).

        For example, to mark all unread Messages as read, try:

        .. code-block:: python

            from praw.models import Message

            unread_messages = []
            for item in reddit.inbox.unread(limit=None):
                if isinstance(item, Message):
                    unread_messages.append(item)
            reddit.inbox.mark_read(unread_messages)

        .. seealso::

            - :meth:`.Comment.mark_read`
            - :meth:`.Message.mark_read`

        """
        while items:
            data = {"id": ",".join(x.fullname for x in items[:25])}
            self._reddit.post(API_PATH["read_message"], data=data)
            items = items[25:]

    def mark_unread(self, items: list[models.Comment | models.Message]) -> None:
        """Unmark Comments or Messages as read.