.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CHECK_IMAP_QUOTA 7" .TH CHECK_IMAP_QUOTA 7 "2020-04-11" "perl v5.30.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" check_imap_quota \- connects to an IMAP account and checks the quota .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& check_imap_quota \-vV \& check_imap_quota \-? \& check_imap_quota \-\-help .Ve .SH "OPTIONS" .IX Header "OPTIONS" .IP "\-\-warning " 4 .IX Item "--warning " Warn if it takes longer than to connect to the \s-1IMAP\s0 server. Default is 15 seconds. Also known as: \-w .IP "\-\-critical " 4 .IX Item "--critical " Return a critical status if it takes longer than to connect to the \s-1IMAP\s0 server. Default is 30 seconds. See also: \-\-capture\-critical Also known as: \-c .IP "\-\-timeout " 4 .IX Item "--timeout " Abort with critical status if it takes longer than to connect to the \s-1IMAP\s0 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 \s-1CRITICAL\s0 because it took longer than 30 seconds. Also known as: \-t .IP "\-\-hostname " 4 .IX Item "--hostname " Address or name of the \s-1IMAP\s0 server. Examples: mail.server.com, localhost, 192.168.1.100 Also known as: \-H .IP "\-\-port " 4 .IX Item "--port " Service port on the \s-1IMAP\s0 server. Default is 143. If you use \s-1SSL,\s0 default is 993. Also known as: \-p .IP "\-\-username " 4 .IX Item "--username " .PD 0 .IP "\-\-password " 4 .IX Item "--password " .PD Username and password to use when connecting to \s-1IMAP\s0 server. Also known as: \-U \-P .IP "\-\-mailbox " 4 .IX Item "--mailbox " Use this option to specify the mailbox to search for messages. Default is \s-1INBOX.\s0 Also known as: \-m .IP "\-\-ssl" 4 .IX Item "--ssl" .PD 0 .IP "\-\-nossl" 4 .IX Item "--nossl" .PD Enable \s-1SSL\s0 protocol. Requires IO::Socket::SSL. .Sp 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. .Sp Use the nossl option to turn off the ssl option. .IP "\-\-hires" 4 .IX Item "--hires" Use the Time::HiRes module to measure time, if available. .IP "\-\-verbose" 4 .IX Item "--verbose" Display additional information. Useful for troubleshooting. Use together with \-\-version to see the default warning and critical timeout values. .Sp 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. .Sp Also known as: \-v .IP "\-\-version" 4 .IX Item "--version" Display plugin version and exit. Also known as: \-V .IP "\-\-help" 4 .IX Item "--help" Display this documentation and exit. Does not work in the ePN version. Also known as: \-h .IP "\-\-usage" 4 .IX Item "--usage" Display a short usage instruction and exit. .SH "EXAMPLES" .IX Header "EXAMPLES" .SS "Report how many emails are in the mailbox" .IX Subsection "Report how many emails are in the mailbox" .Vb 2 \& $ check_imap_receive \-H mail.server.net \-\-username mailuser \-\-password mailpass \& \-s ALL \-\-nodelete \& \& IMAP RECEIVE OK \- 1 seconds, 7 found .Ve .SS "Report the email with the highest value" .IX Subsection "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): .PP .Vb 5 \& To: mailuser@server.net \& From: autoscript@server.net \& Subject: Results of Autoscript \& Date: Wed, 09 Nov 2005 08:30:40 \-0800 \& Message\-ID: \& \& Homeruns 5 .Ve .PP 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: .PP .Vb 2 \& $ check_imap_receive \-H mail.server.net \-\-username mailuser \-\-password mailpass \& \-s SUBJECT \-s "Results of Autoscript" \-\-capture\-max "Homeruns (\ed+)" \-\-nodelete\-captured \& \& IMAP RECEIVE OK \- 1 seconds, 3 found, 1 captured, 5 max, 2 deleted .Ve .SS "Troubleshoot your search parameters" .IX Subsection "Troubleshoot your search parameters" Add the \-\-nodelete and \-\-imap\-retries=1 parameters to your command line. .SH "EXIT CODES" .IX Header "EXIT CODES" Complies with the Nagios plug-in specification: 0 \s-1OK\s0 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 \*(L"warning\*(R" 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 \*(L"critical\*(R" 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 .SH "NAGIOS PLUGIN NOTES" .IX Header "NAGIOS PLUGIN NOTES" Nagios plugin reference: http://nagiosplug.sourceforge.net/developer\-guidelines.html .PP This plugin does \s-1NOT\s0 use Nagios \s-1DEFAULT_SOCKET_TIMEOUT\s0 (provided by utils.pm as \f(CW$TIMEOUT\fR) 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. .PP Other than that, it attempts to follow published guidelines for Nagios plugins. .SH "SEE ALSO" .IX Header "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 .SH "CHANGES" .IX Header "CHANGES" .Vb 2 \& 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 .Ve .SH "AUTHOR" .IX Header "AUTHOR" Jonathan Buhacoff .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" .Vb 1 \& 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/gpl.txt .Ve