Guntram Blohm > Mail-Exchange > Mail::Exchange::Message::StickyNote

Download:
Mail-Exchange-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

Mail::Exchange::Message::StickyNote - subclass of Mail::Exchange::Message that initializes StickyNote-specific fields

SYNOPSIS ^

    use Mail::Exchange::Message::StickyNote;

    $mail=Mail::Exchange::Message::StickyNote->new();

DESCRIPTION ^

Mail::Exchange::Message::StickyNote is a utility class derived from Mail::Exchange::Message. When creating a new message object, it sets the Message Class to "IPM.StickyNote" to mark this message as a sticky note object.

EXAMPLE ^

    #!/usr/bin/perl
    
    use Mail::Exchange::PidLidIDs;
    use Mail::Exchange::Message::StickyNote;
    
    my $note=Mail::Exchange::Message::StickyNote->new();
    
    $note->setUnicode(1);
    
    $note->setBody("hello world");
    $note->setColor('blue');
    $note->set(PidLidNoteWidth, 600);
    $note->set(PidLidNoteHeight, 400);
    $note->set(PidLidNoteX, 100);
    $note->set(PidLidNoteY, 200);
    
    $note->save("mynote.msg");

METHODS ^

new()

$msg=Mail::Exchange::Message::StickyNote->new();

Create a new message object and initialize it to a sticky note.

parse()

The parse() method is overwritten to abort, because the message type will be read from the input file, so a plain Mail::Exchange::Message object should be used in this case.

setColor()

The setColor method sets the PidLidNoteColor property. It understands color IDs as well as the color names defined in MS-OXONOTE 2.2.1.1, which are blue, green, pink, yellow, and white. Also, it sets the PidTagIconIndex property to color+0x300, as required by MS-OXONOTE 2.2.2.2.

syntax highlighting: