/ 
FTN-Packet-0.20
River stage zero No dependents
/ FTN::Packet

NAME

FTN::Packet - Reading or writing Fidonet Technology Networks (FTN) packets.

VERSION

VERSION 0.20

DESCRIPTION

FTN::Packet is a Perl extension for reading or writing Fidonet Technology Networks (FTN) packets.

EXPORT

The following functions are available in this module: read_ftn_packet(), write_ftn_packet().

FUNCTIONS

read_ftn_packet

Syntax: $messages = read_ftn_packet($pkt_file);

Read the messages in a Fidonet/FTN packet. It is passed the name and path of a Fidonet/FTN packet file. Returns the messages in the packet as a reference to an array of hashes, which can be read as follows:

for $i ( 0 .. $#{$messages} ) {

    print "On message $i";

    $msg_area = ${$messages}[i]{area};
    $msg_date = ${$messages}[i]{ftscdate};
    $msg_tonode = ${$messages}[i]{tonode};
    $msg_from = ${$messages}[i]{from};
    $msg_to = ${$messages}[i]{to};
    $msg_subj = ${$messages}[i]{subj};
    $msg_msgid = ${$messages}[i]{msgid};
    $msg_replyid = ${$messages}[i]{replyid};
    $msg_body = ${$messages}[i]{body};
    $msg_ctrl = ${$messages}[i]{ctrlinfo};

    # Processing of the contents of the message.

}

write_ftn_packet

Syntax: write_ftn_packet($OutDir, \%packet_info, \@messages);

Create a Fidonet/FTN packet, where: $OutDir is the directory where the packet is to be created \%packet_info is a reference to a hash containing the packet header \@messages is reference to an array of references to hashes containing the messages.

EXAMPLES

use FTN:Packet;
To be added...

AUTHORS

Robert James Clay, jame@rocasa.us

BUGS

Please report any bugs or feature requests via the web interface at "/sourceforge.net/p/ftnpl/ftn-packet/tickets/" in <http:. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Note that you can also report any bugs or feature requests to bug-ftn-packet at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FTN-Packet; however, the FTN-Packet Issue tracker is preferred.

SUPPORT

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

perldoc FTN::Packet

You can also look for information at:

ACKNOWLEDGEMENTS

Code for the read_ftn_packet function was initially derived from the newmsgs subroutine in the set of scripts for reading FTN packets (pkt2txt.pl, pkt2xml.pl, etc) by Russ Johnson mailto:airneil@users.sf.net and Robert James Clay mailto:jame@rocasa.us available at the http://ftnpl.sourceforge.net] project site. Initial code for the write_ftn_packet function was derived from the bbs2pkt.pl of v0.1 of the bbsdbpl scripts, also at the SourceForge project.

SEE ALSO

L<FTN::Packet::Examples>, L<FTN::Packet::ToDo>

COPYRIGHT & LICENSE

Copyright 2001-2012 Robert James Clay, all rights reserved. Copyright 2001-2003 Russ Johnson, all rights reserved.

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