EMDIS::ECS::Config - ECS configuration data
use EMDIS::ECS::Config; $cfg = new EMDIS::ECS::Config("ecs.cfg"); $cfg->display(); print "ECS data directory: " . $cfg->ECS_DAT_DIR . "\n";
ECS configuration object. Parses configuration file, performs basic validation of configuration, and provides interface to configuration settings.
seq_num threshold for deleting outbound messages
executable command for use by MSG_PROC; for example:
fml2pars.pl -mdf emdis-v31.mdf -proc msg_proc.pl $1 $2 $3
email address(es) of ECS administrator(s) (separated by comma)
YES/NO value. If set to YES, the ecs_scan_mail program sends a MSG_ACK meta message after each successfully processed incoming message. Otherwise, the ecs_chk_com program will periodically send MSG_ACK messages, for those nodes with in_seq_ack less than in_seq.
backup directory for incoming messages (or NONE)
directory containing ECS scripts (typically set to __SCRIPT_DIR__)
directory containing ECS node_tbl, mboxes subdirectories, etc. (typically set to __CONFIG_DIR__)
debug level for ECS
location of a directory which has a subdirectory for each partner node; each subdirectory here holds files containing the decrypted payload for messages from the corresponding partner node
location of a directory which has a subdirectory for each partner node; each subdirectory here contains untransmitted outbound messages for the corresponding partner node
full pathname of ECS error file (optional - defaults to program_name.err)
location of GNU tar program; required for ecstool --archive command
home directory for GnuPG (defines value for GNUPGHOME environment variable)
GnuPG key id for this node, for creating encrypted messages that are decryptable by self
passphrase for GnuPG private key
debug level for mailbox interactions (using POP3/IMAP)
inbox folder, used by IMAP only
POP3/IMAP server name
size limit for incoming email messages
password for POP3/IMAP inbox
POP3/IMAP server port (default 110/143, or 995/993 if INBOX_USE_SSL is YES)
inbox protocol: DIRECTORY, POP3 or IMAP
time limit for mailbox interactions
YES/NO value; default is NO. If set to YES, use SSL when connecting to inbox via POP3 or IMAP.
username for POP3/IMAP inbox
Directory for message files for the DIRECTORY protocol
username for POP3/IMAP mailbox
full pathname of ECS log file (optional - defaults to program_name.log)
Numeric value which controls level of messages written to log files (0=debug, 1=info, 2=warn, 3=error, 4=fatal).
command executed to process ECS meta-message
Numeric value which controls level of messages emailed to ECS administrators (0=debug, 1=info, 2=warn, 3=error, 4=fatal).
ECS mark in subject header of incoming email
Default message part maximum size, in bytes. Applies to nodes which do not have a msg_part_size value specified in the NODE_TBL. A node-specific, non-zero msg_part_size value in the NODE_TBL takes precedence over MSG_PART_SIZE_DFLT for that node. Refer to the EMDISCORD email parts RFC (RFC-20091021-EmailParts.pdf) for additional information about message parts.
command executed to process FML message
basename of node_tbl
name of node_tbl lockfile
template for OpenPGP decrypt command
template for OpenPGP encrypt command
home directory for PGP (defined value for PGPPATH environment variable)
PGP key id for this node, for creating encrypted messages that are decryptable by self
passphrase for PGP private key
template for PGP2 decrypt command
template for PGP2 encrypt command
debug level for outgoing email (SMTP) communications
mail domain
email "from" address
SMTP server hostname
password for SMTP server
SMTP server port (default 25, or 465 if SMTP_USE_SSL is YES)
maximum time, in seconds, to wait for response from SMTP server
YES/NO value; default is NO. If set to YES, use SSL when sending mail via SMTP.
username for SMTP server
seconds after detection of communication loss to delay notification of administrator (this may be useful to reduce the number of comm loss "nag" emails)
seconds to wait before repeating admin notification of communication loss
seconds between ECS connection checks
message processing time limit, in seconds
seconds to delay before automatically sending a batch of RE_SEND requests
seconds between scans of email inbox
EMDIS id of this ECS node
"maildrop" directory: contains outbound FML messages created by the adapter program or the ecstool --maildrop command
"active" mailbox subdirectory (not currently used in this ECS implementation)
"mboxes" (mailbox) directory: contains mailbox subdirectories
"in" mailbox subdirectory: all ECS messages received via email
"out" mailbox subdirectory: all messages sent to local ECS administrator
"store" mailbox subdirectory: ECS messages waiting to be processed, including early messages and any message from an unknown node
"trash" mailbox subdirectory: ECS messages that arrived more than one time which were discarded and never processed
"tmp" directory: temporary files, typically ECS messages being passed to message processing scripts that are deleted after processing
EMDIS::ECS, EMDIS::ECS::FileBackedMessage, EMDIS::ECS::LockedHash, EMDIS::ECS::Message, ecs_setup
Joel Schneider <jschneid@nmdp.org>
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Copyright (C) 2002-2016 National Marrow Donor Program. All rights reserved.
See LICENSE file for license details.
ECS, the EMDIS Communication System, was originally designed and implemented by the ZKRD (http://www.zkrd.de/). This Perl implementation of ECS was developed by the National Marrow Donor Program (http://www.marrow.org/).
2004-03-12 Canadian Blood Services - Tony Wai Added MS Windows support for Windows 2000 and Windows XP Added "DIRECTORY" inBox Protocol. This can interface with any mail system that can output the new messages to text files.
To install EMDIS::ECS, copy and paste the appropriate command in to your terminal.
cpanm
cpanm EMDIS::ECS
CPAN shell
perl -MCPAN -e shell install EMDIS::ECS
For more information on module installation, please visit the detailed CPAN module installation guide.