Limnoria-doc/use/plugins/note.rst

.. _plugin-note:

The Note plugin
===============

Reading notes
-------------

.. _command-note-search:

note search [--{regexp} <value>] [--sent] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Searches your received notes for ones matching *<glob>*.  If *--regexp* is
given, its associated value is taken as a regexp and matched against
the notes.  If *--sent* is specified, only search sent notes.

.. _command-note-list:

note list [--{old,sent}] [--{from,to} <user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Retrieves the ids of all your unread notes.  If *--old* is given, list
read notes.  If *--sent* is given, list notes that you have sent.  If
*--from* is specified, only lists notes sent to you from *<user>*.  If
*--to* is specified, only lists notes sent by you to *<user>*.

.. _command-note-next:

note next
^^^^^^^^^

Retrieves your next unread note, if any.

.. _command-note-note:

note note <id>
^^^^^^^^^^^^^^

Retrieves a single note by its unique note id.  Use the 'note list'
command to see what unread notes you have.

Sending notes
-------------

.. _command-note-unsend:

note unsend <id>
^^^^^^^^^^^^^^^^

Unsends the note with the id given.  You must be the
author of the note, and it must be unread.

.. _command-note-reply:

note reply <id> <text>
^^^^^^^^^^^^^^^^^^^^^^

Sends a note in reply to *<id>*.

.. _command-note-send:

note send <recipient>,[<recipient>,[...]] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sends a new note to the user specified.  Multiple recipients may be
specified by separating their names by commas.



.. _plugin-note-config:

Configuration
-------------

.. _supybot.plugins.Note.notify:

supybot.plugins.Note.notify
^^^^^^^^^^^^^^^^^^^^^^^^^^^





.. _supybot.plugins.Note.notify.onJoin:

supybot.plugins.Note.notify.onJoin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default value: False

Determines whether the bot will notify people of their new messages when they join the channel. Normally it will notify them when they send a message to the channel, since oftentimes joins are the result of netsplits and not the actual presence of the user.

.. _supybot.plugins.Note.notify.onJoin.repeatedly:

supybot.plugins.Note.notify.onJoin.repeatedly
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default value: False

Determines whether the bot will repeatedly notify people of their new messages when they join the channel. That means when they join the channel, the bot will tell them they have unread messages, even if it's told them before.

.. _supybot.plugins.Note.notify.autoSend:

supybot.plugins.Note.notify.autoSend
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default value: 0

Determines the upper limit for automatically sending messages instead of notifications. I.e., if this value is 2 and there are 2 new messages to notify a user about, instead of sending a notification message, the bot will simply send those new messages. If there are 3 new messages, however, the bot will send a notification message.

.. _supybot.plugins.Note.public:

supybot.plugins.Note.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default value: True

Determines whether this plugin is publicly visible.