diff options
Diffstat (limited to 'nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs')
12 files changed, 3589 insertions, 0 deletions
diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt new file mode 100644 index 0000000..ce52655 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt @@ -0,0 +1,69 @@ +HOW TO CONNECT TO IMAP SERVER MANUALLY + +This how-to borrowed from: http://www.bincimap.org/bincimap-faq.html + + +1) Connection +Using telnet, connect to your service on port 143. Replace "server" with your server's name. If the server is set up correctly, you will see this greeting: + # telnet server 143 + * OK IMAP Server ready + +If you have SSL enabled (most likely you do), connect to port 993 with the openssl tool. If the server is set up correctly, you will see this greeting: + # openssl s_client -connect server:993 -crlf + * OK IMAP Server ready + +2) Logging in / authenticating +Firstly, check your bincimap.conf file, in the "Authentication" section, for this setting: +allow plain auth in non ssl = "no" + +If you want users to be able to connect without using SSL, set this to "yes". +Using either the telnet (in case of "yes" in the above example) or openssl tool, try the LOGIN command, replacing "username" with one username on your server, and "password" with that user's password. You should get the reply on the second line. +1 LOGIN username password +1 LOGIN completed + +Note that you should try logging in with at least two users to check that this feature is working properly. +3) Listing, creating, renaming and deleting mailboxes +Enter the following command to list the user's first level mailboxes. You should get at least one line of response (starting with "* LIST") before you get the "2 OK LIST" reponse. +2 LIST "" "%" +* LIST (\UnMarked) "/" "INBOX" +2 OK LIST completed + +Check your bincimap.conf file, under the Mailbox section, and check the "depot" setting. Try creating a mailbox with the following command, replacing mailbox with a name of your choice. Note that if you are using the Maildir++ depot setting, you must use "INBOX/mailbox" instead: +3 CREATE mailbox +3 OK CREATE completed + +Rename the mailbox with this command. Note the "INBOX/" prefix when using a Maildir++ depot. (After that, rerunning the LIST command from above will give you a slightly different result than before): +4 RENAME mailbox newmailbox +4 OK RENAME completed + +Now delete the mailbox with this command: +5 DELETE newmailbox +5 OK DELETE completed + +4) Selecting a mailbox and looking inside +Select your INBOX with this command. Note that the response may be slightly different from in this example: +6 SELECT INBOX +* 146 EXISTS +* OK [UIDVALIDITY 1047992537] +* OK [UIDNEXT 2683] 2683 is the next UID +* FLAGS (\Answered \Flagged \Deleted \Recent \Seen \Draft) +* OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft)] Limited +6 OK [READ-WRITE] + +Fetch the flags of all your messages with this command. Note that the "..." is for editorial clarity, many lines of output have been omitted in this example: +7 FETCH 1:* FLAGS +* 1 FETCH (FLAGS (\Seen \Answered)) +* 2 FETCH (FLAGS (\Seen \Answered)) +... +* 146 FETCH (FLAGS (\Seen \Answered)) +7 OK FETCH completed + +Set a flag with this command: +8 STORE 1 +FLAGS \Flagged +* FETCH (FLAGS (\Seen \Flagged)) +8 OK STORE completed + +5) Logging out +9 LOGOUT +* BYE Server logging out +9 OK LOGOUT finished. diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt new file mode 100644 index 0000000..369baf4 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt @@ -0,0 +1,15 @@ +HOW TO TEST THE PLUGIN + +Run the shell script tests which start the test server automatically: + +./test/3_email_delivery.sh + + + + + + +If you want to start up the test server yourself: + +sudo perl test/dummy_smtp_server.pl + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html new file mode 100644 index 0000000..31422bc --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html @@ -0,0 +1,522 @@ +<?xml version="1.0" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>check_email_delivery - sends email and verifies delivery</title> +<link rel="stylesheet" href="plainwhite.css" type="text/css" /> +<meta http-equiv="content-type" content="text/html; charset=utf-8" /> +<link rev="made" href="mailto:jonathan@greek.local" /> +</head> + +<body> + + +<!-- INDEX BEGIN --> +<div name="index"> +<p><a name="__index__"></a></p> +<!-- + +<ul> + + <li><a href="#name">NAME</a></li> + <li><a href="#synopsis">SYNOPSIS</a></li> + <li><a href="#options">OPTIONS</a></li> + <li><a href="#examples">EXAMPLES</a></li> + <ul> + + <li><a href="#send_a_message_with_custom_headers">Send a message with custom headers</a></li> + <li><a href="#set_warning_and_critical_timeouts_for_receive_plugin_only_">Set warning and critical timeouts for receive plugin only:</a></li> + </ul> + + <li><a href="#exit_codes">EXIT CODES</a></li> + <li><a href="#nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></li> + <li><a href="#changes">CHANGES</a></li> + <li><a href="#author">AUTHOR</a></li> + <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li> +</ul> + +--> + + +</div> +<!-- INDEX END --> + +<p> +</p> +<hr /> +<h1><a name="name">NAME</a></h1> +<p>check_email_delivery - sends email and verifies delivery</p> +<p> +</p> +<hr /> +<h1><a name="synopsis">SYNOPSIS</a></h1> +<pre> + check_email_delivery -vV + check_email_delivery --usage + check_email_delivery --help</pre> +<p> +</p> +<hr /> +<h1><a name="options">OPTIONS</a></h1> +<dl> +<dt><strong><a name="warning_seconds_smtp_seconds_imap_seconds" class="item">--warning <seconds>[,<smtp_seconds>,<imap_seconds>]</a></strong></dt> + +<dd> +<p>Exit with WARNING if the most recent email found is older than <seconds>. The +optional <smtp_seconds> and <imap_seconds> parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -w <seconds>[,<send>[,<recv>]]</p> +<p>When using the --plugin option, only one parameter is supported (-w <seconds>) and it will apply +to the entire process. You can specify a warning threshold specific to each plugin in the +plugin command line.</p> +<p>When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions.</p> +</dd> +<dt><strong><a name="critical_seconds_smtp_seconds_imap_seconds" class="item">--critical <seconds>[,<smtp_seconds>,<imap_seconds>]</a></strong></dt> + +<dd> +<p>Exit with CRITICAL if the most recent email found is older than <seconds>. The +optional <smtp_seconds> and <imap_seconds> parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -c <seconds>[,<send>[,<recv>]]</p> +<p>When using the --plugin option, only one parameter is supported (-c <seconds>) and it will apply +to the entire process. You can specify a critical threshold specific to each plugin in the +plugin command line.</p> +<p>When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions.</p> +</dd> +<dt><strong><a name="timeout_seconds" class="item">--timeout <seconds></a></strong></dt> + +<dt><strong><a name="timeout_smtp_seconds_imap_seconds" class="item">--timeout <smtp_seconds>,<imap_seconds></a></strong></dt> + +<dt><strong><a name="timeout_plugin1_seconds_plugin2_seconds" class="item">--timeout <plugin1_seconds>,<plugin2_seconds>,...</a></strong></dt> + +<dd> +<p>Exit with CRITICAL if the plugins do not return a status within the specified number of seconds. +When only one parameter is used, it applies to each plugin. When multiple parameters are used +(separated by commas) they apply to plugins in the same order the plugins were specified on the +command line. When using --timeout but not the --plugin option, the first parameter is for +check_smtp_send and the second is for check_imap_receive.</p> +</dd> +<dt><strong><a name="alert_pluginn" class="item">--alert <pluginN></a></strong></dt> + +<dd> +<p>Exit with WARNING or CRITICAL only if a warning or error (--warning, --critical, or --timeout) +occurs for specified plugins. If a warning or error occurs for non-specified plugins that run +BEFORE the specified plugins, the exit status will be UNKNOWN. If a warning of error occurs +for non-specified plugins that run AFTER the specified plugins, the exit status will not be +affected.</p> +<p>You would use this option if you are using check_email_delivery with the --plugin option and +the plugins you configure each use different servers, for example different SMTP and IMAP servers. +By default, if you do not use the --alert option, if anything goes wrong during the email delivery +check, a WARNING or CRITICAL alert will be issued. This means that if you define check_email_delivery +for the SMTP server only and the IMAP server fails, Nagios will alert you for the SMTP server which +would be misleading. If you define it for both the SMTP server and IMAP server and just one of them +fails, Nagios will alert you for both servers, which would still be misleading. If you have this +situation, you may want to use the --alert option. You define the check_email_delivery check for +both servers: for the SMTP server (first plugin) you use --alert 1, and for for the IMAP server +(second plugin) you use --alert 2. When check_email_delivery runs with --alert 1 and the SMTP +server fails, you will get the appropriate alert. If the IMAP server fails it will not affect the +status. When check_email_delivery runs with --alert 2 and the SMTP server fails, you will get the +UNKNOWN return code. If the IMAP server generates an alert you will get a WARNING or CRITICAL as +appropriate.</p> +<p>You can repeat this option to specify multiple plugins that should cause an alert. +Do this if you have multiple plugins on the command line but some of them involve the same server.</p> +<p>See also: --plugin. +Also known as: -A <pluginN></p> +</dd> +<dt><strong><a name="wait_seconds_seconds" class="item">--wait <seconds>[,<seconds>,...]</a></strong></dt> + +<dd> +<p>How long to wait between sending the message and checking that it was received. View default with +the -vV option.</p> +<p>When using the --plugin option, you can specify as many wait-between times as you have plugins +(minus the last plugin, because it makes no sense to wait after running the last one). For +example, if you use the --plugin option twice to specify an SMTP plugin and an IMAP plugin, and +you want to wait 5 seconds between sending and receiving, then you would specify --wait 5. A second +example, if you are using the --plugin option three times, then specifying -w 5 will wait 5 seconds +between the second and third plugins also. You can specify a different wait time +of 10 seconds between the second and third plugins, like this: -w 5,10.</p> +</dd> +<dt><strong><a name="hostname_server" class="item">--hostname <server></a></strong></dt> + +<dd> +<p>Address or name of the SMTP and IMAP server. Examples: mail.server.com, localhost, 192.168.1.100. +Also known as: -H <server></p> +</dd> +<dt><strong><a name="smtp_server_server" class="item">--smtp-server <server></a></strong></dt> + +<dd> +<p>Address or name of the SMTP server. Examples: smtp.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option.</p> +</dd> +<dt><strong><a name="smtp_port_number" class="item">--smtp-port <number></a></strong></dt> + +<dd> +<p>Service port on the SMTP server. Default is 25.</p> +</dd> +<dt><strong><a name="smtp_username_username" class="item">--smtp-username <username></a></strong></dt> + +<dt><strong><a name="smtp_password_password" class="item">--smtp-password <password></a></strong></dt> + +<dd> +<p>Username and password to use when connecting to the SMTP server with the TLS option. +Use these options if the SMTP account has a different username/password than the +IMAP account you are testing. These options take precendence over the --username and +the --password options.</p> +<p>These are shell-escaped; special characters are ok.</p> +</dd> +<dt><strong><a name="imap_server_server" class="item">--imap-server <server></a></strong></dt> + +<dd> +<p>Address or name of the IMAP server. Examples: imap.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option.</p> +</dd> +<dt><strong><a name="imap_port_number" class="item">--imap-port <number></a></strong></dt> + +<dd> +<p>Service port on the IMAP server. Default is 143. If you use SSL the default is 993.</p> +</dd> +<dt><strong><a name="imap_username_username" class="item">--imap-username <username></a></strong></dt> + +<dt><strong><a name="imap_password_password" class="item">--imap-password <password></a></strong></dt> + +<dd> +<p>Username and password to use when connecting to the IMAP server. +Use these options if the IMAP account has a different username/password than the +SMTP account you are testing. These options take precendence over the --username and +the --password options.</p> +<p>These are shell-escaped; special characters are ok.</p> +</dd> +<dt><strong><a name="username_username" class="item">--username <username></a></strong></dt> + +<dt><strong><a name="password_password" class="item">--password <password></a></strong></dt> + +<dd> +<p>Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password></p> +<p>Also used as the username and password for SMTP when the TLS option is enabled. +To specify a separate set of credentials for SMTP authentication, see the +options --smtp-username and --smtp-password.</p> +</dd> +<dt><strong><a name="imap_check_interval_seconds" class="item">--imap-check-interval <seconds></a></strong></dt> + +<dd> +<p>How long to wait between polls of the imap-server for the specified mail. Default is 5 seconds.</p> +</dd> +<dt><strong><a name="imap_retries_times" class="item">--imap-retries <times></a></strong></dt> + +<dd> +<p>How many times to poll the imap-server for the mail, before we give up. Default is 10.</p> +</dd> +<dt><strong><a name="body_message" class="item">--body <message></a></strong></dt> + +<dd> +<p>Use this option to specify the body of the email message.</p> +</dd> +<dt><strong><a name="header_header" class="item">--header <header></a></strong></dt> + +<dd> +<p>Use this option to set an arbitrary header in the message. You can use it multiple times.</p> +</dd> +<dt><strong><a name="mailto_recipient_your_net" class="item">--mailto <a href="mailto:recipient@your.net">recipient@your.net</a></a></strong></dt> + +<dd> +<p>You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed):</p> +<p>$ check_email_delivery ... --mailto <a href="mailto:recipient@your.net,recipient2@your.net">recipient@your.net,recipient2@your.net</a> --mailfrom <a href="mailto:sender@your.net">sender@your.net</a></p> +<p>This argument is shell-escaped; special characters or angle brackets around the address are ok.</p> +</dd> +<dt><strong><a name="mailfrom_sender_your_net" class="item">--mailfrom <a href="mailto:sender@your.net">sender@your.net</a></a></strong></dt> + +<dd> +<p>Use this option to set the "from" address in the email.</p> +</dd> +<dt><strong><a name="imapssl_item_noimapssl" class="item">--imapssl +=item --noimapssl</a></strong></dt> + +<dd> +<p>Use this to enable or disable SSL for the IMAP plugin.</p> +<p>This argument is shell-escaped; special characters or angle brackets around the address are ok.</p> +</dd> +<dt><strong><a name="smtptls_item_nosmtptls" class="item">--smtptls +=item --nosmtptls</a></strong></dt> + +<dd> +<p>Use this to enable or disable TLS/AUTH for the SMTP plugin.</p> +</dd> +<dt><strong><a name="libexec" class="item">--libexec</a></strong></dt> + +<dd> +<p>Use this option to set the path of the Nagios libexec directory. The default is +/usr/local/nagios/libexec. This is where this plugin looks for the SMTP and IMAP +plugins that it depends on.</p> +</dd> +<dt><strong><a name="plugin_command" class="item">--plugin <command></a></strong></dt> + +<dd> +<p>This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It frees the plugin from depending on specific external plugins and generalizes the +work done to determine that the email loop is operational. When using the --plugin +option, the following options are ignored: libexec, imapssl, smtptls, hostname, +username, password, smtp*, imap*, mailto, mailfrom, body, header, search.</p> +<p>Use this option multiple times to specify the complete trip. Typically, you would use +this twice to specify plugins for SMTP and IMAP, or SMTP and POP3.</p> +<p>The output will be success if all the plugins return success. Each plugin should be a +standard Nagios plugin.</p> +<p>A random token will be automatically generated and passed to each plugin specified on +the command line by substituting the string %TOKEN1%.</p> +<p>Example usage:</p> +<pre> + command_name check_email_delivery + command_line check_email_delivery + --plugin "$USER1$/check_smtp_send -H $ARG1$ --mailto recipient@your.net --mailfrom sender@your.net --header 'Subject: Nagios Test %TOKEN1%.'" + --plugin "$USER1$/check_imap_receive -H $ARG1$ -U $ARG1$ -P $ARG2$ -s SUBJECT -s 'Nagios Test %TOKEN1%.'"</pre> +<p>This technique allows for a lot of flexibility in configuring the plugins that test +each part of your email delivery loop.</p> +<p>See also: --token. +Also known as: -p <command></p> +</dd> +<dt><strong><a name="token_format" class="item">--token <format></a></strong></dt> + +<dd> +<p>This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It can be used in conjunction with --plugin to control the tokens that are generated +and passed to the plugins, like %TOKEN1%.</p> +<p>Use this option multiple times to specify formats for different tokens. For example, +if you want %TOKEN1% to consist of only alphabetical characters but want %TOKEN2% to +consist of only digits, then you might use these options: --token aaaaaa --token nnnnn</p> +<p>Any tokens used in your plugin commands that have not been specified by --token <format> +will default to --token U-X-Y</p> +<p>Token formats: +a - alpha character (a-z) +n - numeric character (0-9) +c - alphanumeric character (a-z0-9) +h - hexadecimal character (0-9a-f) +U - unix time, seconds from epoch. eg 1193012441 +X - a word from the pgp even list. eg aardvark +Y - a word from the pgp odd list. eg adroitness</p> +<p>Caution: It has been observed that some IMAP servers do not handle underscores well in the +search criteria. For best results, avoid using underscores in your tokens. Use hyphens or commas instead.</p> +<p>See also: --plugin. +Also known as: -T <format></p> +<p>The PGP word list was obtained from <a href="http://en.wikipedia.org/wiki/PGP_word_list">http://en.wikipedia.org/wiki/PGP_word_list</a></p> +</dd> +<dt><strong><a name="file_file" class="item">--file <file></a></strong></dt> + +<dd> +<p>Save (append) status information into the given tab-delimited file. Format used:</p> +<pre> + token start-time end-time status plugin-num output</pre> +<p>Note: format may change in future versions and may become configurable.</p> +<p>This option available as of version 0.6.2.</p> +<p>Also known as: -F <file></p> +</dd> +<dt><strong><a name="hires" class="item">--hires</a></strong></dt> + +<dd> +<p>Use the Time::HiRes module to measure time, if available.</p> +</dd> +<dt><strong><a name="verbose" class="item">--verbose</a></strong></dt> + +<dd> +<p>Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. +Also known as: -v</p> +</dd> +<dt><strong><a name="version" class="item">--version</a></strong></dt> + +<dd> +<p>Display plugin version and exit. +Also known as: -V</p> +</dd> +<dt><strong><a name="help" class="item">--help</a></strong></dt> + +<dd> +<p>Display this documentation and exit. Does not work in the ePN version. +Also known as: -h</p> +</dd> +<dt><strong><a name="usage" class="item">--usage</a></strong></dt> + +<dd> +<p>Display a short usage instruction and exit.</p> +</dd> +</dl> +<p> +</p> +<hr /> +<h1><a name="examples">EXAMPLES</a></h1> +<p> +</p> +<h2><a name="send_a_message_with_custom_headers">Send a message with custom headers</a></h2> +<p>$ check_email_delivery -H mail.server.net --mailto <a href="mailto:recipient@your.net">recipient@your.net</a> --mailfrom <a href="mailto:sender@your.net">sender@your.net</a> +--username recipient --password secret</p> +<p>EMAIL DELIVERY OK - 1 seconds</p> +<p> +</p> +<h2><a name="set_warning_and_critical_timeouts_for_receive_plugin_only_">Set warning and critical timeouts for receive plugin only:</a></h2> +<p>$ check_email_delivery -H mail.server.net --mailto <a href="mailto:recipient@your.net">recipient@your.net</a> --mailfrom <a href="mailto:sender@your.net">sender@your.net</a> +--username recipient --password secret -w ,,5 -c ,,15</p> +<p>EMAIL DELIVERY OK - 1 seconds</p> +<p> +</p> +<hr /> +<h1><a name="exit_codes">EXIT CODES</a></h1> +<p><table cellspacing="0" cellpadding="0"><tr><td>Complies with the Nagios plug-in specification: +<tr><td> 0<td>OK<td>The plugin was able to check the service and it appeared to be functioning properly +<tr><td> 1<td>Warning<td>The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +<tr><td> 2<td>Critical<td>The plugin detected that either the service was not running or it was above some "critical" threshold +<tr><td> 3<td>Unknown<td>Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service</table></p> +<p> +</p> +<hr /> +<h1><a name="nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></h1> +<p>Nagios plugin reference: <a href="http://nagiosplug.sourceforge.net/developer-guidelines.html">http://nagiosplug.sourceforge.net/developer-guidelines.html</a></p> +<p>This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.</p> +<p>Other than that, it attempts to follow published guidelines for Nagios plugins.</p> +<p> +</p> +<hr /> +<h1><a name="changes">CHANGES</a></h1> +<pre> + Wed Oct 29 13:08:00 PST 2005 + + version 0.1</pre> +<pre> + Wed Nov 9 17:16:09 PST 2005 + + updated arguments to check_smtp_send and check_imap_receive + + added eval/alarm block to implement -c option + + added wait option to adjust sleep time between smtp and imap calls + + added delay-warn and delay-crit options to adjust email delivery warning thresholds + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2</pre> +<pre> + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson <johann (at) axis.com>) + + version 0.2.1 + + corrected bug in getoptions ($imap_server would never ever be set from command-line...) + + will not make $smtp_server and $imap_server == $host if they're defined on commandline + + added support for multiple polls of imap-server, with specified intervals + + changed default behaviour in check_imap_server (searches for the specific id in subject and deletes mails found) + + increased default delay_warn from 65 seconds to 95 seconds</pre> +<pre> + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton <geoff.crompton@strategicdata.com.au>) + + fixed a bug in getoptions + + version 0.2.2</pre> +<pre> + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + version 0.2.3</pre> +<pre> + Fri Apr 27 20:32:53 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + changed connection error to display timeout only if timeout was the error + + default IMAP plugin is libexec/check_imap_receive (also checking for same but with .pl extension) + + default SMTP plugin is libexec/check_smtp_send (also checking for same but with .pl extension) + + removed default values for SMTP port and IMAP port to allow those plugins to set the defaults; so current behavior stays the same and will continue to make sense with SSL + + version 0.3</pre> +<pre> + Thu Oct 11 10:00:00 EET 2007 (by Timo Virtaneva <timo (at) virtaneva dot com> + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.3.1</pre> +<pre> + Sun Oct 21 11:01:03 PDT 2007 + + added support for TLS options to the SMTP plugin + + version 0.4</pre> +<pre> + Sun Oct 21 16:17:14 PDT 2007 + + added support for arbitrary plugins to send and receive mail (or anthing else!). see the --plugin option. + + version 0.5</pre> +<pre> + Tue Dec 4 07:36:20 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + shortcut option for --token is now -T to avoid clash with standard shortcut -t for --timeout + + fixed some minor pod formatting issues for perldoc + + version 0.5.1</pre> +<pre> + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.5.2</pre> +<pre> + Thu Jan 17 20:27:36 PST 2008 (by Timo Virtaneva <timo (at) virtaneva dot com> on Thu Oct 11 10:00:00 EET 2007) + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.5.3</pre> +<pre> + Mon Jan 28 22:11:02 PST 2008 + + fixed a bug, smtp-password and imap-password are now string parameters + + added --alert option to allow selection of which plugin(s) should cause a WARNING or CRITICAL alert + + version 0.6</pre> +<pre> + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.6.1</pre> +<pre> + Mon May 26 10:39:19 PDT 2008 + + added --file option to allow plugin to record status information into a tab-delimited file + + changed default token from U_X_Y to U-X-Y + + version 0.6.2</pre> +<pre> + Wed Jan 14 08:29:35 PST 2009 + + fixed a bug that the --header parameter was not being passed to the smtp plugin. + + version 0.6.3</pre> +<pre> + Mon Jun 8 15:43:48 PDT 2009 + + added performance data for use with PNP4Nagios! (thanks to Ben Ritcey for the patch) + + version 0.6.4</pre> +<pre> + Wed Sep 16 07:10:10 PDT 2009 + + added elapsed time in seconds to performance data + + version 0.6.5</pre> +<pre> + Fri Oct 8 19:48:44 PDT 2010 + + fixed uniform IMAP and SMTP username and password bug (thanks to Micle Moerenhout for pointing it out) + + version 0.6.6</pre> +<pre> + Mon Jan 3 08:24:23 PST 2011 + + added shell escaping for smtp-username, smtp-password, mailto, mailfrom, imap-username, and imap-password arguments + + version 0.7.0</pre> +<pre> + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1</pre> +<pre> + Sun Jun 12 17:17:06 AST 2011 + + added --imap-mailbox option to pass through to check_imap_receive --mailbox option + + added --ssl option to conveniently enable both --smtp-tls and --imap-ssl + + version 0.7.2</pre> +<p> +</p> +<hr /> +<h1><a name="author">AUTHOR</a></h1> +<p>Jonathan Buhacoff <<a href="mailto:jonathan@buhacoff.net">jonathan@buhacoff.net</a>></p> +<p> +</p> +<hr /> +<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1> +<pre> + Copyright (C) 2005-2011 Jonathan Buhacoff</pre> +<pre> + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version.</pre> +<pre> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details.</pre> +<pre> + You should have received a copy of the GNU General Public License + along with this program. If not, see <<a href="http://www.gnu.org/licenses/>">http://www.gnu.org/licenses/></a>;.</pre> +<pre> + <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></pre> + +</body> + +</html> diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod new file mode 100644 index 0000000..8e8c9dc --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod @@ -0,0 +1,472 @@ + + +=pod + +=head1 NAME + +check_email_delivery - sends email and verifies delivery + +=head1 SYNOPSIS + + check_email_delivery -vV + check_email_delivery --usage + check_email_delivery --help + +=head1 OPTIONS + +=over + +=item --warning <seconds>[,<smtp_seconds>,<imap_seconds>] + +Exit with WARNING if the most recent email found is older than <seconds>. The +optional <smtp_seconds> and <imap_seconds> parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -w <seconds>[,<send>[,<recv>]] + +When using the --plugin option, only one parameter is supported (-w <seconds>) and it will apply +to the entire process. You can specify a warning threshold specific to each plugin in the +plugin command line. + +When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions. + +=item --critical <seconds>[,<smtp_seconds>,<imap_seconds>] + +Exit with CRITICAL if the most recent email found is older than <seconds>. The +optional <smtp_seconds> and <imap_seconds> parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -c <seconds>[,<send>[,<recv>]] + +When using the --plugin option, only one parameter is supported (-c <seconds>) and it will apply +to the entire process. You can specify a critical threshold specific to each plugin in the +plugin command line. + +When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions. + +=item --timeout <seconds> + +=item --timeout <smtp_seconds>,<imap_seconds> + +=item --timeout <plugin1_seconds>,<plugin2_seconds>,... + +Exit with CRITICAL if the plugins do not return a status within the specified number of seconds. +When only one parameter is used, it applies to each plugin. When multiple parameters are used +(separated by commas) they apply to plugins in the same order the plugins were specified on the +command line. When using --timeout but not the --plugin option, the first parameter is for +check_smtp_send and the second is for check_imap_receive. + +=item --alert <pluginN> + +Exit with WARNING or CRITICAL only if a warning or error (--warning, --critical, or --timeout) +occurs for specified plugins. If a warning or error occurs for non-specified plugins that run +BEFORE the specified plugins, the exit status will be UNKNOWN. If a warning of error occurs +for non-specified plugins that run AFTER the specified plugins, the exit status will not be +affected. + +You would use this option if you are using check_email_delivery with the --plugin option and +the plugins you configure each use different servers, for example different SMTP and IMAP servers. +By default, if you do not use the --alert option, if anything goes wrong during the email delivery +check, a WARNING or CRITICAL alert will be issued. This means that if you define check_email_delivery +for the SMTP server only and the IMAP server fails, Nagios will alert you for the SMTP server which +would be misleading. If you define it for both the SMTP server and IMAP server and just one of them +fails, Nagios will alert you for both servers, which would still be misleading. If you have this +situation, you may want to use the --alert option. You define the check_email_delivery check for +both servers: for the SMTP server (first plugin) you use --alert 1, and for for the IMAP server +(second plugin) you use --alert 2. When check_email_delivery runs with --alert 1 and the SMTP +server fails, you will get the appropriate alert. If the IMAP server fails it will not affect the +status. When check_email_delivery runs with --alert 2 and the SMTP server fails, you will get the +UNKNOWN return code. If the IMAP server generates an alert you will get a WARNING or CRITICAL as +appropriate. + +You can repeat this option to specify multiple plugins that should cause an alert. +Do this if you have multiple plugins on the command line but some of them involve the same server. + +See also: --plugin. +Also known as: -A <pluginN> + + +=item --wait <seconds>[,<seconds>,...] + +How long to wait between sending the message and checking that it was received. View default with +the -vV option. + +When using the --plugin option, you can specify as many wait-between times as you have plugins +(minus the last plugin, because it makes no sense to wait after running the last one). For +example, if you use the --plugin option twice to specify an SMTP plugin and an IMAP plugin, and +you want to wait 5 seconds between sending and receiving, then you would specify --wait 5. A second +example, if you are using the --plugin option three times, then specifying -w 5 will wait 5 seconds +between the second and third plugins also. You can specify a different wait time +of 10 seconds between the second and third plugins, like this: -w 5,10. + +=item --hostname <server> + +Address or name of the SMTP and IMAP server. Examples: mail.server.com, localhost, 192.168.1.100. +Also known as: -H <server> + +=item --smtp-server <server> + +Address or name of the SMTP server. Examples: smtp.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option. + +=item --smtp-port <number> + +Service port on the SMTP server. Default is 25. + +=item --smtp-username <username> + +=item --smtp-password <password> + +Username and password to use when connecting to the SMTP server with the TLS option. +Use these options if the SMTP account has a different username/password than the +IMAP account you are testing. These options take precendence over the --username and +the --password options. + +These are shell-escaped; special characters are ok. + +=item --imap-server <server> + +Address or name of the IMAP server. Examples: imap.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option. + +=item --imap-port <number> + +Service port on the IMAP server. Default is 143. If you use SSL the default is 993. + +=item --imap-username <username> + +=item --imap-password <password> + +Username and password to use when connecting to the IMAP server. +Use these options if the IMAP account has a different username/password than the +SMTP account you are testing. These options take precendence over the --username and +the --password options. + +These are shell-escaped; special characters are ok. + +=item --username <username> + +=item --password <password> + +Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password> + +Also used as the username and password for SMTP when the TLS option is enabled. +To specify a separate set of credentials for SMTP authentication, see the +options --smtp-username and --smtp-password. + +=item --imap-check-interval <seconds> + +How long to wait between polls of the imap-server for the specified mail. Default is 5 seconds. + +=item --imap-retries <times> + +How many times to poll the imap-server for the mail, before we give up. Default is 10. + +=item --body <message> + +Use this option to specify the body of the email message. + +=item --header <header> + +Use this option to set an arbitrary header in the message. You can use it multiple times. + +=item --mailto recipient@your.net + +You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed): + +$ check_email_delivery ... --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net + +This argument is shell-escaped; special characters or angle brackets around the address are ok. + +=item --mailfrom sender@your.net + +Use this option to set the "from" address in the email. + +=item --imapssl +=item --noimapssl + +Use this to enable or disable SSL for the IMAP plugin. + +This argument is shell-escaped; special characters or angle brackets around the address are ok. + +=item --smtptls +=item --nosmtptls + +Use this to enable or disable TLS/AUTH for the SMTP plugin. + +=item --libexec + +Use this option to set the path of the Nagios libexec directory. The default is +/usr/local/nagios/libexec. This is where this plugin looks for the SMTP and IMAP +plugins that it depends on. + +=item --plugin <command> + +This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It frees the plugin from depending on specific external plugins and generalizes the +work done to determine that the email loop is operational. When using the --plugin +option, the following options are ignored: libexec, imapssl, smtptls, hostname, +username, password, smtp*, imap*, mailto, mailfrom, body, header, search. + +Use this option multiple times to specify the complete trip. Typically, you would use +this twice to specify plugins for SMTP and IMAP, or SMTP and POP3. + +The output will be success if all the plugins return success. Each plugin should be a +standard Nagios plugin. + +A random token will be automatically generated and passed to each plugin specified on +the command line by substituting the string %TOKEN1%. + +Example usage: + + command_name check_email_delivery + command_line check_email_delivery + --plugin "$USER1$/check_smtp_send -H $ARG1$ --mailto recipient@your.net --mailfrom sender@your.net --header 'Subject: Nagios Test %TOKEN1%.'" + --plugin "$USER1$/check_imap_receive -H $ARG1$ -U $ARG1$ -P $ARG2$ -s SUBJECT -s 'Nagios Test %TOKEN1%.'" + +This technique allows for a lot of flexibility in configuring the plugins that test +each part of your email delivery loop. + +See also: --token. +Also known as: -p <command> + +=item --token <format> + +This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It can be used in conjunction with --plugin to control the tokens that are generated +and passed to the plugins, like %TOKEN1%. + +Use this option multiple times to specify formats for different tokens. For example, +if you want %TOKEN1% to consist of only alphabetical characters but want %TOKEN2% to +consist of only digits, then you might use these options: --token aaaaaa --token nnnnn + +Any tokens used in your plugin commands that have not been specified by --token <format> +will default to --token U-X-Y + +Token formats: +a - alpha character (a-z) +n - numeric character (0-9) +c - alphanumeric character (a-z0-9) +h - hexadecimal character (0-9a-f) +U - unix time, seconds from epoch. eg 1193012441 +X - a word from the pgp even list. eg aardvark +Y - a word from the pgp odd list. eg adroitness + +Caution: It has been observed that some IMAP servers do not handle underscores well in the +search criteria. For best results, avoid using underscores in your tokens. Use hyphens or commas instead. + +See also: --plugin. +Also known as: -T <format> + +The PGP word list was obtained from http://en.wikipedia.org/wiki/PGP_word_list + +=item --file <file> + +Save (append) status information into the given tab-delimited file. Format used: + + token start-time end-time status plugin-num output + +Note: format may change in future versions and may become configurable. + +This option available as of version 0.6.2. + +Also known as: -F <file> + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Send a message with custom headers + +$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret + +EMAIL DELIVERY OK - 1 seconds + +=head2 Set warning and critical timeouts for receive plugin only: + +$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret -w ,,5 -c ,,15 + +EMAIL DELIVERY OK - 1 seconds + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 CHANGES + + Wed Oct 29 13:08:00 PST 2005 + + version 0.1 + + Wed Nov 9 17:16:09 PST 2005 + + updated arguments to check_smtp_send and check_imap_receive + + added eval/alarm block to implement -c option + + added wait option to adjust sleep time between smtp and imap calls + + added delay-warn and delay-crit options to adjust email delivery warning thresholds + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson <johann (at) axis.com>) + + version 0.2.1 + + corrected bug in getoptions ($imap_server would never ever be set from command-line...) + + will not make $smtp_server and $imap_server == $host if they're defined on commandline + + added support for multiple polls of imap-server, with specified intervals + + changed default behaviour in check_imap_server (searches for the specific id in subject and deletes mails found) + + increased default delay_warn from 65 seconds to 95 seconds + + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton <geoff.crompton@strategicdata.com.au>) + + fixed a bug in getoptions + + version 0.2.2 + + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + version 0.2.3 + + Fri Apr 27 20:32:53 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + changed connection error to display timeout only if timeout was the error + + default IMAP plugin is libexec/check_imap_receive (also checking for same but with .pl extension) + + default SMTP plugin is libexec/check_smtp_send (also checking for same but with .pl extension) + + removed default values for SMTP port and IMAP port to allow those plugins to set the defaults; so current behavior stays the same and will continue to make sense with SSL + + version 0.3 + + Thu Oct 11 10:00:00 EET 2007 (by Timo Virtaneva <timo (at) virtaneva dot com> + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.3.1 + + Sun Oct 21 11:01:03 PDT 2007 + + added support for TLS options to the SMTP plugin + + version 0.4 + + Sun Oct 21 16:17:14 PDT 2007 + + added support for arbitrary plugins to send and receive mail (or anthing else!). see the --plugin option. + + version 0.5 + + Tue Dec 4 07:36:20 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + shortcut option for --token is now -T to avoid clash with standard shortcut -t for --timeout + + fixed some minor pod formatting issues for perldoc + + version 0.5.1 + + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.5.2 + + Thu Jan 17 20:27:36 PST 2008 (by Timo Virtaneva <timo (at) virtaneva dot com> on Thu Oct 11 10:00:00 EET 2007) + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.5.3 + + Mon Jan 28 22:11:02 PST 2008 + + fixed a bug, smtp-password and imap-password are now string parameters + + added --alert option to allow selection of which plugin(s) should cause a WARNING or CRITICAL alert + + version 0.6 + + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.6.1 + + Mon May 26 10:39:19 PDT 2008 + + added --file option to allow plugin to record status information into a tab-delimited file + + changed default token from U_X_Y to U-X-Y + + version 0.6.2 + + Wed Jan 14 08:29:35 PST 2009 + + fixed a bug that the --header parameter was not being passed to the smtp plugin. + + version 0.6.3 + + Mon Jun 8 15:43:48 PDT 2009 + + added performance data for use with PNP4Nagios! (thanks to Ben Ritcey for the patch) + + version 0.6.4 + + Wed Sep 16 07:10:10 PDT 2009 + + added elapsed time in seconds to performance data + + version 0.6.5 + + Fri Oct 8 19:48:44 PDT 2010 + + fixed uniform IMAP and SMTP username and password bug (thanks to Micle Moerenhout for pointing it out) + + version 0.6.6 + + Mon Jan 3 08:24:23 PST 2011 + + added shell escaping for smtp-username, smtp-password, mailto, mailfrom, imap-username, and imap-password arguments + + version 0.7.0 + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1 + + Sun Jun 12 17:17:06 AST 2011 + + added --imap-mailbox option to pass through to check_imap_receive --mailbox option + + added --ssl option to conveniently enable both --smtp-tls and --imap-ssl + + version 0.7.2 + +=head1 AUTHOR + +Jonathan Buhacoff <jonathan@buhacoff.net> + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + + http://www.gnu.org/licenses/gpl.txt + +=cut diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html new file mode 100644 index 0000000..8548ca0 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html @@ -0,0 +1,258 @@ +<?xml version="1.0" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>check_imap_quota - connects to an IMAP account and checks the quota</title> +<link rel="stylesheet" href="plainwhite.css" type="text/css" /> +<meta http-equiv="content-type" content="text/html; charset=utf-8" /> +<link rev="made" href="mailto:jonathan@greek.local" /> +</head> + +<body> + + +<!-- INDEX BEGIN --> +<div name="index"> +<p><a name="__index__"></a></p> +<!-- + +<ul> + + <li><a href="#name">NAME</a></li> + <li><a href="#synopsis">SYNOPSIS</a></li> + <li><a href="#options">OPTIONS</a></li> + <li><a href="#examples">EXAMPLES</a></li> + <ul> + + <li><a href="#report_how_many_emails_are_in_the_mailbox">Report how many emails are in the mailbox</a></li> + <li><a href="#report_the_email_with_the_highest_value">Report the email with the highest value</a></li> + <li><a href="#troubleshoot_your_search_parameters">Troubleshoot your search parameters</a></li> + </ul> + + <li><a href="#exit_codes">EXIT CODES</a></li> + <li><a href="#nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></li> + <li><a href="#see_also">SEE ALSO</a></li> + <li><a href="#changes">CHANGES</a></li> + <li><a href="#author">AUTHOR</a></li> + <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li> +</ul> + +--> + + +</div> +<!-- INDEX END --> + +<p> +</p> +<hr /> +<h1><a name="name">NAME</a></h1> +<p>check_imap_quota - connects to an IMAP account and checks the quota</p> +<p> +</p> +<hr /> +<h1><a name="synopsis">SYNOPSIS</a></h1> +<pre> + check_imap_quota -vV + check_imap_quota -? + check_imap_quota --help</pre> +<p> +</p> +<hr /> +<h1><a name="options">OPTIONS</a></h1> +<dl> +<dt><strong><a name="warning_seconds" class="item">--warning <seconds></a></strong></dt> + +<dd> +<p>Warn if it takes longer than <seconds> to connect to the IMAP server. Default is 15 seconds. +Also known as: -w <seconds></p> +</dd> +<dt><strong><a name="critical_seconds" class="item">--critical <seconds></a></strong></dt> + +<dd> +<p>Return a critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical <messages> +Also known as: -c <seconds></p> +</dd> +<dt><strong><a name="timeout_seconds" class="item">--timeout <seconds></a></strong></dt> + +<dd> +<p>Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds></p> +</dd> +<dt><strong><a name="hostname_server" class="item">--hostname <server></a></strong></dt> + +<dd> +<p>Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server></p> +</dd> +<dt><strong><a name="port_number" class="item">--port <number></a></strong></dt> + +<dd> +<p>Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number></p> +</dd> +<dt><strong><a name="username_username" class="item">--username <username></a></strong></dt> + +<dt><strong><a name="password_password" class="item">--password <password></a></strong></dt> + +<dd> +<p>Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password></p> +</dd> +<dt><strong><a name="mailbox_mailbox" class="item">--mailbox <mailbox></a></strong></dt> + +<dd> +<p>Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m <mailbox></p> +</dd> +<dt><strong><a name="ssl" class="item">--ssl</a></strong></dt> + +<dt><strong><a name="nossl" class="item">--nossl</a></strong></dt> + +<dd> +<p>Enable SSL protocol. Requires IO::Socket::SSL.</p> +<p>Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option.</p> +<p>Use the nossl option to turn off the ssl option.</p> +</dd> +<dt><strong><a name="hires" class="item">--hires</a></strong></dt> + +<dd> +<p>Use the Time::HiRes module to measure time, if available.</p> +</dd> +<dt><strong><a name="verbose" class="item">--verbose</a></strong></dt> + +<dd> +<p>Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values.</p> +<p>If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server.</p> +<p>Also known as: -v</p> +</dd> +<dt><strong><a name="version" class="item">--version</a></strong></dt> + +<dd> +<p>Display plugin version and exit. +Also known as: -V</p> +</dd> +<dt><strong><a name="help" class="item">--help</a></strong></dt> + +<dd> +<p>Display this documentation and exit. Does not work in the ePN version. +Also known as: -h</p> +</dd> +<dt><strong><a name="usage" class="item">--usage</a></strong></dt> + +<dd> +<p>Display a short usage instruction and exit.</p> +</dd> +</dl> +<p> +</p> +<hr /> +<h1><a name="examples">EXAMPLES</a></h1> +<p> +</p> +<h2><a name="report_how_many_emails_are_in_the_mailbox">Report how many emails are in the mailbox</a></h2> +<pre> + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete</pre> +<pre> + IMAP RECEIVE OK - 1 seconds, 7 found</pre> +<p> +</p> +<h2><a name="report_the_email_with_the_highest_value">Report the email with the highest value</a></h2> +<p>Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated):</p> +<pre> + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: <auto-000000992528@server.net></pre> +<pre> + Homeruns 5</pre> +<p>And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values:</p> +<pre> + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured</pre> +<pre> + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted</pre> +<p> +</p> +<h2><a name="troubleshoot_your_search_parameters">Troubleshoot your search parameters</a></h2> +<p>Add the --nodelete and --imap-retries=1 parameters to your command line.</p> +<p> +</p> +<hr /> +<h1><a name="exit_codes">EXIT CODES</a></h1> +<p><table cellspacing="0" cellpadding="0"><tr><td>Complies with the Nagios plug-in specification: +<tr><td> 0<td>OK<td>The plugin was able to check the service and it appeared to be functioning properly +<tr><td> 1<td>Warning<td>The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +<tr><td> 2<td>Critical<td>The plugin detected that either the service was not running or it was above some "critical" threshold +<tr><td> 3<td>Unknown<td>Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service</table></p> +<p> +</p> +<hr /> +<h1><a name="nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></h1> +<p>Nagios plugin reference: <a href="http://nagiosplug.sourceforge.net/developer-guidelines.html">http://nagiosplug.sourceforge.net/developer-guidelines.html</a></p> +<p>This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.</p> +<p>Other than that, it attempts to follow published guidelines for Nagios plugins.</p> +<p> +</p> +<hr /> +<h1><a name="see_also">SEE ALSO</a></h1> +<p><a href="http://nagios.org/">http://nagios.org/</a> +<a href="http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod">http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod</a> +<a href="http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod">http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod</a></p> +<p> +</p> +<hr /> +<h1><a name="changes">CHANGES</a></h1> +<pre> + Fri Nov 11 04:53:09 AST 2011 + + version 0.1 created with quota code contributed by Johan Romme</pre> +<pre> + Tue Dec 20 17:38:04 PST 2011 + + fixed bug where a quota of 0 was reported as an incorrect response from the server, thanks to Eike Arndt + + version 0.2</pre> +<p> +</p> +<hr /> +<h1><a name="author">AUTHOR</a></h1> +<p>Jonathan Buhacoff <<a href="mailto:jonathan@buhacoff.net">jonathan@buhacoff.net</a>></p> +<p> +</p> +<hr /> +<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1> +<pre> + Copyright (C) 2011 Jonathan Buhacoff</pre> +<pre> + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version.</pre> +<pre> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details.</pre> +<pre> + You should have received a copy of the GNU General Public License + along with this program. If not, see <<a href="http://www.gnu.org/licenses/>">http://www.gnu.org/licenses/></a>;.</pre> +<pre> + <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></pre> + +</body> + +</html> diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod new file mode 100644 index 0000000..03a02c2 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod @@ -0,0 +1,196 @@ + + + +=pod + +=head1 NAME + +check_imap_quota - connects to an IMAP account and checks the quota + +=head1 SYNOPSIS + + check_imap_quota -vV + check_imap_quota -? + check_imap_quota --help + +=head1 OPTIONS + +=over + +=item --warning <seconds> + +Warn if it takes longer than <seconds> to connect to the IMAP server. Default is 15 seconds. +Also known as: -w <seconds> + +=item --critical <seconds> + +Return a critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical <messages> +Also known as: -c <seconds> + +=item --timeout <seconds> + +Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds> + +=item --hostname <server> + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server> + +=item --port <number> + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number> + +=item --username <username> + +=item --password <password> + +Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password> + +=item --mailbox <mailbox> + +Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m <mailbox> + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires IO::Socket::SSL. + +Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option. + +Use the nossl option to turn off the ssl option. + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. + +If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Report how many emails are in the mailbox + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete + + IMAP RECEIVE OK - 1 seconds, 7 found + +=head2 Report the email with the highest value + +Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated): + + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: <auto-000000992528@server.net> + + Homeruns 5 + +And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values: + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured + + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted + +=head2 Troubleshoot your search parameters + +Add the --nodelete and --imap-retries=1 parameters to your command line. + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 SEE ALSO + +http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Fri Nov 11 04:53:09 AST 2011 + + version 0.1 created with quota code contributed by Johan Romme + + Tue Dec 20 17:38:04 PST 2011 + + fixed bug where a quota of 0 was reported as an incorrect response from the server, thanks to Eike Arndt + + version 0.2 + +=head1 AUTHOR + +Jonathan Buhacoff <jonathan@buhacoff.net> + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html new file mode 100644 index 0000000..fee7c08 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html @@ -0,0 +1,551 @@ +<?xml version="1.0" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>check_imap_receive - connects to and searches an IMAP account for messages</title> +<link rel="stylesheet" href="plainwhite.css" type="text/css" /> +<meta http-equiv="content-type" content="text/html; charset=utf-8" /> +<link rev="made" href="mailto:jonathan@greek.local" /> +</head> + +<body> + + +<!-- INDEX BEGIN --> +<div name="index"> +<p><a name="__index__"></a></p> +<!-- + +<ul> + + <li><a href="#name">NAME</a></li> + <li><a href="#synopsis">SYNOPSIS</a></li> + <li><a href="#options">OPTIONS</a></li> + <li><a href="#examples">EXAMPLES</a></li> + <ul> + + <li><a href="#report_how_many_emails_are_in_the_mailbox">Report how many emails are in the mailbox</a></li> + <li><a href="#report_the_email_with_the_highest_value">Report the email with the highest value</a></li> + <li><a href="#troubleshoot_your_search_parameters">Troubleshoot your search parameters</a></li> + </ul> + + <li><a href="#exit_codes">EXIT CODES</a></li> + <li><a href="#nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></li> + <li><a href="#see_also">SEE ALSO</a></li> + <li><a href="#changes">CHANGES</a></li> + <li><a href="#author">AUTHOR</a></li> + <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li> +</ul> + +--> + + +</div> +<!-- INDEX END --> + +<p> +</p> +<hr /> +<h1><a name="name">NAME</a></h1> +<p>check_imap_receive - connects to and searches an IMAP account for messages</p> +<p> +</p> +<hr /> +<h1><a name="synopsis">SYNOPSIS</a></h1> +<pre> + check_imap_receive -vV + check_imap_receive -? + check_imap_receive --help</pre> +<p> +</p> +<hr /> +<h1><a name="options">OPTIONS</a></h1> +<dl> +<dt><strong><a name="warning_seconds" class="item">--warning <seconds></a></strong></dt> + +<dd> +<p>Warn if it takes longer than <seconds> to connect to the IMAP server. Default is 15 seconds. +Also known as: -w <seconds></p> +</dd> +<dt><strong><a name="critical_seconds" class="item">--critical <seconds></a></strong></dt> + +<dd> +<p>Return a critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical <messages> +Also known as: -c <seconds></p> +</dd> +<dt><strong><a name="timeout_seconds" class="item">--timeout <seconds></a></strong></dt> + +<dd> +<p>Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds></p> +</dd> +<dt><strong><a name="imap_check_interval_seconds" class="item">--imap-check-interval <seconds></a></strong></dt> + +<dd> +<p>How long to wait after searching for a matching message before searching again. Only takes effect +if no messages were found. Default is 5 seconds.</p> +</dd> +<dt><strong><a name="imap_retries_number" class="item">--imap-retries <number></a></strong></dt> + +<dd> +<p>How many times to try searching for a matching message before giving up. If you set this to 0 then +messages will not be searched at all. Setting this to 1 means the plugin only tries once. Etc. +Default is 10 times.</p> +</dd> +<dt><strong><a name="hostname_server" class="item">--hostname <server></a></strong></dt> + +<dd> +<p>Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server></p> +</dd> +<dt><strong><a name="port_number" class="item">--port <number></a></strong></dt> + +<dd> +<p>Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number></p> +</dd> +<dt><strong><a name="username_username" class="item">--username <username></a></strong></dt> + +<dt><strong><a name="password_password" class="item">--password <password></a></strong></dt> + +<dd> +<p>Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password></p> +</dd> +<dt><strong><a name="mailbox_mailbox" class="item">--mailbox <mailbox></a></strong></dt> + +<dd> +<p>Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m <mailbox></p> +</dd> +<dt><strong><a name="search_string" class="item">--search <string></a></strong></dt> + +<dd> +<p>Use this option to filter the messages. Default is not to filter. You may (must) use this option +multiple times in order to create any valid IMAP search criteria. See the examples and see also +<a href="http://www.ietf.org/rfc/rfc2060.txt">http://www.ietf.org/rfc/rfc2060.txt</a> (look for section 6.4.4, the SEARCH command)</p> +<p>This is the way to find messages matching a given subject: + -s SUBJECT -s "a given subject"</p> +<p>You can use the following technique for any header, including Subject. To find "Header-Name: some value": + -s HEADER -s Header-Name -s "some value"</p> +<p>Modern IMAP servers that support rfc5032 extensions allow you to search for messages +older or younger than a number of seconds. So to find messages received in the past hour, +you can do:</p> +<pre> + -s YOUNGER -s 3600</pre> +<p>Or to find messages received more than 5 minutes ago, you can do:</p> +<pre> + -s OLDER -s 300</pre> +<p>Also known as: -s <string></p> +</dd> +<dt><strong><a name="download" class="item">--download</a></strong></dt> + +<dt><strong><a name="nodownload" class="item">--nodownload</a></strong></dt> + +<dd> +<p>This option causes all messages in the specified mailbox to be downloaded from the server +and searched locally. See --download-max if you only want to download a few messages. +Currently only the following <a href="http://www.ietf.org/rfc/rfc2060.txt" class="rfc">RFC 2060</a> search criteria are supported: +TEXT, BODY, SUBJECT, HEADER, NOT, OR, SENTBEFORE, SENTON, SENTSINCE.</p> +<p>Requires Email::Simple to be installed. It is available on CPAN.</p> +<p>This option may be particularly useful to you if your mail server is slow to index +messages (like Exchange 2003), causing the plugin not to find them with IMAP SEARCH +even though they are in the inbox.</p> +<p>It's also useful if you're searching for messages that have been on the server for a +specified amount of time, like some minutes or hours, because the standard IMAP search +function only allows whole dates. For this, use the standard search keywords but you +can specify either just a date like in <a href="http://www.ietf.org/rfc/rfc2060.txt" class="rfc">RFC 2060</a> or a date and a time.</p> +<p>If you use SENTBEFORE, SENTON, or SENTSINCE, you must have Date::Manip installed +on your system.</p> +</dd> +<dt><strong><a name="download_max" class="item">--download-max</a></strong></dt> + +<dd> +<p>Limits the number of messages downloaded from the server when the --download option is used. +Default is to download and search all messages.</p> +</dd> +<dt><strong><a name="search_critical_min_messages" class="item">--search-critical-min <messages></a></strong></dt> + +<dd> +<p>This option will trigger a CRITICAL status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search.</p> +<p>This parameter defaults to 1 so that if no messages are found, the plugin will exit with a CRITICAL status.</p> +<p>If you want the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0.</p> +</dd> +<dt><strong><a name="search_critical_max_messages" class="item">--search-critical-max <messages></a></strong></dt> + +<dd> +<p>This option will trigger a CRITICAL status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search.</p> +<p>This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +CRITICAL if it finds 11 messages. If you set it to 1, the plugin will exit with CRITICAL if it finds +any more than 1 message. If you set it to 0, the plugin will exit with CRITICAL if it finds any messages +at all. If you set it to -1 it will be disabled.</p> +</dd> +<dt><strong><a name="search_warning_min_messages" class="item">--search-warning-min <messages></a></strong></dt> + +<dd> +<p>This option will trigger a WARNING status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search.</p> +<p>This parameter defaults to 1 so that if no messages are found, the plugin will exit with a WARNING status.</p> +<p>If you want to suppress the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. When this parameter is 0, it means that you expect the mailbox not to have any messages.</p> +</dd> +<dt><strong><a name="search_warning_max_messages" class="item">--search-warning-max <messages></a></strong></dt> + +<dd> +<p>This option will trigger a WARNING status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search.</p> +<p>This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +WARNING if it finds 11 messages. If you set it to 1, the plugin will exit with WARNING if it finds +any more than 1 message. If you set it to 0, the plugin will exit with WARNING if it finds any messages +at all. If you set it to -1 it will be disabled.</p> +</dd> +<dt><strong><a name="capture_max_regexp" class="item">--capture-max <regexp></a></strong></dt> + +<dd> +<p>In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-max" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the highest captured value.</p> +<p>The regexp is expected to capture a numeric value.</p> +</dd> +<dt><strong><a name="capture_min_regexp" class="item">--capture-min <regexp></a></strong></dt> + +<dd> +<p>In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-min" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the lowest captured value.</p> +<p>The regexp is expected to capture a numeric value.</p> +</dd> +<dt><strong><a name="delete" class="item">--delete</a></strong></dt> + +<dt><strong><a name="nodelete" class="item">--nodelete</a></strong></dt> + +<dd> +<p>Use the delete option to delete messages that matched the search criteria. This is useful for +preventing the mailbox from filling up with automated messages (from the check_smtp_send plugin, for example). +THE DELETE OPTION IS TURNED *ON* BY DEFAULT, in order to preserve compatibility with an earlier version.</p> +<p>Use the nodelete option to turn off the delete option.</p> +</dd> +<dt><strong><a name="nodelete_captured" class="item">--nodelete-captured</a></strong></dt> + +<dd> +<p>If you use both the capture-max and delete arguments, you can also use the nodelete-captured argument to specify that the email +with the highest captured value should not be deleted. This leaves it available for comparison the next time this plugin runs.</p> +<p>If you do not use the delete option, this option has no effect.</p> +</dd> +<dt><strong><a name="ssl" class="item">--ssl</a></strong></dt> + +<dt><strong><a name="nossl" class="item">--nossl</a></strong></dt> + +<dd> +<p>Enable SSL protocol. Requires IO::Socket::SSL.</p> +<p>Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option.</p> +<p>Use the nossl option to turn off the ssl option.</p> +</dd> +<dt><strong><a name="ssl_ca_file" class="item">--ssl-ca-file</a></strong></dt> + +<dd> +<p>Use this to verify the server SSL certificate against a local .pem file. You'll need to +specify the path to the .pem file as the parameter.</p> +<p>You can use the imap_ssl_cert utility included in this distribution to connect to your IMAP +server and save its SSL certificates into your .pem file. Usage is like this:</p> +<pre> + imap_ssl_cert -H imap.server.com > ca_file.pem</pre> +<p>Only applicable when --ssl option is enabled.</p> +</dd> +<dt><strong><a name="template" class="item">--template</a></strong></dt> + +<dt><strong><a name="notemplate" class="item">--notemplate</a></strong></dt> + +<dd> +<p>Enable (or disable) processing of IMAP search parameters. Requires Text::Template and Date::Manip.</p> +<p>Use this option to apply special processing to IMAP search parameters that allows you to use the +results of arbitrary computations as the parameter values. For example, you can use this feature +to search for message received up to 4 hours ago.</p> +<p>Modern IMAP servers that support rfc5032 extensions allow searching with the YOUNGER and OLDER +criteria so a message received up to 4 hours ago is -s YOUNGER -s 14400. But if your mail server +doesn't support that, you could use the --template option to get similar functionality.</p> +<p>When you enable the --template option, each parameter you pass to the -s option is parsed by +Text::Template. See the Text::Template manual for more information, but in general any expression +written in Perl will work.</p> +<p>A convenience function called rfc2822dateHeader is provided to you so you can easily compute properly +formatted dates for use as search parameters. The rfc2822date function can take one or two +parameters itself: the date to format and an optional offset. To use the current time as a +search parameter, you can write this:</p> +<pre> + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{rfc2822dateHeader("now")}'</pre> +<p>The output of {rfc2822dateHeader("now")} looks like this: Wed, 30 Sep 2009 22:44:03 -0700 and +is suitable for use with a date header, like HEADER Delivery-Date.</p> +<p>To use a time in the past relative to the current time or day, you can use a second convenience function +called rfc2822date and write this:</p> +<pre> + $ check_imap_receive ... --template -s SENTSINCE -s '{rfc2822date("now","-1 day")}'</pre> +<p>The output of {rfc2822date("now","-1 day")} looks like this: 29-Sep-2009 and is suitable for use +with BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, and SINCE.</p> +<p>I have seen some email clients use a different format in the Date field, +like September 17, 2009 9:46:51 AM PDT. To specify an arbitrary format like this one, write this:</p> +<pre> + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{date("%B %e, %Y %i:%M:%S %p %Z","now","-4 hours")}'</pre> +<p>You can use BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, or SINCE to search for messages that arrived +on, before, or after a given day but not on, before, or after a specific time on that day.</p> +<p>To search for messages that arrived on, before, or after a specific time you have to use the +Delivery-Date or another date field, like with -s HEADER -s Delivery-Date in the example above.</p> +<p>See the Date::Manip manual for more information on the allowed expressions for date and delta strings.</p> +</dd> +<dt><strong><a name="hires" class="item">--hires</a></strong></dt> + +<dd> +<p>Use the Time::HiRes module to measure time, if available.</p> +</dd> +<dt><strong><a name="verbose" class="item">--verbose</a></strong></dt> + +<dd> +<p>Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values.</p> +<p>If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server.</p> +<p>Also known as: -v</p> +</dd> +<dt><strong><a name="version" class="item">--version</a></strong></dt> + +<dd> +<p>Display plugin version and exit. +Also known as: -V</p> +</dd> +<dt><strong><a name="help" class="item">--help</a></strong></dt> + +<dd> +<p>Display this documentation and exit. Does not work in the ePN version. +Also known as: -h</p> +</dd> +<dt><strong><a name="usage" class="item">--usage</a></strong></dt> + +<dd> +<p>Display a short usage instruction and exit.</p> +</dd> +</dl> +<p> +</p> +<hr /> +<h1><a name="examples">EXAMPLES</a></h1> +<p> +</p> +<h2><a name="report_how_many_emails_are_in_the_mailbox">Report how many emails are in the mailbox</a></h2> +<pre> + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete</pre> +<pre> + IMAP RECEIVE OK - 1 seconds, 7 found</pre> +<p> +</p> +<h2><a name="report_the_email_with_the_highest_value">Report the email with the highest value</a></h2> +<p>Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated):</p> +<pre> + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: <auto-000000992528@server.net></pre> +<pre> + Homeruns 5</pre> +<p>And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values:</p> +<pre> + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured</pre> +<pre> + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted</pre> +<p> +</p> +<h2><a name="troubleshoot_your_search_parameters">Troubleshoot your search parameters</a></h2> +<p>Add the --nodelete and --imap-retries=1 parameters to your command line.</p> +<p> +</p> +<hr /> +<h1><a name="exit_codes">EXIT CODES</a></h1> +<p><table cellspacing="0" cellpadding="0"><tr><td>Complies with the Nagios plug-in specification: +<tr><td> 0<td>OK<td>The plugin was able to check the service and it appeared to be functioning properly +<tr><td> 1<td>Warning<td>The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +<tr><td> 2<td>Critical<td>The plugin detected that either the service was not running or it was above some "critical" threshold +<tr><td> 3<td>Unknown<td>Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service</table></p> +<p> +</p> +<hr /> +<h1><a name="nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></h1> +<p>Nagios plugin reference: <a href="http://nagiosplug.sourceforge.net/developer-guidelines.html">http://nagiosplug.sourceforge.net/developer-guidelines.html</a></p> +<p>This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.</p> +<p>Other than that, it attempts to follow published guidelines for Nagios plugins.</p> +<p> +</p> +<hr /> +<h1><a name="see_also">SEE ALSO</a></h1> +<p><a href="http://nagios.org/">http://nagios.org/</a> +<a href="http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod">http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod</a> +<a href="http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod">http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod</a></p> +<p> +</p> +<hr /> +<h1><a name="changes">CHANGES</a></h1> +<pre> + Wed Oct 29 11:00:00 PST 2005 + + version 0.1</pre> +<pre> + Wed Nov 9 09:53:32 PST 2005 + + added delete/nodelete option. deleting found messages is still default behavior. + + added capture-max option + + added nodelete-captured option + + added mailbox option + + added eval/alarm block to implement -c option + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2</pre> +<pre> + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson <johann (at) axis.com>) + + version 0.2.1 + + added support for multiple polls of imap-server, with specified intervals</pre> +<pre> + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + added patch from Benjamin Ritcey <ben@ritcey.com> for SSL support on machines that have an SSL-enabled + + version 0.2.3</pre> +<pre> + Fri Apr 27 18:56:50 PDT 2007 + + fixed problem that "Invalid search parameters" was not printed because of missing newline to flush it + + warnings and critical errors now try to append error messages received from the IMAP client + + changed connection error to display timeout only if timeout was the error + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + added abbreviations U for username, P for password, m for mailbox + + fixed bug that imap-check-interval applied even after the last try (imap-retries) when it was not necessary + + the IMAP expunge command is not sent unless at least one message is deleted + + fixed bug that the "no messages" warning was printed even if some messages were found + + version 0.3</pre> +<pre> + Sun Oct 21 14:08:07 PDT 2007 + + added port info to the "could not connect" error message + + fixed bug that occurred when using --ssl --port 143 which caused port to remain at the default 993 imap/ssl port + + added clarity shortcuts --search-subject and --search-header + + port is no longer a required option. defaults to 143 for regular IMAP and 993 for IMAP/SSL + + version 0.3.1</pre> +<pre> + Sun Oct 21 20:41:56 PDT 2007 + + reworked ssl support to use IO::Socket::SSL instead of the convenience method Mail::IMAPClient->Ssl (which is not included in the standard Mail::IMAPClient package) + + removed clarity shortcuts (bad idea, code bloat) + + version 0.4</pre> +<pre> + Tue Dec 4 07:05:27 PST 2007 + + added version check to _read_line workaround for SSL-related bug in Mail::IMAPClient version 2.2.9 ; newer versions fixed the bug + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.1</pre> +<pre> + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.4.2</pre> +<pre> + Mon Jan 7 21:35:23 PST 2008 + + changed version check for Mail::IMAPClient version 2.2.9 to use string comparison le "2.2.9" + + fixed bug where script was dying on socket->autoflush when socket does not exist because autoflush was being called before checking the socket object + + version 0.4.3</pre> +<pre> + Mon Feb 11 19:13:38 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.4</pre> +<pre> + Mon May 26 08:33:27 PDT 2008 + + fixed a bug for number captured, it now reflects number of messages captured instead of always returning "1" + + added --capture-min option to complement --capture-max + + added --search-critical-min to trigger a CRITICAL alert if number of messages found is less than argument, with default 1. + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.5</pre> +<pre> + Wed Jul 2 14:59:05 PDT 2008 + + fixed a bug for not finding a message after the first try, by reselecting the mailbox before each search + + version 0.5.1</pre> +<pre> + Sat Dec 13 08:57:29 PST 2008 + + added --download option to allow local searching of messages (useful if your server has an index that handles searching but it takes a while before new emails show up and you want immediate results), supports only the TEXT, BODY, SUBJECT, and HEADER search keys + + added --download-max option to set a limit on number of messages downloaded with --download + + version 0.6.0</pre> +<pre> + Wed Sep 30 23:25:33 PDT 2009 + + fixed --download-max option (was incorrectly looking for --download_max). currently both will work, in the future only --download-max will work + + added --template option to allow arbitrary substitutions for search parameters, and provided three convenience functions for working with dates + + added date search criteria to the --download option: SENTBEFORE, SENTON, and SENTSINCE which check the Date header and allow hours and minutes in addition to dates (whereas the IMAP standard only allows dates) + + added --search-critical-max to trigger a CRITICAL alert if number of messages found is more than argument, disabled by default. + + fixed a bug in --download --search where messages would match even though they failed the search criteria + + changed behavior of --download-max to look at the most recent messages first (hopefully); the IMAP protocol doesn't guarantee the order that the messages are returned but I observed that many mail servers return them in chronological order; so now --download-max reverses the order to look at the newer messages first + + added performance data for use with PNP4Nagios! + + version 0.7.0</pre> +<pre> + Fri Oct 2 15:22:00 PDT 2009 + + added --search-warning-max and --search-warning-min to trigger a WARNING alert if number of messages is more than or less than the specified number. + + fixed --download option not to fail with CRITICAL if mailbox is empty; now this can be configured with --search-warning-min or --search-critical-min + + version 0.7.1</pre> +<pre> + Sat Nov 21 18:27:17 PST 2009 + + fixed problem with using --download option on certain mail servers by turning on the IgnoreSizeErrors feature in IMAPClient + + added --peek option to prevent marking messages as seen + + version 0.7.2</pre> +<pre> + Tue Jan 5 12:13:53 PST 2010 + + added error message and exit with unknown status when an unrecognized IMAP search criteria is encountered by the --download --search option</pre> +<pre> + Wed May 5 11:14:51 PDT 2010 + + added mailbox list when mailbox is not found and verbose level 3 is on (-vvv) + + version 0.7.3</pre> +<pre> + Tue Mar 8 18:58:14 AST 2011 + + updated documentation for --search and --template to mention rfc5032 extensions (thanks to Stuart Henderson)</pre> +<pre> + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.4</pre> +<pre> + Fri Nov 11 01:51:40 AST 2011 + + added --ssl-ca-file option to allow verifying the server certificate against a local .pem file (thanks to Alexandre Bezroutchko) + + added imap_ssl_cert.pl utility (not in this file) to conveniently save the server's SSL certificates into a local .pem file + + version 0.7.5</pre> +<p> +</p> +<hr /> +<h1><a name="author">AUTHOR</a></h1> +<p>Jonathan Buhacoff <<a href="mailto:jonathan@buhacoff.net">jonathan@buhacoff.net</a>></p> +<p> +</p> +<hr /> +<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1> +<pre> + Copyright (C) 2005-2011 Jonathan Buhacoff</pre> +<pre> + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version.</pre> +<pre> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details.</pre> +<pre> + You should have received a copy of the GNU General Public License + along with this program. If not, see <<a href="http://www.gnu.org/licenses/>">http://www.gnu.org/licenses/></a>;.</pre> +<pre> + <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></pre> + +</body> + +</html> diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod new file mode 100644 index 0000000..9e9faf9 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod @@ -0,0 +1,507 @@ + + + +=pod + +=head1 NAME + +check_imap_receive - connects to and searches an IMAP account for messages + +=head1 SYNOPSIS + + check_imap_receive -vV + check_imap_receive -? + check_imap_receive --help + +=head1 OPTIONS + +=over + +=item --warning <seconds> + +Warn if it takes longer than <seconds> to connect to the IMAP server. Default is 15 seconds. +Also known as: -w <seconds> + +=item --critical <seconds> + +Return a critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical <messages> +Also known as: -c <seconds> + +=item --timeout <seconds> + +Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds> + +=item --imap-check-interval <seconds> + +How long to wait after searching for a matching message before searching again. Only takes effect +if no messages were found. Default is 5 seconds. + +=item --imap-retries <number> + +How many times to try searching for a matching message before giving up. If you set this to 0 then +messages will not be searched at all. Setting this to 1 means the plugin only tries once. Etc. +Default is 10 times. + +=item --hostname <server> + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server> + +=item --port <number> + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number> + +=item --username <username> + +=item --password <password> + +Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password> + +=item --mailbox <mailbox> + +Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m <mailbox> + +=item --search <string> + +Use this option to filter the messages. Default is not to filter. You may (must) use this option +multiple times in order to create any valid IMAP search criteria. See the examples and see also +http://www.ietf.org/rfc/rfc2060.txt (look for section 6.4.4, the SEARCH command) + +This is the way to find messages matching a given subject: + -s SUBJECT -s "a given subject" + +You can use the following technique for any header, including Subject. To find "Header-Name: some value": + -s HEADER -s Header-Name -s "some value" + +Modern IMAP servers that support rfc5032 extensions allow you to search for messages +older or younger than a number of seconds. So to find messages received in the past hour, +you can do: + + -s YOUNGER -s 3600 + +Or to find messages received more than 5 minutes ago, you can do: + + -s OLDER -s 300 + +Also known as: -s <string> + +=item --download + +=item --nodownload + +This option causes all messages in the specified mailbox to be downloaded from the server +and searched locally. See --download-max if you only want to download a few messages. +Currently only the following RFC 2060 search criteria are supported: +TEXT, BODY, SUBJECT, HEADER, NOT, OR, SENTBEFORE, SENTON, SENTSINCE. + +Requires Email::Simple to be installed. It is available on CPAN. + +This option may be particularly useful to you if your mail server is slow to index +messages (like Exchange 2003), causing the plugin not to find them with IMAP SEARCH +even though they are in the inbox. + +It's also useful if you're searching for messages that have been on the server for a +specified amount of time, like some minutes or hours, because the standard IMAP search +function only allows whole dates. For this, use the standard search keywords but you +can specify either just a date like in RFC 2060 or a date and a time. + +If you use SENTBEFORE, SENTON, or SENTSINCE, you must have Date::Manip installed +on your system. + + +=item --download-max + +Limits the number of messages downloaded from the server when the --download option is used. +Default is to download and search all messages. + +=item --search-critical-min <messages> + +This option will trigger a CRITICAL status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search. + +This parameter defaults to 1 so that if no messages are found, the plugin will exit with a CRITICAL status. + +If you want the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. + +=item --search-critical-max <messages> + +This option will trigger a CRITICAL status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search. + +This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +CRITICAL if it finds 11 messages. If you set it to 1, the plugin will exit with CRITICAL if it finds +any more than 1 message. If you set it to 0, the plugin will exit with CRITICAL if it finds any messages +at all. If you set it to -1 it will be disabled. + +=item --search-warning-min <messages> + +This option will trigger a WARNING status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search. + +This parameter defaults to 1 so that if no messages are found, the plugin will exit with a WARNING status. + +If you want to suppress the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. When this parameter is 0, it means that you expect the mailbox not to have any messages. + +=item --search-warning-max <messages> + +This option will trigger a WARNING status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search. + +This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +WARNING if it finds 11 messages. If you set it to 1, the plugin will exit with WARNING if it finds +any more than 1 message. If you set it to 0, the plugin will exit with WARNING if it finds any messages +at all. If you set it to -1 it will be disabled. + +=item --capture-max <regexp> + +In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-max" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the highest captured value. + +The regexp is expected to capture a numeric value. + +=item --capture-min <regexp> + +In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-min" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the lowest captured value. + +The regexp is expected to capture a numeric value. + +=item --delete + +=item --nodelete + +Use the delete option to delete messages that matched the search criteria. This is useful for +preventing the mailbox from filling up with automated messages (from the check_smtp_send plugin, for example). +THE DELETE OPTION IS TURNED *ON* BY DEFAULT, in order to preserve compatibility with an earlier version. + +Use the nodelete option to turn off the delete option. + +=item --nodelete-captured + +If you use both the capture-max and delete arguments, you can also use the nodelete-captured argument to specify that the email +with the highest captured value should not be deleted. This leaves it available for comparison the next time this plugin runs. + +If you do not use the delete option, this option has no effect. + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires IO::Socket::SSL. + +Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option. + +Use the nossl option to turn off the ssl option. + +=item --ssl-ca-file + +Use this to verify the server SSL certificate against a local .pem file. You'll need to +specify the path to the .pem file as the parameter. + +You can use the imap_ssl_cert utility included in this distribution to connect to your IMAP +server and save its SSL certificates into your .pem file. Usage is like this: + + imap_ssl_cert -H imap.server.com > ca_file.pem + +Only applicable when --ssl option is enabled. + +=item --template + +=item --notemplate + +Enable (or disable) processing of IMAP search parameters. Requires Text::Template and Date::Manip. + +Use this option to apply special processing to IMAP search parameters that allows you to use the +results of arbitrary computations as the parameter values. For example, you can use this feature +to search for message received up to 4 hours ago. + +Modern IMAP servers that support rfc5032 extensions allow searching with the YOUNGER and OLDER +criteria so a message received up to 4 hours ago is -s YOUNGER -s 14400. But if your mail server +doesn't support that, you could use the --template option to get similar functionality. + +When you enable the --template option, each parameter you pass to the -s option is parsed by +Text::Template. See the Text::Template manual for more information, but in general any expression +written in Perl will work. + +A convenience function called rfc2822dateHeader is provided to you so you can easily compute properly +formatted dates for use as search parameters. The rfc2822date function can take one or two +parameters itself: the date to format and an optional offset. To use the current time as a +search parameter, you can write this: + + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{rfc2822dateHeader("now")}' + +The output of {rfc2822dateHeader("now")} looks like this: Wed, 30 Sep 2009 22:44:03 -0700 and +is suitable for use with a date header, like HEADER Delivery-Date. + +To use a time in the past relative to the current time or day, you can use a second convenience function +called rfc2822date and write this: + + $ check_imap_receive ... --template -s SENTSINCE -s '{rfc2822date("now","-1 day")}' + +The output of {rfc2822date("now","-1 day")} looks like this: 29-Sep-2009 and is suitable for use +with BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, and SINCE. + +I have seen some email clients use a different format in the Date field, +like September 17, 2009 9:46:51 AM PDT. To specify an arbitrary format like this one, write this: + + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{date("%B %e, %Y %i:%M:%S %p %Z","now","-4 hours")}' + +You can use BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, or SINCE to search for messages that arrived +on, before, or after a given day but not on, before, or after a specific time on that day. + +To search for messages that arrived on, before, or after a specific time you have to use the +Delivery-Date or another date field, like with -s HEADER -s Delivery-Date in the example above. + +See the Date::Manip manual for more information on the allowed expressions for date and delta strings. + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. + +If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Report how many emails are in the mailbox + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete + + IMAP RECEIVE OK - 1 seconds, 7 found + +=head2 Report the email with the highest value + +Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated): + + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: <auto-000000992528@server.net> + + Homeruns 5 + +And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values: + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured + + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted + +=head2 Troubleshoot your search parameters + +Add the --nodelete and --imap-retries=1 parameters to your command line. + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 SEE ALSO + +http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Wed Oct 29 11:00:00 PST 2005 + + version 0.1 + + Wed Nov 9 09:53:32 PST 2005 + + added delete/nodelete option. deleting found messages is still default behavior. + + added capture-max option + + added nodelete-captured option + + added mailbox option + + added eval/alarm block to implement -c option + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson <johann (at) axis.com>) + + version 0.2.1 + + added support for multiple polls of imap-server, with specified intervals + + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + added patch from Benjamin Ritcey <ben@ritcey.com> for SSL support on machines that have an SSL-enabled + + version 0.2.3 + + Fri Apr 27 18:56:50 PDT 2007 + + fixed problem that "Invalid search parameters" was not printed because of missing newline to flush it + + warnings and critical errors now try to append error messages received from the IMAP client + + changed connection error to display timeout only if timeout was the error + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + added abbreviations U for username, P for password, m for mailbox + + fixed bug that imap-check-interval applied even after the last try (imap-retries) when it was not necessary + + the IMAP expunge command is not sent unless at least one message is deleted + + fixed bug that the "no messages" warning was printed even if some messages were found + + version 0.3 + + Sun Oct 21 14:08:07 PDT 2007 + + added port info to the "could not connect" error message + + fixed bug that occurred when using --ssl --port 143 which caused port to remain at the default 993 imap/ssl port + + added clarity shortcuts --search-subject and --search-header + + port is no longer a required option. defaults to 143 for regular IMAP and 993 for IMAP/SSL + + version 0.3.1 + + Sun Oct 21 20:41:56 PDT 2007 + + reworked ssl support to use IO::Socket::SSL instead of the convenience method Mail::IMAPClient->Ssl (which is not included in the standard Mail::IMAPClient package) + + removed clarity shortcuts (bad idea, code bloat) + + version 0.4 + + Tue Dec 4 07:05:27 PST 2007 + + added version check to _read_line workaround for SSL-related bug in Mail::IMAPClient version 2.2.9 ; newer versions fixed the bug + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.1 + + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.4.2 + + Mon Jan 7 21:35:23 PST 2008 + + changed version check for Mail::IMAPClient version 2.2.9 to use string comparison le "2.2.9" + + fixed bug where script was dying on socket->autoflush when socket does not exist because autoflush was being called before checking the socket object + + version 0.4.3 + + Mon Feb 11 19:13:38 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.4 + + Mon May 26 08:33:27 PDT 2008 + + fixed a bug for number captured, it now reflects number of messages captured instead of always returning "1" + + added --capture-min option to complement --capture-max + + added --search-critical-min to trigger a CRITICAL alert if number of messages found is less than argument, with default 1. + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.5 + + Wed Jul 2 14:59:05 PDT 2008 + + fixed a bug for not finding a message after the first try, by reselecting the mailbox before each search + + version 0.5.1 + + Sat Dec 13 08:57:29 PST 2008 + + added --download option to allow local searching of messages (useful if your server has an index that handles searching but it takes a while before new emails show up and you want immediate results), supports only the TEXT, BODY, SUBJECT, and HEADER search keys + + added --download-max option to set a limit on number of messages downloaded with --download + + version 0.6.0 + + Wed Sep 30 23:25:33 PDT 2009 + + fixed --download-max option (was incorrectly looking for --download_max). currently both will work, in the future only --download-max will work + + added --template option to allow arbitrary substitutions for search parameters, and provided three convenience functions for working with dates + + added date search criteria to the --download option: SENTBEFORE, SENTON, and SENTSINCE which check the Date header and allow hours and minutes in addition to dates (whereas the IMAP standard only allows dates) + + added --search-critical-max to trigger a CRITICAL alert if number of messages found is more than argument, disabled by default. + + fixed a bug in --download --search where messages would match even though they failed the search criteria + + changed behavior of --download-max to look at the most recent messages first (hopefully); the IMAP protocol doesn't guarantee the order that the messages are returned but I observed that many mail servers return them in chronological order; so now --download-max reverses the order to look at the newer messages first + + added performance data for use with PNP4Nagios! + + version 0.7.0 + + Fri Oct 2 15:22:00 PDT 2009 + + added --search-warning-max and --search-warning-min to trigger a WARNING alert if number of messages is more than or less than the specified number. + + fixed --download option not to fail with CRITICAL if mailbox is empty; now this can be configured with --search-warning-min or --search-critical-min + + version 0.7.1 + + Sat Nov 21 18:27:17 PST 2009 + + fixed problem with using --download option on certain mail servers by turning on the IgnoreSizeErrors feature in IMAPClient + + added --peek option to prevent marking messages as seen + + version 0.7.2 + + Tue Jan 5 12:13:53 PST 2010 + + added error message and exit with unknown status when an unrecognized IMAP search criteria is encountered by the --download --search option + + Wed May 5 11:14:51 PDT 2010 + + added mailbox list when mailbox is not found and verbose level 3 is on (-vvv) + + version 0.7.3 + + Tue Mar 8 18:58:14 AST 2011 + + updated documentation for --search and --template to mention rfc5032 extensions (thanks to Stuart Henderson) + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.4 + + Fri Nov 11 01:51:40 AST 2011 + + added --ssl-ca-file option to allow verifying the server certificate against a local .pem file (thanks to Alexandre Bezroutchko) + + added imap_ssl_cert.pl utility (not in this file) to conveniently save the server's SSL certificates into a local .pem file + + version 0.7.5 + +=head1 AUTHOR + +Jonathan Buhacoff <jonathan@buhacoff.net> + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html new file mode 100644 index 0000000..0afa438 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html @@ -0,0 +1,375 @@ +<?xml version="1.0" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>check_smtp_send - connects to an SMTP server and sends a message</title> +<link rel="stylesheet" href="plainwhite.css" type="text/css" /> +<meta http-equiv="content-type" content="text/html; charset=utf-8" /> +<link rev="made" href="mailto:jonathan@greek.local" /> +</head> + +<body> + + +<!-- INDEX BEGIN --> +<div name="index"> +<p><a name="__index__"></a></p> +<!-- + +<ul> + + <li><a href="#name">NAME</a></li> + <li><a href="#synopsis">SYNOPSIS</a></li> + <li><a href="#options">OPTIONS</a></li> + <li><a href="#examples">EXAMPLES</a></li> + <ul> + + <li><a href="#send_a_message_with_custom_headers">Send a message with custom headers</a></li> + </ul> + + <li><a href="#exit_codes">EXIT CODES</a></li> + <li><a href="#nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></li> + <li><a href="#changes">CHANGES</a></li> + <li><a href="#author">AUTHOR</a></li> + <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li> +</ul> + +--> + + +</div> +<!-- INDEX END --> + +<p> +</p> +<hr /> +<h1><a name="name">NAME</a></h1> +<p>check_smtp_send - connects to an SMTP server and sends a message</p> +<p> +</p> +<hr /> +<h1><a name="synopsis">SYNOPSIS</a></h1> +<pre> + check_smtp_send -vV + check_smtp_send -? + check_smtp_send --help</pre> +<p> +</p> +<hr /> +<h1><a name="options">OPTIONS</a></h1> +<dl> +<dt><strong><a name="warning_seconds" class="item">--warning <seconds></a></strong></dt> + +<dd> +<p>Warn if it takes longer than <seconds> to connect to the SMTP server. Default is 15 seconds. +Also known as: -w <seconds></p> +</dd> +<dt><strong><a name="critical_seconds" class="item">--critical <seconds></a></strong></dt> + +<dd> +<p>Return a critical status if it takes longer than <seconds> to connect to the SMTP server. Default is 30 seconds. +Also known as: -c <seconds></p> +</dd> +<dt><strong><a name="timeout_seconds" class="item">--timeout <seconds></a></strong></dt> + +<dd> +<p>Abort with critical status if it takes longer than <seconds> to connect to the SMTP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds></p> +</dd> +<dt><strong><a name="hostname_server" class="item">--hostname <server></a></strong></dt> + +<dd> +<p>Address or name of the SMTP server. Examples: mail.server.com, localhost, 192.168.1.100</p> +<p>If not provided, and if there is only one --mailto address, the script will automatically look up the MX record +for the --mailto address and use that as the hostname. You can use this to check that your MX records are correct. +When omitting the --hostname option, it doesn't really make sense to specify --port, --username, or --password +but you can still do so and they will have their normal effect. To look up the MX records you need to have the +module Net::DNS and Email::Address installed.</p> +<p>Also known as: -H <server></p> +</dd> +<dt><strong><a name="port_number" class="item">--port <number></a></strong></dt> + +<dd> +<p>Service port on the SMTP server. Default is 25 for regular SMTP, 465 for SSL, and 587 for TLS. +Also known as: -p <number></p> +</dd> +<dt><strong><a name="tls" class="item">--tls</a></strong></dt> + +<dt><strong><a name="notls" class="item">--notls</a></strong></dt> + +<dd> +<p>Enable TLS/AUTH protocol. Requires Net::SMTP::TLS, availble on CPAN.</p> +<p>When using this option, the default port is 587. +You can specify a port from the command line using the --port option.</p> +<p>Use the notls option to turn off the tls option.</p> +<p>Also, you may need to fix your copy of Net::SMTP::TLS. Here is the diff against version 0.12:</p> +<pre> + 254c254 + < $me->_command(sprintf("AUTH PLAIN %S", + --- + > $me->_command(sprintf("AUTH PLAIN %s",</pre> +</dd> +<dt><strong><a name="ssl" class="item">--ssl</a></strong></dt> + +<dt><strong><a name="nossl" class="item">--nossl</a></strong></dt> + +<dd> +<p>Enable SSL protocol. Requires Net::SMTP::SSL and Authen::SASL, availble on CPAN.</p> +<p>When using this option, the default port is 465. You can override with the --port option.</p> +<p>Use the nossl option to turn off the ssl option.</p> +</dd> +<dt><strong><a name="auth_method" class="item">--auth <method></a></strong></dt> + +<dd> +<p>Enable authentication with Net::SMTP_auth (sold separately). +For example, try using --auth PLAIN or --auth CRAM-MD5.</p> +</dd> +<dt><strong><a name="username_username" class="item">--username <username></a></strong></dt> + +<dt><strong><a name="password_password" class="item">--password <password></a></strong></dt> + +<dd> +<p>Username and password to use when connecting to SMTP server. +Also known as: -U <username> -P <password></p> +</dd> +<dt><strong><a name="body_message" class="item">--body <message></a></strong></dt> + +<dd> +<p>Use this option to specify the body of the email message. If you need newlines in your message, +you might need to use the --stdin option instead.</p> +</dd> +<dt><strong><a name="header_header" class="item">--header <header></a></strong></dt> + +<dd> +<p>Use this option to set an arbitrary header in the message. You can use it multiple times.</p> +</dd> +<dt><strong><a name="stdin" class="item">--stdin</a></strong></dt> + +<dd> +<p>Grab the body of the email message from stdin.</p> +</dd> +<dt><strong><a name="mailto_recipient_your_net" class="item">--mailto <a href="mailto:recipient@your.net">recipient@your.net</a></a></strong></dt> + +<dd> +<p>You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed):</p> +<p>$ check_smtp_send -H mail.server.net --mailto <a href="mailto:recipient@your.net,recipient2@your.net">recipient@your.net,recipient2@your.net</a> --mailfrom <a href="mailto:sender@your.net">sender@your.net</a></p> +<p>SMTP SEND OK - 1 seconds</p> +</dd> +<dt><strong><a name="mailfrom_sender_your_net" class="item">--mailfrom <a href="mailto:sender@your.net">sender@your.net</a></a></strong></dt> + +<dd> +<p>Use this option to set the "from" address in the email.</p> +</dd> +<dt><strong><a name="template" class="item">--template</a></strong></dt> + +<dt><strong><a name="notemplate" class="item">--notemplate</a></strong></dt> + +<dd> +<p>Enable (or disable) processing of message body and headers. Requires Text::Template.</p> +<p>Use this option to apply special processing to your message body and headers that allows you to use the +results of arbitrary computations in the text. For example, you can use this feature to send a message +containing the hostname of the machine that sent the message without customizing the plugin configuration +on each machine.</p> +<p>When you enable the --template option, the message body and headers are parsed by +Text::Template. Even a message body provided using the --stdin option will be parsed. +See the Text::Template manual for more information, but in general any expression +written in Perl will work.</p> +<p>There is one convenience function provided to you, trim, which will remove leading and trailing whitespace +from its parameter. Here's an example:</p> +<pre> + check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net + --template --body 'hello, this message is from {use Sys::Hostname; hostname}' + --header 'Subject: test message from {trim(`whoami`)}'</pre> +</dd> +<dt><strong><a name="expect_response_code" class="item">--expect-response <code></a></strong></dt> + +<dd> +<p>Use this option to specify which SMTP response code should be expected from the server +after the SMTP dialog is complete. The default is 250 (message accepted).</p> +<p>Also known as: -E <code></p> +</dd> +<dt><strong><a name="hires" class="item">--hires</a></strong></dt> + +<dd> +<p>Use the Time::HiRes module to measure time, if available.</p> +</dd> +<dt><strong><a name="verbose" class="item">--verbose</a></strong></dt> + +<dd> +<p>Display additional information. Useful for troubleshooting.</p> +<p>One --verbose will show extra information for OK, WARNING, and CRITICAL status.</p> +<p>Use one --verbose together with --version to see the default warning and critical timeout values.</p> +<p>Three --verbose (or -vvv) will show debug information, unless you're using --tls because Net::SMTP::TLS +does not have a Debug feature.</p> +<p>Also known as: -v</p> +</dd> +<dt><strong><a name="version" class="item">--version</a></strong></dt> + +<dd> +<p>Display plugin version and exit. +Also known as: -V</p> +</dd> +<dt><strong><a name="help" class="item">--help</a></strong></dt> + +<dd> +<p>Display this documentation and exit. Does not work in the ePN version. +Also known as: -h</p> +</dd> +<dt><strong><a name="usage" class="item">--usage</a></strong></dt> + +<dd> +<p>Display a short usage instruction and exit.</p> +</dd> +</dl> +<p> +</p> +<hr /> +<h1><a name="examples">EXAMPLES</a></h1> +<p> +</p> +<h2><a name="send_a_message_with_custom_headers">Send a message with custom headers</a></h2> +<p>$ check_smtp_send -H mail.server.net --mailto <a href="mailto:recipient@your.net">recipient@your.net</a> --mailfrom <a href="mailto:sender@your.net">sender@your.net</a> +--body 'Homeruns 5' --header 'Subject: Hello, world!' --header 'X-Your-Header: Yes'</p> +<p>SMTP SEND OK - 1 seconds</p> +<p> +</p> +<hr /> +<h1><a name="exit_codes">EXIT CODES</a></h1> +<p><table cellspacing="0" cellpadding="0"><tr><td>Complies with the Nagios plug-in specification: +<tr><td> 0<td>OK<td>The plugin was able to check the service and it appeared to be functioning properly +<tr><td> 1<td>Warning<td>The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +<tr><td> 2<td>Critical<td>The plugin detected that either the service was not running or it was above some "critical" threshold +<tr><td> 3<td>Unknown<td>Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service</table></p> +<p> +</p> +<hr /> +<h1><a name="nagios_plugin_notes">NAGIOS PLUGIN NOTES</a></h1> +<p>Nagios plugin reference: <a href="http://nagiosplug.sourceforge.net/developer-guidelines.html">http://nagiosplug.sourceforge.net/developer-guidelines.html</a></p> +<p>This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.</p> +<p>Other than that, it attempts to follow published guidelines for Nagios plugins.</p> +<p> +</p> +<hr /> +<h1><a name="changes">CHANGES</a></h1> +<pre> + Wed Oct 29 14:05:00 PST 2005 + + version 0.1</pre> +<pre> + Wed Nov 9 15:01:48 PST 2005 + + now using an inline PluginReport package to generate the report + + added stdin option + + copyright notice and GNU GPL + + version 0.2</pre> +<pre> + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton <geoff.crompton@strategicdata.com.au>) + + added bailing if the $smtp->to() call fails + + added support for mailto recipients separated by commas + + version 0.2.1</pre> +<pre> + Tue Apr 24 21:17:53 PDT 2007 + + moved POD text to separate file in order to accomodate the new embedded-perl Nagios feature + + version 0.2.3</pre> +<pre> + Fri Apr 27 20:26:42 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + version 0.3 + + Sun Oct 21 10:34:14 PDT 2007 + + added support for TLS and authentication via the Net::SMTP::TLS module. see --tls option. + + version 0.4</pre> +<pre> + Sun Oct 21 13:54:26 PDT 2007 + + added support for SSL via the Net::SMTP::SSL module. see --ssl option. + + port is no longer a required option. defaults to 25 for regular smtp, 465 for ssl, and 587 for tls. + + added port info to the "could not connect" error message + + version 0.4.1</pre> +<pre> + Tue Dec 4 07:42:32 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.2</pre> +<pre> + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.3</pre> +<pre> + Mon May 26 09:12:14 PDT 2008 + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.4.4 + + Wed Jul 2 07:12:35 PDT 2008 + + added --expect-response option submitted by Christian Kauhaus <kc@gocept.com> + + added support for authentication via Net::SMTP_auth. see --auth option. + + version 0.4.5</pre> +<pre> + Sun Oct 5 15:18:23 PDT 2008 + + added error handling for smtp server disconnects ungracefully during QUIT (gmail.com does) + + version 0.4.6</pre> +<pre> + Thu Oct 1 12:09:35 PDT 2009 + + added --template option to allow arbitrary substitutions for body and headers, and provided one convenience function for trimming strings + + added performance data for use with PNP4Nagios! + + version 0.5.0</pre> +<pre> + Thu Oct 8 11:17:04 PDT 2009 + + added more detailed error messages when using --verbose + + version 0.5.1</pre> +<pre> + Tue Feb 9 12:14:49 PST 2010 + + added support for combining --auth with --tls using a subclass of Net::SMTP::TLS submitted by Brad Guillory; please note that to use the "PLAIN" authentication type you need to patch your Net::SMTP:TLS because it has a bug in sub auth_PLAIN (sprintf %S instead of %s) + + version 0.5.2</pre> +<pre> + Mon Jan 3 10:39:42 PST 2011 + + added default Date and Message-ID headers; Date header uses POSIX strftime and Message-ID header uses hostname command to get localhost name + + version 0.7.0</pre> +<pre> + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1</pre> +<pre> + Wed Jul 6 19:18:26 AST 2011 + + the --hostname is now optional; if not provided the plugin will lookup the MX record for the --mailto address (requires Net::DNS) + + version 0.7.2</pre> +<pre> + Tue Dec 13 09:24:04 PST 2011 + + separated authentication errors from connection errors + + version 0.7.3</pre> +<p> +</p> +<hr /> +<h1><a name="author">AUTHOR</a></h1> +<p>Jonathan Buhacoff <<a href="mailto:jonathan@buhacoff.net">jonathan@buhacoff.net</a>></p> +<p> +</p> +<hr /> +<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1> +<pre> + Copyright (C) 2005-2011 Jonathan Buhacoff</pre> +<pre> + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version.</pre> +<pre> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details.</pre> +<pre> + You should have received a copy of the GNU General Public License + along with this program. If not, see <<a href="http://www.gnu.org/licenses/>">http://www.gnu.org/licenses/></a>;.</pre> +<pre> + <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></pre> + +</body> + +</html> diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod new file mode 100644 index 0000000..db33549 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod @@ -0,0 +1,324 @@ + + +=pod + +=head1 NAME + +check_smtp_send - connects to an SMTP server and sends a message + +=head1 SYNOPSIS + + check_smtp_send -vV + check_smtp_send -? + check_smtp_send --help + +=head1 OPTIONS + +=over + +=item --warning <seconds> + +Warn if it takes longer than <seconds> to connect to the SMTP server. Default is 15 seconds. +Also known as: -w <seconds> + +=item --critical <seconds> + +Return a critical status if it takes longer than <seconds> to connect to the SMTP server. Default is 30 seconds. +Also known as: -c <seconds> + +=item --timeout <seconds> + +Abort with critical status if it takes longer than <seconds> to connect to the SMTP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds> + +=item --hostname <server> + +Address or name of the SMTP server. Examples: mail.server.com, localhost, 192.168.1.100 + +If not provided, and if there is only one --mailto address, the script will automatically look up the MX record +for the --mailto address and use that as the hostname. You can use this to check that your MX records are correct. +When omitting the --hostname option, it doesn't really make sense to specify --port, --username, or --password +but you can still do so and they will have their normal effect. To look up the MX records you need to have the +module Net::DNS and Email::Address installed. + +Also known as: -H <server> + +=item --port <number> + +Service port on the SMTP server. Default is 25 for regular SMTP, 465 for SSL, and 587 for TLS. +Also known as: -p <number> + +=item --tls + +=item --notls + +Enable TLS/AUTH protocol. Requires Net::SMTP::TLS, availble on CPAN. + +When using this option, the default port is 587. +You can specify a port from the command line using the --port option. + +Use the notls option to turn off the tls option. + +Also, you may need to fix your copy of Net::SMTP::TLS. Here is the diff against version 0.12: + + 254c254 + < $me->_command(sprintf("AUTH PLAIN %S", + --- + > $me->_command(sprintf("AUTH PLAIN %s", + + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires Net::SMTP::SSL and Authen::SASL, availble on CPAN. + +When using this option, the default port is 465. You can override with the --port option. + +Use the nossl option to turn off the ssl option. + +=item --auth <method> + +Enable authentication with Net::SMTP_auth (sold separately). +For example, try using --auth PLAIN or --auth CRAM-MD5. + +=item --username <username> + +=item --password <password> + +Username and password to use when connecting to SMTP server. +Also known as: -U <username> -P <password> + +=item --body <message> + +Use this option to specify the body of the email message. If you need newlines in your message, +you might need to use the --stdin option instead. + +=item --header <header> + +Use this option to set an arbitrary header in the message. You can use it multiple times. + +=item --stdin + +Grab the body of the email message from stdin. + +=item --mailto recipient@your.net + +You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed): + +$ check_smtp_send -H mail.server.net --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net + +SMTP SEND OK - 1 seconds + +=item --mailfrom sender@your.net + +Use this option to set the "from" address in the email. + +=item --template + +=item --notemplate + +Enable (or disable) processing of message body and headers. Requires Text::Template. + +Use this option to apply special processing to your message body and headers that allows you to use the +results of arbitrary computations in the text. For example, you can use this feature to send a message +containing the hostname of the machine that sent the message without customizing the plugin configuration +on each machine. + +When you enable the --template option, the message body and headers are parsed by +Text::Template. Even a message body provided using the --stdin option will be parsed. +See the Text::Template manual for more information, but in general any expression +written in Perl will work. + +There is one convenience function provided to you, trim, which will remove leading and trailing whitespace +from its parameter. Here's an example: + + check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net + --template --body 'hello, this message is from {use Sys::Hostname; hostname}' + --header 'Subject: test message from {trim(`whoami`)}' + + +=item --expect-response <code> + +Use this option to specify which SMTP response code should be expected from the server +after the SMTP dialog is complete. The default is 250 (message accepted). + +Also known as: -E <code> + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. + +One --verbose will show extra information for OK, WARNING, and CRITICAL status. + +Use one --verbose together with --version to see the default warning and critical timeout values. + +Three --verbose (or -vvv) will show debug information, unless you're using --tls because Net::SMTP::TLS +does not have a Debug feature. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Send a message with custom headers + +$ check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--body 'Homeruns 5' --header 'Subject: Hello, world!' --header 'X-Your-Header: Yes' + +SMTP SEND OK - 1 seconds + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 CHANGES + + Wed Oct 29 14:05:00 PST 2005 + + version 0.1 + + Wed Nov 9 15:01:48 PST 2005 + + now using an inline PluginReport package to generate the report + + added stdin option + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton <geoff.crompton@strategicdata.com.au>) + + added bailing if the $smtp->to() call fails + + added support for mailto recipients separated by commas + + version 0.2.1 + + Tue Apr 24 21:17:53 PDT 2007 + + moved POD text to separate file in order to accomodate the new embedded-perl Nagios feature + + version 0.2.3 + + Fri Apr 27 20:26:42 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + version 0.3 + + Sun Oct 21 10:34:14 PDT 2007 + + added support for TLS and authentication via the Net::SMTP::TLS module. see --tls option. + + version 0.4 + + Sun Oct 21 13:54:26 PDT 2007 + + added support for SSL via the Net::SMTP::SSL module. see --ssl option. + + port is no longer a required option. defaults to 25 for regular smtp, 465 for ssl, and 587 for tls. + + added port info to the "could not connect" error message + + version 0.4.1 + + Tue Dec 4 07:42:32 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.2 + + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.3 + + Mon May 26 09:12:14 PDT 2008 + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.4.4 + + Wed Jul 2 07:12:35 PDT 2008 + + added --expect-response option submitted by Christian Kauhaus <kc@gocept.com> + + added support for authentication via Net::SMTP_auth. see --auth option. + + version 0.4.5 + + Sun Oct 5 15:18:23 PDT 2008 + + added error handling for smtp server disconnects ungracefully during QUIT (gmail.com does) + + version 0.4.6 + + Thu Oct 1 12:09:35 PDT 2009 + + added --template option to allow arbitrary substitutions for body and headers, and provided one convenience function for trimming strings + + added performance data for use with PNP4Nagios! + + version 0.5.0 + + Thu Oct 8 11:17:04 PDT 2009 + + added more detailed error messages when using --verbose + + version 0.5.1 + + Tue Feb 9 12:14:49 PST 2010 + + added support for combining --auth with --tls using a subclass of Net::SMTP::TLS submitted by Brad Guillory; please note that to use the "PLAIN" authentication type you need to patch your Net::SMTP:TLS because it has a bug in sub auth_PLAIN (sprintf %S instead of %s) + + version 0.5.2 + + Mon Jan 3 10:39:42 PST 2011 + + added default Date and Message-ID headers; Date header uses POSIX strftime and Message-ID header uses hostname command to get localhost name + + version 0.7.0 + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1 + + Wed Jul 6 19:18:26 AST 2011 + + the --hostname is now optional; if not provided the plugin will lookup the MX record for the --mailto address (requires Net::DNS) + + version 0.7.2 + + Tue Dec 13 09:24:04 PST 2011 + + separated authentication errors from connection errors + + version 0.7.3 + +=head1 AUTHOR + +Jonathan Buhacoff <jonathan@buhacoff.net> + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html new file mode 100644 index 0000000..cff7a09 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html @@ -0,0 +1,178 @@ +<?xml version="1.0" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file</title> +<link rel="stylesheet" href="plainwhite.css" type="text/css" /> +<meta http-equiv="content-type" content="text/html; charset=utf-8" /> +<link rev="made" href="mailto:jonathan@greek.local" /> +</head> + +<body> + + +<!-- INDEX BEGIN --> +<div name="index"> +<p><a name="__index__"></a></p> +<!-- + +<ul> + + <li><a href="#name">NAME</a></li> + <li><a href="#synopsis">SYNOPSIS</a></li> + <li><a href="#dependencies">DEPENDENCIES</a></li> + <li><a href="#options">OPTIONS</a></li> + <li><a href="#examples">EXAMPLES</a></li> + <ul> + + <li><a href="#print_the_server_s_ssl_certificate_chain">Print the server's SSL certificate chain</a></li> + </ul> + + <li><a href="#see_also">SEE ALSO</a></li> + <li><a href="#changes">CHANGES</a></li> + <li><a href="#author">AUTHOR</a></li> + <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li> +</ul> + +--> + + +</div> +<!-- INDEX END --> + +<p> +</p> +<hr /> +<h1><a name="name">NAME</a></h1> +<p>imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file</p> +<p> +</p> +<hr /> +<h1><a name="synopsis">SYNOPSIS</a></h1> +<pre> + imap_ssl_cert -H imap.server.com > server_ca_file.pem + imap_ssl_cert -? + imap_ssl_cert --help</pre> +<p> +</p> +<hr /> +<h1><a name="dependencies">DEPENDENCIES</a></h1> +<p>This utility requires the following perl modules to be installed:</p> +<p>Getopt::Long +Mail::IMAPClient +IO::Socket::SSL +Net::SSLeay</p> +<p> +</p> +<hr /> +<h1><a name="options">OPTIONS</a></h1> +<dl> +<dt><strong><a name="timeout_seconds" class="item">--timeout <seconds></a></strong></dt> + +<dd> +<p>Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds></p> +</dd> +<dt><strong><a name="hostname_server" class="item">--hostname <server></a></strong></dt> + +<dd> +<p>Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server></p> +</dd> +<dt><strong><a name="port_number" class="item">--port <number></a></strong></dt> + +<dd> +<p>Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number></p> +</dd> +<dt><strong><a name="verbose" class="item">--verbose</a></strong></dt> + +<dd> +<p>Display additional information. Useful for troubleshooting.</p> +<p>Also known as: -v</p> +</dd> +<dt><strong><a name="version" class="item">--version</a></strong></dt> + +<dd> +<p>Display plugin version and exit. +Also known as: -V</p> +</dd> +<dt><strong><a name="help" class="item">--help</a></strong></dt> + +<dd> +<p>Display this documentation and exit. +Also known as: -h</p> +</dd> +<dt><strong><a name="usage" class="item">--usage</a></strong></dt> + +<dd> +<p>Display a short usage instruction and exit.</p> +</dd> +</dl> +<p> +</p> +<hr /> +<h1><a name="examples">EXAMPLES</a></h1> +<p> +</p> +<h2><a name="print_the_server_s_ssl_certificate_chain">Print the server's SSL certificate chain</a></h2> +<pre> + $ perl imap_ssl_cert.pl -H imap.server.com > ca_file.pem + $ cat ca_file.pem</pre> +<pre> + -----BEGIN CERTIFICATE----- + MIID1zCCAr+gAwIBAgIQPr3bVk0SkuXygjxgA7EVGDANBgkqhkiG9w0BAQUFADA8 + [...snip...] + 0FF4warjskrfqaVtWeIV58LJheaM4cPJkc2M + -----END CERTIFICATE-----</pre> +<pre> + $ openssl x509 -in ca_file.pem -text</pre> +<p> +</p> +<hr /> +<h1><a name="see_also">SEE ALSO</a></h1> +<p><a href="http://en.wikipedia.org/wiki/X.509">http://en.wikipedia.org/wiki/X.509</a> +<a href="http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail">http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail</a> +<a href="http://tools.ietf.org/html/rfc1422">http://tools.ietf.org/html/rfc1422</a> +<a href="http://search.cpan.org/~mikem/Net-SSLeay-1.42/lib/Net/SSLeay.pm">http://search.cpan.org/~mikem/Net-SSLeay-1.42/lib/Net/SSLeay.pm</a> +<a href="http://search.cpan.org/~plobbes/Mail-IMAPClient-3.29/lib/Mail/IMAPClient.pod">http://search.cpan.org/~plobbes/Mail-IMAPClient-3.29/lib/Mail/IMAPClient.pod</a></p> +<p> +</p> +<hr /> +<h1><a name="changes">CHANGES</a></h1> +<pre> + Fri Nov 11 03:38:13 AST 2011 + + version 0.1</pre> +<p> +</p> +<hr /> +<h1><a name="author">AUTHOR</a></h1> +<p>Jonathan Buhacoff <<a href="mailto:jonathan@buhacoff.net">jonathan@buhacoff.net</a>></p> +<p> +</p> +<hr /> +<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1> +<pre> + Copyright (C) 2011 Jonathan Buhacoff</pre> +<pre> + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version.</pre> +<pre> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details.</pre> +<pre> + You should have received a copy of the GNU General Public License + along with this program. If not, see <<a href="http://www.gnu.org/licenses/>">http://www.gnu.org/licenses/></a>;.</pre> +<pre> + <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></pre> + +</body> + +</html> diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod new file mode 100644 index 0000000..dc42d5c --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod @@ -0,0 +1,122 @@ + + + +=pod + +=head1 NAME + +imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file + +=head1 SYNOPSIS + + imap_ssl_cert -H imap.server.com > server_ca_file.pem + imap_ssl_cert -? + imap_ssl_cert --help + +=head1 DEPENDENCIES + +This utility requires the following perl modules to be installed: + +Getopt::Long +Mail::IMAPClient +IO::Socket::SSL +Net::SSLeay + +=head1 OPTIONS + +=over + +=item --timeout <seconds> + +Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds> + +=item --hostname <server> + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server> + +=item --port <number> + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number> + +=item --verbose + +Display additional information. Useful for troubleshooting. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Print the server's SSL certificate chain + + $ perl imap_ssl_cert.pl -H imap.server.com > ca_file.pem + $ cat ca_file.pem + + -----BEGIN CERTIFICATE----- + MIID1zCCAr+gAwIBAgIQPr3bVk0SkuXygjxgA7EVGDANBgkqhkiG9w0BAQUFADA8 + [...snip...] + 0FF4warjskrfqaVtWeIV58LJheaM4cPJkc2M + -----END CERTIFICATE----- + + $ openssl x509 -in ca_file.pem -text + + +=head1 SEE ALSO + +http://en.wikipedia.org/wiki/X.509 +http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail +http://tools.ietf.org/html/rfc1422 +http://search.cpan.org/~mikem/Net-SSLeay-1.42/lib/Net/SSLeay.pm +http://search.cpan.org/~plobbes/Mail-IMAPClient-3.29/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Fri Nov 11 03:38:13 AST 2011 + + version 0.1 + +=head1 AUTHOR + +Jonathan Buhacoff <jonathan@buhacoff.net> + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + + http://www.gnu.org/licenses/gpl.txt + +=cut + |