Message

class praw.models.Message(reddit, _data)

A class for private messages.

Typical Attributes

This table describes attributes that typically belong to objects of this class. Since attributes are dynamically provided (see Determine Available Attributes of an Object), there is not a guarantee that these attributes will always be present, nor is this list comprehensive in any way.

Attribute Description
author Provides an instance of Redditor.
body The body of the message.
created_utc Time the message was created, represented in Unix Time.
dest Provides an instance of Redditor. The recipient of the message.
id The ID of the message.
name The full ID of the message, prefixed with ‘t4’.
subject The subject of the message.
subreddit If the message was sent from a subreddit, provides an instance of Subreddit.
was_comment Whether or not the message was a comment reply.
__init__(reddit, _data)

Construct an instance of the Message object.

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()

delete()

Delete the message.

Note

Reddit does not return an indication of whether or not the message was successfully deleted.

fullname

Return the object’s fullname.

A fullname is an object’s kind mapping like t3 followed by an underscore and the object’s base36 ID, e.g., t1_c5s96e0.

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 praw.models.Inbox.mark_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()

classmethod parse(data, reddit)

Return an instance of Message or SubredditMessage from data.

Parameters:
  • data – The structured data.
  • reddit – An instance of Reddit.
reply(body)

Reply to the object.

Parameters:body – The markdown formatted content for a comment.
Returns:A Comment object for the newly created comment.

Example usage:

submission = reddit.submission(id='5or86n')
submission.reply('reply')

comment = reddit.comment(id='dxolpyc')
comment.reply('reply')
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()

Note

This list of attributes is not complete. PRAW dynamically provides the attributes that Reddit returns via the API. Because those attributes are subject to change on Reddit’s end, PRAW makes no effort to document them, other than to instruct you on how to discover what is available. See Determine Available Attributes of an Object for detailed information.