Zane C. Bowers-Hadley

NAME

Mail::IMAPTalk::SortHelper - Handles some processing of the returns from sort and thread.

VERSION

Version 0.0.1

SYNOPSIS

Generates a array from the sorted return of either Mail::IMAPTalk->sort or Mail::IMAPTalk->thread.

Mail::Cache is used to speed this up.

    use Mail::IMAPTalk::SortHelper;

    my $sh = Mail::IMAPTalk::SortHelper->new();
    ...

FUNCTIONS

new

This initiates the object.

    my $sh = Mail::IMAPTalk::SortHelper->new();

process

This processes the returned data from either sort or thread.

Three arguements are required. The first is the data returned from it, the second is the Mail::IMAPTalk object, and the third is a Mail::Cache object.

    my $sorted=$imap->thread('REFERENCES', 'UTF8', 'NOT', 'DELETED');
    $mc->init('My::Module', 'imap', 'myAccount', 'INBOX');
    my @processed=$sh->(@{$sorted}, $imap, $mc);
    
    use Data::Dumper;
    print Data::Dumper->Dump(\@processed);

processArray

This is a internal function used for when dealing with threads.

getInline

Gets the inline mode setting.

getInlineCharacter

This fetches what is currently being used for the inline character.

setInline

Turn inline mode on or off.

setInlineCharacter

This sets the inline over character.

If it is undef or '', then it is reset to '>'.

    $sh->setInlineCharacter('=');

RETRUNED ARRAY FORMAT

The returned a is a array of hashes.

HASH KEYS

over

This is how far over a item a thread. A value of zero indicates it's the root of the thread.

Unless this is a threaded search, it will always be 0.

uid

This is the IMAP UID of the message.

from

This is the From header of the message.

date

This is the Date header of the message.

subject

This is the subject header of the message.

If inline mode is turned on the number of inline characters will be appended to it determines by how far over it is.

size

This is the size of the message.

AUTHOR

Zane C. Bowers, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-mail-imaptalk-sorthelper at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mail-IMAPTalk-SortHelper. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Mail::IMAPTalk::SortHelper

You can also look for information at:

ACKNOWLEDGEMENTS

ANDK, #52167, pointed out the missing dependency in Makefile.PL

COPYRIGHT & LICENSE

Copyright 2011 Zane C. Bowers-Hadley, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.