Memoserv

From SwiftIRC Wiki
Jump to: navigation, search

Contents

Frequently asked questions may answer your question

Help Video: memoserv commands

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. MemoServ is basically the email of IRC. You can send messages to users or channels that are on or offline and they will still get the message provided you have not hit their limit. Many people make use of this tool to make people aware of urgent events or other information that needs to get to them. If they are offline, they will receive it as soon as they come online. Channel memos can be read, by default, by anyone with ten or more access. If you wish to change the level at which you can read the memos for your channel, you will have to configure the option by using /cs levels which is explained in a different section of this FAQ.

If you wish to explore the different options MemoServ has, type

   /ms help

Ex: If you wanted help with the SEND option, you would type

   /ms help send

Send

The Send option is the heart of MemoServ. It allows you to send memos to other users and channels. In order to successfully send a memo to another user, the user's nickname must be registered. They will receive it and will be notified they have a new memo depending on what they have their Notify options set to. Most users don't change from the default settings. To send a memo to another user, you would type

   /ms send nickname message

If you wanted to send a memo the channel, you would type

   /ms send #channel message

Ex: Perhaps you wanted to send a memo to an IRCop regarding an issue you need resolved or a question you need answered. If your IRCop of choice is SwiftUSer, you would type

   /ms send SwiftUser Nick123 has stolen a friend's nick. Can you help?

For more information on how to identify an IRC Op, please visit this page.

Similarly, if you wanted to memo #support with a question you had, you would type

   /ms send #support Nick123 has stolen a friend's nick. Can you help?

Cancel

The Cancel command can be used to cancel memos you recently sent in case they were mistakes or your issue was resolved. The only way Cancel would work is if the memo has not been read. You can cancel memos to other users as well as channels. To cancel a memo, you would type

   /ms cancel nickname
   /ms cancel #channel

List

If you were away for long periods of time and regularly get memos, your memos would get stacked up. The List option allows you to see all of these memos in the form of a list. You can choose to list the new, unread memos or all memos you've received. To view your memo list,

   /ms list new

You can either include new or not. It doesn't matter unless you want to view the new memos in the list. If not, exclude it and MemoServ will list all of your memos. If you have no new memos, you will get a notice from MemoServ saying "You have no memos."

To view a channel's memos, type

   /ms list #channel list new

New works the same way with channels. If you wish to see only unread memos, include new. If not, leave it out. You can also include a range to list your memos. For example, if you wanted to list memos 2-4 and 7-9 only, you would type

   /ms list 2-4,7-9

This will list memos 2, 3 and 4, and 7, 8 and 9.

Read

The Read option is equally important to the Send option. The Read option works in unison with the List option. With the List command, you will be able to see a list of your memos in order of how you got them. On the left side, there will be numbers in chronological order (1, 2, 3, etc.). Depending on how many memos you have, you will need to use these numbers accordingly to read your memos. If you have four new memos, they should be numbered down from one through four. To read one of those, you would type

   /ms read number

Now, if you happened to read memo one and then deleted it, memo two will become memo one. It will shift up the list if you choose to delete the memo. So if you're stuck in a situation where /ms read 2 isn't working properly, make sure you haven't deleted a previous memo you read. It may have moved up in the list. You can also choose to just read the latest memo you just received by typing

   /ms read last

You can choose to read just your new memos by typing

   /ms read new

or you may want to read to see a range of memos you received. You can do this by typing

   /ms read range

Respectively, you would do the same in a channel situation by adding #channel after

   /ms read #channel option

Del

The del option allows you to delete your memos so you can receive more. If you reach the limit, you will not be able to receive memos until you delete your old ones. The syntax for deleting your memos is

   /ms del #channel option

The options are

   number
   range
   last
   all

If you wanted to delete your own memos, you would leave out #channel.

Deleting one memo at a time with num is time-consuming, especially if you've read all your memos and just want to be rid of them. You can choose to delete them using range or the all option.

For a channel

   /ms del #channel all

For your nickname

   /ms del all

Set

Set is the option you can use to configure your personal memoserv or channel's settings. To configure your options, type

   /ms set option parameters

The different options are notify and limit.

Notify

Notify is the option you can use to set how you wish to be notified of new memos. To do this, type

   /ms set notify option

The options are

   on
   logon
   new
   off

If you choose the on option, which is the default, you will be notified of new memos when you logon, unset /away, and when they are sent to you. The logon option notifies you only when you logon and unset /away. If you set new, you will be notified of memos only when they are sent to you. And if you choose off, you will not be notified at all. This option doesn't work with channels.

Limit

The Limit option allows you to set what your or your channel's memo limit is. This means that if you set the limit to, for example, five, you will only be able to receive five memos at a time. The rest will be ignored until you delete the ones you currently have. To set a limit, type

   /ms set limit number

If you set it to zero, you will not be able to receive any memos. You can also set limits for channels by adding #channel after limit.

Info

Info is a command that allows you to see how your memoserv is configured. It will display how many memos you have, what your memo limit is, and how you will be notified of new memos. To view this information, type

   /ms info #channel

Leave #channel out if you wish to view your own configuration.

Check

The check option allows you to see if the memo you have sent to a user, and will also tell you the date and time you sent the memo. Note: this does not work for memos sent to a channel.

To check if a memo to a user has been read, type

   /ms check nickname