NAME

Text::Emoticon::MSN - Emoticon filter of MSN Messenger

SYNOPSIS

  use Text::Emoticon::MSN;
  my $emoticon = Text::Emoticon::MSN->new(
      imgbase => "http://example.com/emo",
  );
  my $text = "Yet Another Perl Hacker ;-)";
  print $emoticon->filter($text);
  # it prints
  # Yet Another Perl Hacker <img src="http://example.com/emo/regular_smile.gif" />

DESCRIPTION

Text::Emoticon::MSN is a text filter that replaces text emoticons like ":-)", ";-P", etc. to the icons of MSN Messenger, detailed in http://messenger.msn.com/Resource/Emoticons.aspx

METHODS

new

  $emoticon = Text::Emoticon::MSN->new(
      imgbase => "http://yourhost.example.com/images/emoticons",
      xhtml   => 1,
      class   => "emoticon",
  );

Constructs new Text::Emoticon::MSN object. It accepts two options:

imgbase

Base URL where icon gif files are located. It defaults to "http://messenger.msn.com/Resource/emoticons" (the MSN site) but I don't recommend that, as there's a possibility MSN will ban your site.

xhtml

Whether it uses XHTML style img tags. It defaults to 1.

class

CSS class used in "img" tags. It defaults to nothing.

  $emoticon = Text::Emoticon::MSN->new(class => "emo");

will print:

  <img src="blah.gif" class="emo" />

strict

Whether it will disable smileys with space in them. defaults to 0.

filter

  $filtered_text = $emoticon->filter($text);

Filters emoticons in text and returns "img" tagged text (HTML).

TODO

Handling original emoticons. (Patches welcome)
Common API for other Emoticons like Yahoo! (maybe Text::Emoticons)

AUTHOR

Tatsuhiko Miyagawa <miyagawa@bulknews.net>