App::MonM::Notifier::Channel - monotifier channel base class
Version 1.01
use App::MonM::Notifier::Channel; my $channel = new App::MonM::Notifier::Channel; my $data = { id => 1, to => "recipient", subject => "Test message", message => "Content of the message", }; my $ch_conf = { 'fri' => '18:01-19', 'from' => 'root@example.com', 'host' => 'mail.example.com', 'mon' => '7:35-17:45', 'period' => '7:30-16:30', 'port' => '25', 'set' => [ 'User TeStUser', 'Password MyPassword' ], 'sun' => '-', 'thu' => '16-18:01', 'to' => 'test@example.com', 'tue' => '15-19', 'type' => 'Email', 'wed' => '-' }; my $status = $channel->process($data, $ch_conf); die($channel->error) unless $channel->status;
This module provides channel base methods
my $channel = new App::MonM::Notifier::Channel;
Returns the channel object
my $self = $channel->cleanup;
Cleaning up of working variables
my $conf_hash = $channel->config;
Returns the channel configuration ($ch_conf)
my $data = $channel->data; my $data = $channel->data( { ... } );
Sets/gets data structure
my $error = $channel->error; my $error = $channel->error( "New error" );
Sets/gets error message
my $message_id = $self->genId( $self->data->{id} || 0, $self->data->{pubdate} || 0, $self->data->{to} || "anonymous", );
Return ID of message
my $email = $channel->message; my $email = $channel->message( new Email::MIME );
Gets/sets the Email::MIME object
my $status = $channel->process( $data, $ch_conf ) or die($channel->error);
This method runs process of sending message to channel and returns operation status.
See "DATA" and "DIRECTIVES" for details
my $status = $channel->status; my $status = $channel->status( 1 ); # Sets the status value and returns it
Get/set BOOL status of the operation
my $type = $channel->type; my $type = $channel->type( "File" );
Gets/sets the type value
It is a structure (hash), that can contain the following fields:
'data' => { 'channel' => "MyEmail", 'comment' => "Comment", 'errcode' => 0, 'errmsg' => 'Ok', 'expires' => 1565599719, 'id' => 31, 'message' => "Message body", 'pubdate' => 1563007719, 'status' => 'NEW', 'subject' => "My message", 'to' => 'testuser' }
Channel name
Comment string
Error code
Error message
Expires time value
Contains internal ID of the message. This ID is converted to an X-Id header
Body of the message
The time of message publication
Status of record (text formst). See App::MonM::Notifier::Const
Subject of the message
Recipient address or name
Sets the charset
Default: utf-8
See also Email::MIME
Sets the content type
Default: text/plain
Sets encoding (8bit, base64, quoted-printable)
Default: 8bit
Container for MIME headers definitions
Defines type of channel
Allowed types: File, Command, Email
See Changes file
Changes
CTK, App::MonM, Email::MIME
See TODO file
TODO
* none noted
Email::MIME
Serż Minus (Sergey Lepenkov) http://www.serzik.com <abalama@cpan.org>
Copyright (C) 1998-2019 D&D Corporation. All Rights Reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See LICENSE file and https://dev.perl.org/licenses/
LICENSE
To install App::MonM::Notifier, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::MonM::Notifier
CPAN shell
perl -MCPAN -e shell install App::MonM::Notifier
For more information on module installation, please visit the detailed CPAN module installation guide.