Package screenlets :: Package plugins :: Module Mail :: Class MailCheckBackend

[hide private]
[frames] | no frames]

# Class MailCheckBackend

source code

         object --+
                  |
    gobject.GObject --+
                      |
                     MailCheckBackend

Known Subclasses:
  IMAPBackend, POP3Backend

The backend class which performs checking for mail and offers access to the current mail-backend. By subclassing this class you can add multiple mail-backends to the MailCheckScreenlet (e.g. pop3, maildir, imap, gmail, ...).

Instance Methods | [hide private]

__init__(self, name, screenlet) x.__init__(...) initializes x; see x.__class__.__doc__ for signature | source code

check_mail(self) This handler should be overridden by subclasses to add new types of checking mails in a backend. | source code

stop(self) Stop receiving mails from the backend. | source code

start(self) Start receiving mails from the backend. | source code

__execute(self) Execute the thread and call the check-mail function. | source code

Inherited from `gobject.GObject`: `__cmp__`, `__delattr__`, `__gdoc__`, `__gobject_init__`, `__hash__`, `__new__`, `__repr__`, `__setattr__`, `chain`, `connect`, `connect_after`, `connect_object`, `connect_object_after`, `disconnect`, `disconnect_by_func`, `emit`, `emit_stop_by_name`, `freeze_notify`, `get_data`, `get_properties`, `get_property`, `handler_block`, `handler_block_by_func`, `handler_disconnect`, `handler_is_connected`, `handler_unblock`, `handler_unblock_by_func`, `notify`, `props`, `set_data`, `set_properties`, `set_property`, `stop_emission`, `thaw_notify`, `weak_ref`

Inherited from `object`: `__getattribute__`, `__reduce__`, `__reduce_ex__`, `__str__`

Class Variables | [hide private]

| __gsignals__ = `{'check_finished':(gobject.SIGNAL_RUN_LAST, gob`...``
| __gtype__ = `<GType screenlets+plugins+Mail+MailCheckBackend (1`...``

Properties | [hide private]

Inherited from `gobject.GObject`: `__grefcount__` Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, name, screenlet)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: gobject.GObject.__init__
  (inherited documentation)

### check_mail(self)

source code

This handler should be overridden by subclasses to add new types of checking mails in a backend. This handler has to set self.mailcount to the number of mails found in the backend. The return value is ignored, set self.error and self.status to return results.

### stop(self)

source code

Stop receiving mails from the backend. This should be overridden by subclasses.

### start(self)

source code

Start receiving mails from the backend. Runs self.__execute as a separate thread.

Class Variable Details | [hide private]

### __gsignals__

Value:

      {'check_finished':(gobject.SIGNAL_RUN_LAST, gobject.TYPE_NONE, (gobjec
      t.TYPE_INT, gobject.TYPE_INT,))}

### __gtype__

Value:

      <GType screenlets+plugins+Mail+MailCheckBackend (151349856)>