view release on metacpan or  search on metacpan

lib/ASNMTAP/Asnmtap/Plugins/Mail.pod  view on Meta::CPAN

=item timeout

maximum time, in seconds, to wait for a response from the IPAM4 server

optional, scalar value, default: 120 unless inherited from the parent object attribute _timeout

=item debug

debugging information

optional, scalar value, default: inherited from the parent object command line option -d or --debug

=back

=item _POP3

settings used by Net::POP3 - Post Office Protocol 3 Client class (RFC1939)

=over 4

=item pop3

POP3 host to connect to. It may be a single scalar, or an scalar array with hosts to try in turn. 

Syntax for POP3 host is <hostname>[:<port>] where <hostname> can be a hostname or the IP-address on the 'xxx.xxx.xxx.xxx'

 single scalar: pop3 => 'pop3.citap.be', 'pop3.citap.be:110', 'xxx.xxx.xxx.xxx' or 'xxx.xxx.xxx.xxx:110'

required when POP3 used for dowloading the receiving mails, default: undef

=item port (reserved)

port used when none is specified in the server name.

optional, scalar value, default: 110

=item username

optional, scalar value, default: undef

=item password

optional, scalar value, default: undef

=item timeout

maximum time, in seconds, to wait for a response from the POP3 server

optional, scalar value, default: 120 unless inherited from the parent object attribute _timeout

=item debug

debugging information

optional, scalar value, default: inherited from the parent object command line option -d or --debug

=back

=item _mailType

For clients that are sensitive to cookie-based authentication.

optional, mailType can be 0 or 1

  0, TXT formated fingerprint (default)
  1, XML formated fingerprint

=over 4

=item TXT

Each e-mail exists of an TXT fingerprint. This allows us lateron only to pick up the required e-mails with pop3, because we will filter out the emails with a minimum band width the e-mails desired from the mail box. 

When the status and the header plus the first 7 lines of the e-mail agrees to these fingerprint, the e-mail is picked up, processes, and removed from the mail box.

=over 4

=item Fingerprint

=over 4

=item Subject

 SUBJECT / From: Source_email_address To: Application_Monitor_email_address

 SUBJECT: description can be found lateron into this document.

=item Message

 SUBJECT / From: Source_email_address To: Application_Monitor_email_address
 <plugin naam> <plugin description>
 Timestamp <Source email address>: dd-mm-yyyy hh:mm:ss[.hhh]
 Status <naam from the service up/down>

 SUBJECT: description can be found lateron into this document.

=back

=item Example

 ASNMTAP / From: alex.peeters@citap.com To: asnmtap@citap.com 
 <mail-xml-citap-com.pl> <Mail XML plugin template for testing the 'Application Monitoring'>
 Timestamp <alex.peeters@citap.com>: 2006/02/04 11:01:11
 Status <Application Monitoring Status Down>

=back

=item XML

Each e-mail exists of an XML fingerprint. This allows us lateron only to pick up the required e-mails with pop3, because we will filter out the emails with a minimum band width the e-mails desired from the mail box. 

When the status and the header plus the first 5 lines of the e-mail agrees to these fingerprint, the e-mail is picked up, processes, and removed from the mail box.

=over 4

=item DTD for validation XML

 <?xml version="1.0" encoding="UTF-8"?>

 <!ENTITY AUTHOR  "Alex Peeters">
 <!ENTITY EMAIL   "Alex.Peeters@citap.com">