Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# InboxableMixin

class praw.models.reddit.mixins.InboxableMixin

  Interface for `RedditBase` subclasses that originate from the inbox.

  __init__()
  block()

    Block the user who sent the item.

    Note

    This method pertains only to objects which were retrieved via the inbox.

    Example usage:

        comment = reddit.comment("dkk4qjd")
        comment.block()

        # or, identically:

        comment.author.block()

  collapse()

    Mark the item as collapsed.

    Note

    This method pertains only to objects which were retrieved via the inbox.

    Example usage:

        inbox = reddit.inbox()

        # select first inbox item and collapse it message = next(inbox)
        message.collapse()

    See also

    `uncollapse()`

  mark_read()

    Mark a single inbox item as read.

    Note

    This method pertains only to objects which were retrieved via the inbox.

    Example usage:

        inbox = reddit.inbox.unread()

        for message in inbox:
            # process unread messages
            ...

    See also

    `mark_unread()`

    To mark the whole inbox as read with a single network request, use `Inbox.mark_all_read()`

  mark_unread()

    Mark the item as unread.

    Note

    This method pertains only to objects which were retrieved via the inbox.

    Example usage:

        inbox = reddit.inbox(limit=10)

        for message in inbox:
            # process messages
            ...

    See also

    `mark_read()`

  unblock_subreddit()

    Unblock a subreddit.

    Note

    This method pertains only to objects which were retrieved via the inbox.

    For example, to unblock all blocked subreddits that you can find by going through your inbox:

        from praw.models import SubredditMessage

        subs = set()
        for item in reddit.inbox.messages(limit=None):
            if isinstance(item, SubredditMessage):
                if (
                    item.subject == "[message from blocked subreddit]"
                    and str(item.subreddit) not in subs
                ):
                    item.unblock_subreddit()
                    subs.add(str(item.subreddit))

  uncollapse()

    Mark the item as uncollapsed.

    Note

    This method pertains only to objects which were retrieved via the inbox.

    Example usage:

        inbox = reddit.inbox()

        # select first inbox item and uncollapse it
        message = next(inbox)
        message.uncollapse()

    See also

    `collapse()`