MemoServ
From Afterxwiki
[edit]
Introduction
MemoServ is a utility allowing IRC users to send short messages to other IRC users, whether they are online at the time or not, or to channels(*). Both the sender's nickname and the target nickname or channel must be registered in order to send a memo. Type
/msg MemoServ HELP COMMANDS for a list of MemoServ commands; to use a command, type /msg MemoServ command, or for more information on a command, type /msg MemoServ HELP command.
(*) By default, any user with at least level 100 access on a channel can read that channel's memos. This can be changed with the ChanServ LEVELS command.
[edit]
MemoServ Commands
SEND
- Syntax:
- SEND {nickname | channel} memo-text
Sends the named nickname or channel a memo containing memo-text. When sending to a nickname, the recipient will receive a notice that he/she has a new memo. The target nickname/channel must be registered.
LIST
- Syntax:
- LIST [channel] [num | list | NEW]
Lists any memos you currently have. With NEW, lists only new (unread) memos. Unread memos are marked with a "*" to the left of the memo number; memos that will not expire are marked with a "+". You can also specify a list of numbers, as in the example below:
- LIST 2-5,7-9
- Lists memos numbered 2 through 5 and 7 through 9.
READ
- Syntax:
- READ [channel] {num | list | LAST | NEW}
Sends you the text of the memos specified. If LAST is given, sends you the memo you most recently received. If NEW is given, sends you all of your new memos. Otherwise, sends you memo number num. You can also give a list of numbers, as with the LIST command.
SAVE
- Syntax:
- SAVE [channel] {num | list}
Marks the given memo or memos as non-expiring. You can give either a single memo number or, as with the LIST command, a list of memos.
Note that this command will not be available if the MSExpire option is not set (since there would be no point in using it).
DEL
- Syntax:
- DEL [channel] {num | list | ALL}
Deletes the specified memo or memos. You can supply multiple memo numbers or ranges of numbers instead of a single number, as with the LIST command; you can also give the word ALL, which causes all of your memos to be deleted.
Warning: Once a memo is deleted, it cannot be recovered!
SET
- Syntax:
- SET option parameters
Sets various memo options. option can be one of:
- NOTIFY
- Changes when you will be notified about new memos (only for nicknames)
- LIMIT
- Sets the maximum number of memos you can receive
- FORWARD
- Sets whether memos are automatically forwarded to you
SET NOTIFY
- Syntax:
- SET NOTIFY {ON | LOGON | NEW | OFF}
Changes when you will be notified about new memos:
- ON
- You will be notified of memos when you log on, when you unset /AWAY, and when they are sent to you.
- LOGON
- You will only be notified of memos when you log on or when you unset /AWAY.
- NEW
- You will only be notified of memos when they are sent to you.
- OFF
- You will not receive any notification of memos.
Note that if your nickname has the "secure" setting on, you will only be notified of new memos (for LOGON or ON) after you identify to NickServ.
SET LIMIT
- Syntax:
- SET LIMIT [nickname | channel] {limit | NONE | DEFAULT} [HARD]
Sets the maximum number of memos a nickname (or channel) is allowed to have. Setting the limit to 0 prevents the nick from receiving any memos; setting it to NONE allows the nick to receive and keep as many memos as they want; and setting it to DEFAULT restores the limit to the default value (MSMaxMemos in modules.conf, 20 by default). If you do not give a nickname or channel, your own limit is set.
Adding HARD prevents the user from changing the limit. Not adding HARD has the opposite effect, allowing the user to change the limit (even if a previous limit was set with HARD).
This use of the SET LIMIT command is limited to Services admins. Other users may only enter a limit for themselves or a channel on which they have such privileges, may not remove their limit or set their limit to the default, may not set a limit above the default limit, and may not set a hard limit.
INFO
- Syntax:
- INFO [nickname | channel]
Without a parameter, displays information on the number of memos you have, how many of them are unread, how many total memos you can receive and when you are notified of new ones.
With a channel parameter, displays the same information for the given channel.
With a nickname parameter, displays the same information for the given nickname. This use limited to Services admins.
FORWARD (requires the memoserv/forward module)
- Syntax:
- FORWARD {num | list | ALL}
Forwards one or more of your memos to your E-mail address. You must have a valid E-mail address set for your nickname in order to use this command. Channel memos cannot be forwarded.
SET FORWARD (requires the memoserv/forward module)
- Syntax:
- SET FORWARD {ON | COPY | OFF}
Sets whether MemoServ automatically forwards to your E-mail address memos sent to you. When set to ON, memos sent to your nickname will instead be forwarded to the E-mail address registered with your nickname. COPY is similar, but also causes MemoServ to save a copy of the memo to read online. When set to OFF, your memos will be stored online as usual. Even if you set this option to ON, you may still receive memos online if Services is unable to forward them to you.
Note that when this option is set to COPY and you have received the maximum number of memos you are allowed to, you will not be able to receive any new memos (including by E-mail) until you delete some old memos using the DEL command.
IGNORE (requires the memoserv/ignore module)
- Syntax:
- IGNORE {ADD | DEL | LIST} [nickname | mask]
Controls the list of "ignored" users; users whose nickname or user@host mask match an entry on this list are not allowed to send you memos. ADD adds the given nickname or user@host mask to your ignore list, and DEL removes the given nickname or mask from the list; LIST displays your current ignore list.
Note that the nickname or mask given to the ADD command may contain "*" or "?" wildcards, and is not case-sensitive; for example, "*Evil*" matches "EvilNick", "AN_EVIL_USER" and "devil".
