woob.capabilities.messages

class Thread(id='', url=NotLoaded, backend=None)[source]

Bases: BaseObject

Thread containing messages.

Variables:

  • url – (str) url

  • root – (Message) Root message

  • title – (str) Title of thread

  • date – (date, datetime) Date of thread

  • flags – (int) Flags (IS_* constants) (default: 1)

IS_THREADS = 1
IS_DISCUSSION = 2
iter_all_messages()[source]

Iter all messages of the thread.

Return type:

iter[Message]

class Message(thread=NotLoaded, id=NotLoaded, title=NotLoaded, sender=NotLoaded, receivers=NotLoaded, date=None, parent=NotLoaded, content=NotLoaded, signature=NotLoaded, children=NotLoaded, flags=0, url=None)[source]

Bases: BaseObject

Represents a message read or to send.

Variables:

  • url – (str) url

  • thread – (Thread) Reference to the thread

  • title – (str) Title of message

  • sender – (str) Author of this message

  • receivers – (list) Receivers of the message

  • date – (date, datetime) Date when the message has been sent

  • content – (str) Body of message

  • signature – (str) Optional signature

  • parent – (Message) Parent message

  • children – (list) Children fields

  • flags – (int) Flags (IS_* constants) (default: 0)

IS_HTML = 1

The content is HTML formatted

IS_UNREAD = 2

The message is unread

IS_RECEIVED = 4

The receiver has read this message

IS_NOT_RECEIVED = 8

The receiver hass not read this message

property date_int

Date of message as an integer.

property full_id

Full ID of message (in form ‘THREAD_ID.MESSAGE_ID’)

property full_parent_id

Get the full ID of the parent message (in form ‘THREAD_ID.MESSAGE_ID’).

class CapMessages[source]

Bases: Capability

Capability to read messages.

iter_threads()[source]

Iterates on threads, from newers to olders.

Return type:

iter[Thread]

get_thread(id)[source]

Get a specific thread.

Return type:

Thread

iter_unread_messages()[source]

Iterates on messages which hasn’t been marked as read.

Return type:

iter[Message]

set_message_read(message)[source]

Set a message as read.

Parameters:

message (Message or str) – message read (or ID)

exception CantSendMessage[source]

Bases: UserError

Raised when a message can’t be send.

class CapMessagesPost[source]

Bases: Capability

This capability allow user to send a message.

post_message(message)[source]

Post a message.

Parameters:

message (Message) – message to send

Raises:

CantSendMessage