.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::Gmail::IMAP::Label 3pm"
.TH Net::Gmail::IMAP::Label 3pm "2018-04-15" "perl v5.26.1" "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"
Net::Gmail::IMAP::Label \- IMAP proxy for Google's Gmail that retrieves message labels
.SH "VERSION"
.IX Header "VERSION"
version 0.008
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    gmail\-imap\-label [OPTION]...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a proxy that sits between an \s-1IMAP\s0 client and Gmail's \s-1IMAPS\s0
server and adds GMail labels to the X\-Label header. This proxy uses the
Gmail \s-1IMAP\s0 extensions <https://developers.google.com/gmail/imap/imap-extensions#access_to_gmail_labels_x-gm-labels>.
.PP
To use this proxy, your e\-mail client will need to connect to the proxy using
the \s-1IMAP\s0 protocol (without \s-1SSL\s0).
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The simplest way of starting is to run the proxy on the default port of 10143:
.PP
.Vb 1
\&    gmail\-imap\-label
.Ve
.PP
An alternative port can be specified using the \fB\-\-port\fR option
.PP
.Vb 1
\&    gmail\-imap\-label \-\-port 993
.Ve
.PP
The proxy has been tested with both mutt (v1.5.21) and offlineimap (v6.3.4).
Example configuration files for these are available in the \f(CW\*(C`doc\*(C'\fR directory.
.PP
With mutt, you may have to clear the header cache every so often so that any
updated labels are available inside the \s-1UI.\s0
.SH "INSTALLATION"
.IX Header "INSTALLATION"
You can either install the package from \s-1CPAN\s0 <http://p3rl.org/Net::Gmail::IMAP::Label>
or from your package manager.
.PP
To install the Debian package <https://packages.debian.org/libnet-gmail-imap-label-perl>,
run
.PP
.Vb 1
\&    apt\-get install libnet\-gmail\-imap\-label\-perl
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See gmail-imap-label for a complete listing of options.
.SH "BUGS"
.IX Header "BUGS"
Report bugs and submit patches to the repository on Github <https://github.com/zmughal/gmail-imap-label>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2011 Zakariyya Mughal.
.PP
This program is free software; you can redistribute it and/or
modify it under the terms of either:
.IP "\(bu" 4
the \s-1ISC\s0 license, or
.IP "\(bu" 4
the Artistic License version 2.0.
.SH "ACKNOWLEDGMENTS"
.IX Header "ACKNOWLEDGMENTS"
Thanks to Paul DeCarlo <http://pjdecarlo.com/> for pointing out the
Gmail \s-1IMAP\s0 extensions that made this a whole lot easier than what I had
originally planned on doing.
.SH "AUTHOR"
.IX Header "AUTHOR"
Zakariyya Mughal <zmughal@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2011 by Zakariyya Mughal <zmughal@cpan.org>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve