Method stream

praw/models/inbox.py:227–243

Yield new inbox items as they become available. Items are yielded oldest first. Up to 100 historical items will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. For example, to retrieve all new inbox items, try: .. code-blo

(self, **stream_options: Any)

        return ListingGenerator(self._reddit, API_PATH["sent"], **generator_kwargs)

    def stream(self, **stream_options: Any) -> Iterator[models.Comment | models.Message]:
        """Yield new inbox items as they become available.

        Items are yielded oldest first. Up to 100 historical items will initially be
        returned.

        Keyword arguments are passed to :func:`.stream_generator`.

        For example, to retrieve all new inbox items, try:

        .. code-block:: python

            for item in reddit.inbox.stream():
                print(item)

        """
        return stream_generator(self.unread, **stream_options)

    def submission_replies(self, **generator_kwargs: Any) -> Iterator[models.Comment]:
        """Return a :class:`.ListingGenerator` for submission replies.