MailExpiry addon

Description
===========

MailExpiry warns when mail to your characters (including alts) is
about to expire. It keeps track of expiration times of messages in
the inboxes of your characters, and warns when they are about to
expire, to avoid losing items/money etc.

Usage
=====

Install by extracting the files into your ..World of WarcraftInterfaceAddOns directory.
To configure, use the /mailexpiry command, or install myAddOns, find
"Mail Expiry" in the AddOns game menu, and click "Options" in the
lower right corner.

If you have mail about to expire, you will get a warning a short while
after you log in. By default you get it both in the middle of the
screen and in the default chat window, but this is configurable.

Warnings are sorted in order of expiry, and colored based on how long
it is until the mail expires. It also tells which of your alts the
message is for (and which realm, if not the current one), and what is
in the expiring mail (items, money, or subject of text messages).

No warnings can be issued about mail which MailExpiry doesn't know
about. You have to open the inbox of each of your characters in order
for MailExpiry to learn about its contents. Mail which has arrived
since last mailbox opening is unknown. (When you send mail TO one of
your alts which has known mailbox info, a "guess" of the received mail
contents and expiry is automatically added, so you don't have to login
as the alt just to keep track of *that* mail.)

MailExpiry can be configured to issue warnings about different types
of mail:
* money - mail which contains money (amount shown)
* item - mail which contains items (highlighted by quality)
* text - mail which only contains text (subject shown)

You also get warnings about characters which haven't checked their
mail recently.

Commands
========
/mailexpiry
-- shows version and subcommands

/mailexpiry config
-- opens config screen (this is BROKEN and disabled)

/mailexpiry set <configoption>=<value>
-- sets config options. Try "/mailexpiry set" to see which, and
their current values. Boolean (on/off) variables can be "on",
"true", "1", "off", "false", "0", etc. Strings should not be
quoted.
-- note especially "/mailexpiry set confperaccount <on/off>", which
sets whether to use per-account (default) or per-character settings.

/mailexpiry showconf
-- shows the current configuration

/mailexpiry check [days]
-- check now for mail expiring in "days" days (default configurable),
without waiting for the automatic warning.

/mailexpiry clear pname@realm
-- clear saved data for player "pname" in "realm". The realm defaults
to the current one, so just say "/mailexpiry clear bugger" to clear
the data for your character "Bugger" if she's on the same realm.

/mailexpiry boxes
-- show a summary about your mailboxes

Technical info
==============

Inbox data is collected when you open your mailbox (when you get a
MAIL_INBOX_UPDATE event), and saved per account, containing inbox data
per realm and per character. Configuration settings are stored per
character.

Versions
========

0.18 - Nov 11, 2008
* Added:
** set pendingsales=[boolean]: Warn about pending Auction House sales
(but I'm not sure they are sent anymore, so this is off by default)
** set abbrevcontent=[boolean]: Abbreviate item content of mail
(instead of telling all the various items, just show one)
** set onlydeleted=[boolean]: Warn only about mail about to be deleted
(not about mail being returned)

0.17 - July 27, 2008
* Finally updated it to handle multiple attachments. The notifications
become kind of long though, so maybe there should be an option to
abbreviate them?

0.16 - June 6, 2007
* Added code from Susicivus to put messages in a "mailexpiry" chat
frame if one exists.
* Added check for whether the mail will be deleted or returned. Only
warn about deletion if we know it will be deleted, otherwise say
"expires" as usual.
* Disabled "/mailexpiry config" until later...

0.15 - February 11, 2007
* I hope I fixed the "invalid order function" bug - it seems the order
function MUST return false for equal items - it must be strict like
"<". I have no idea why Lua bothers.

0.14 - January 24, 2007
* Add keybinding support for "/mailexpiry check" command.
* Handle disappeared senders (thanks Philox)
* Handle last weird case in sorting (tell me if you get "invalid order
function for sorting"!)
* Don't show empty mail subject ("")

0.13 - January 14, 2007
* Sorting in Lua is broken, add workaround.

0.12 - October 29, 2006
* Add expiry guessing for mail sent using CT_MailMod.
* sanity check of mailbox data to prevent problems - please report any
new problems.
* don't issue warnings while Mail screen is open (e.g. to prevent
warnings about mail which is open on screen)
* fix the bug in the bug fix for filtering already expired mail

0.11 - October 11, 2006
* fix bug when filtering already expired mail
* add command "/mailexpiry clear player@realm" to clear all saved data
for the named player. (The realm defaults to the current one.)

0.10 - September 29, 2006
* Change default saveperaccount setting to true, i.e., use a shared
configuration for your whole account rather than one config per
character.
* If you send mail to one of your alts, an entry is faked in the
mailbox of the alt so you don't have to check the mailbox so often.
NOTE that this only works if you send mail with the regular mail
window, and that there are not guarantees about correctness - it seems
to work though.

0.9 - September 29, 2006
* Warn also about chars which haven't checked their mailboxes in N
days. Currently uses the same N as for expiring mail, but this
should probably be configured separately.
See /mailexpiry set openwarn=<on/off>.

0.8 - September 27, 2006
* handle condition which could cause WoW to hang completely. So far
it has been intermittent, but with 1.12.1 it seems to have turned
consistent, which forced me to find a solution. Apparently the
MAIL_INBOX_UPDATE event handler can not call GetInboxItem under some
circumstances, so instead call it asynchronously from the OnUpdate
handler. Thanks to Adrine&Iriel in a US forum thread from 4/1-4/2006!

0.7 - August 23, 2006
* Fix bug when per-account/character settings are used the first time.
* (Update interface version for 1.12 - happened to coincide with patch day.)

0.6 - August 21, 2006
* Support settings both per account and per character. Use
"/mailexpiry set confperaccount=<on/off>" to change.

0.5 - August 14, 2006
* /mailexpiry config -- opens config screen (which is still incomplete, see below)

0.4 - August 13, 2006
* ignore (and forget) mail which has already expired.

0.3 - August 10, 2006
* first "release"

Problems
========

Sometimes the warnings are not properly sorted. This seems to be a
bug in the Lua implementation.

The config window is broken: opening it hangs WoW.

Improvements to do
==================

* could sort items when abbreviating content, to show only the most
rare/valuable instead of just the first
* could be interfaced to FuBar or Titan
* more things can be configured than is shown in config window
(e.g. colors of messages), some day I'll add support
* perhaps add color to money messages too, e.g. to make gold stand out
more
* perhaps make it configurable whether to check every alt or only the
ones on this realm, or only the current character
* could present a nice screen with icons and detailed info about
contents, but I don't care enough right now...

Author
======

Groklam on the Moonglade EU server (and on ui.worldofwar.net). Thanks
for code snippets from various sources, and for WowWiki!

Patch notes for MailExpiry
0.18 - Nov 11, 2008
* Added:
** set pendingsales=[boolean]: Warn about pending Auction House sales
(but I'm not sure they are sent anymore, so this is off by default)
** set abbrevcontent=[boolean]: Abbreviate item content of mail
(instead of telling all the various items, just show one)
** set onlydeleted=[boolean]: Warn only about mail about to be deleted
(not about mail being returned)

Sometimes the warnings are not properly sorted. This seems to be a
bug in the Lua implementation.

The config window is broken: opening it hangs WoW.

MailExpiry, archived on 28/07/08
MailExpiry, archived on 11/11/08