Skip to content

Latest commit

 

History

History
93 lines (52 loc) · 2.22 KB

README.pod

File metadata and controls

93 lines (52 loc) · 2.22 KB
Raw

NAME

Net::Gmail::IMAP::Label - IMAP proxy for Google's Gmail that retrieves message labels

VERSION

version 0.008

SYNOPSIS

gmail-imap-label [OPTION]...

DESCRIPTION

This module provides a proxy that sits between an IMAP client and Gmail's IMAPS server and adds GMail labels to the X-Label header. This proxy uses the Gmail IMAP extensions.

To use this proxy, your e-mail client will need to connect to the proxy using the IMAP protocol (without SSL).

EXAMPLES

The simplest way of starting is to run the proxy on the default port of 10143:

gmail-imap-label

An alternative port can be specified using the --port option

gmail-imap-label --port 993

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 doc directory.

With mutt, you may have to clear the header cache every so often so that any updated labels are available inside the UI.

INSTALLATION

You can either install the package from CPAN or from your package manager.

To install the Debian package, run

apt-get install libnet-gmail-imap-label-perl

SEE ALSO

See gmail-imap-label for a complete listing of options.

BUGS

Report bugs and submit patches to the repository on Github.

COPYRIGHT

Copyright 2011 Zakariyya Mughal.

This program is free software; you can redistribute it and/or modify it under the terms of either:

  • the ISC license, or

  • the Artistic License version 2.0.

ACKNOWLEDGMENTS

Thanks to Paul DeCarlo for pointing out the Gmail IMAP extensions that made this a whole lot easier than what I had originally planned on doing.

AUTHOR

Zakariyya Mughal <[email protected]>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2011 by Zakariyya Mughal <[email protected]>.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)