artdaq_mfextensions  v1_05_00
mfplugins::ELSMTP::Config Struct Reference

Configuration parameters for ELSMTP. More...

Public Attributes

fhicl::TableFragment
< ELdestination::Config > 
elDestConfig
 ELDestination common config parameters.
 
fhicl::Atom< std::string > host
 "host" (Default: "smtp.fnal.gov"): SMTP Server hostname More...
 
fhicl::Atom< int > port = fhicl::Atom<int>{fhicl::Name{"port"}, fhicl::Comment{"SMTP Server port"}, 25}
 "port" (Default: 25): SMTP Server port
 
fhicl::Sequence< std::string > to
 "to_addresses" (Default: {}): The list of email addresses that SMTP mfPlugin should sent to More...
 
fhicl::Atom< std::string > from
 "from_address" (REQUIRED): Source email address More...
 
fhicl::Atom< std::string > subject
 "subject" (Default: "MessageFacility SMTP Message Digest"): Subject of the email message More...
 
fhicl::Atom< std::string > messageHeader
 "message_header" (Default: ""): String to preface messages with in email body More...
 
fhicl::Atom< bool > useSmtps
 "use_smtps" (Default: false): Use SMTPS protocol More...
 
fhicl::Atom< std::string > user
 "smtp_username" (Default: ""): Username for SMTP server More...
 
fhicl::Atom< std::string > pw
 "smtp_password" (Default: ""): Password for SMTP server More...
 
fhicl::Atom< bool > verifyCert
 "verify_host_ssl_certificate" (Default: true): Whether to run full SSL verify on SMTP server in SMTPS mode More...
 
fhicl::Atom< size_t > sendInterval
 "email_send_interval_seconds" (Default: 15): Only send email every N seconds More...
 

Detailed Description

Configuration parameters for ELSMTP.

Definition at line 46 of file SMTP_mfPlugin.cc.

Member Data Documentation

fhicl::Atom<std::string> mfplugins::ELSMTP::Config::from
Initial value:
=
fhicl::Atom<std::string>{fhicl::Name{"from_address"}, fhicl::Comment{"Source email address"}}

"from_address" (REQUIRED): Source email address

Definition at line 60 of file SMTP_mfPlugin.cc.

fhicl::Atom<std::string> mfplugins::ELSMTP::Config::host
Initial value:
=
fhicl::Atom<std::string>{fhicl::Name{"host"}, fhicl::Comment{"SMTP Server hostname"}, "smtp.fnal.gov"}

"host" (Default: "smtp.fnal.gov"): SMTP Server hostname

Definition at line 51 of file SMTP_mfPlugin.cc.

fhicl::Atom<std::string> mfplugins::ELSMTP::Config::messageHeader
Initial value:
= fhicl::Atom<std::string>{
fhicl::Name{"message_header"}, fhicl::Comment{"String to preface messages with in email body"}, ""}

"message_header" (Default: ""): String to preface messages with in email body

Definition at line 66 of file SMTP_mfPlugin.cc.

fhicl::Atom<std::string> mfplugins::ELSMTP::Config::pw
Initial value:
=
fhicl::Atom<std::string>{fhicl::Name{"smtp_password"}, fhicl::Comment{"Password for SMTP server"}, ""}

"smtp_password" (Default: ""): Password for SMTP server

Definition at line 75 of file SMTP_mfPlugin.cc.

fhicl::Atom<size_t> mfplugins::ELSMTP::Config::sendInterval
Initial value:
= fhicl::Atom<size_t>{fhicl::Name{"email_send_interval_seconds"},
fhicl::Comment{"Only send email every N seconds"}, 15}

"email_send_interval_seconds" (Default: 15): Only send email every N seconds

Definition at line 82 of file SMTP_mfPlugin.cc.

fhicl::Atom<std::string> mfplugins::ELSMTP::Config::subject
Initial value:
= fhicl::Atom<std::string>{
fhicl::Name{"subject"}, fhicl::Comment{"Subject of the email message"}, "MessageFacility SMTP Message Digest"}

"subject" (Default: "MessageFacility SMTP Message Digest"): Subject of the email message

Definition at line 63 of file SMTP_mfPlugin.cc.

fhicl::Sequence<std::string> mfplugins::ELSMTP::Config::to
Initial value:
= fhicl::Sequence<std::string>{
fhicl::Name{"to_addresses"}, fhicl::Comment{"The list of email addresses that SMTP mfPlugin should sent to"},
fhicl::Sequence<std::string>::default_type{}}

"to_addresses" (Default: {}): The list of email addresses that SMTP mfPlugin should sent to

Definition at line 56 of file SMTP_mfPlugin.cc.

fhicl::Atom<std::string> mfplugins::ELSMTP::Config::user
Initial value:
=
fhicl::Atom<std::string>{fhicl::Name{"smtp_username"}, fhicl::Comment{"Username for SMTP server"}, ""}

"smtp_username" (Default: ""): Username for SMTP server

Definition at line 72 of file SMTP_mfPlugin.cc.

fhicl::Atom<bool> mfplugins::ELSMTP::Config::useSmtps
Initial value:
=
fhicl::Atom<bool>{fhicl::Name{"use_smtps"}, fhicl::Comment{"Use SMTPS protocol"}, false}

"use_smtps" (Default: false): Use SMTPS protocol

Definition at line 69 of file SMTP_mfPlugin.cc.

fhicl::Atom<bool> mfplugins::ELSMTP::Config::verifyCert
Initial value:
=
fhicl::Atom<bool>{fhicl::Name{"verify_host_ssl_certificate"},
fhicl::Comment{"Whether to run full SSL verify on SMTP server in SMTPS mode"}, true}

"verify_host_ssl_certificate" (Default: true): Whether to run full SSL verify on SMTP server in SMTPS mode

Definition at line 78 of file SMTP_mfPlugin.cc.


The documentation for this struct was generated from the following file: