1 Attachment(s)
Conky SSL Email Python Script
ArchLinux : Package support is present in the AUR. All my packages can be seen here: http://aur.archlinux.org/packages.php?SeB=m&K=kaivalagi
Ubuntu/Debian : All the script packages have now been copied into the Conky Companions PPA. Any package updates will be provided by the team through this new ppa. The ppa can be found here: https://launchpad.net/~conky-companions/+archive/ppa. To use this ppa first delete the old ppa files using this:
Code:
sudo rm /etc/apt/sources.list.d/m-buck* && sudo rm /etc/apt/sources.list.d/conkyhardcore*
Then follow the modified first post instructions for the scripts
Intro
This is a simple script to return the count of emails in an inbox, it supports SSL (secure) and standard connections to IMAP and POP3 services on the standard port numbers.
Currently a mail message count of unread emails is returned for IMAP accounts, for POP3 accounts I still need to figure out how I will provide this, currently the total email count is returned. POP3 is a very old and limited protocol, hence the issues.
There is a README with the install, I suggest you give it atleast a quick once over! It can be found in the installation folder, normally following the path of /usr/share/conky<scriptname>/
Basic Install
Method 1: Using apt
1) Add the repository to your OS install:
Code:
sudo add-apt-repository ppa:conky-companions/ppa
* Note if you are running 9.10 or below then refer to the PPA link at the end of this post for help on installing from the ppa, good guidance can be found on the launchpad site
2) Now that is done simply run the following to update your repo cache and install the script:
Code:
sudo apt-get update && sudo apt-get install conkyemail
Method 2: Using deb file
Run the .deb file available at the Conky Companions PPA site here: https://launchpad.net/~conky-compani.../ppa/+packages
Warning, this will not ensure you are kept up-to-date. Only method 1 will do that ;)
Method 3: Using tar.gz file
Extract all the contents of the tar.gz file to an appropriate folder, and edit the conkyEmail script to point to the correct location where conkyEmail.py is. The tar.gz file is available at the Conky Companions PPA site here: https://launchpad.net/~conky-compani.../ppa/+packages
Unless you are using a non-Debian based OS I don't suggest this. Users of Debian/Ubuntu flavour OS's should ideally use method 1.
Again will will not receive updates using this method. ONLY method 1 can do this for you ;) ;)
All further details on setup are orientated around the deb package based install, so may differ from what you choose your setup to be, if done using the tarball.
Usage Help
You can get the current help options at any time by running (change the path as necessary):
or
Code:
Usage: conkyEmail [options]
Options:
-h, --help show this help message and exit
-m SERVERTYPE, --servertype=SERVERTYPE
servertype to check [default: POP] The server type
options are POP or IMAP
-s SERVERNAME, --servername=SERVERNAME
server name to access [default: pop.mail.yahoo.co.uk]
The server name should be either a domain name or ip
address
-o NUMBER, --port=NUMBER
Define an alternative port number to use other than
the default for the protocol/ssl
-f FOLDER, --folder=FOLDER
[default: Inbox] IMAP folder to check, not applicable
for POP mail checks
-e, --ssl Use an SSL based connection.
-u USERNAME, --username=USERNAME
username to login with
-p PASSWORD, --password=PASSWORD
Password to login with, if not set the username is
used to fetch a 'conky' password from the keyring
-t FILE, --template=FILE
define a template file to generate output in one call.
A displayable item in the file is in the form
[--servertype=IMAP --ssl --servername=imap.gmail.com
--folder=Inbox --username=joebloggs
--password=letmein, --connectiontimeout=10]. Note that
the short forms of the options are not currently
supported! None of these options are applicable at
command line when used in templates.
-i NUMBER, --mailinfo=NUMBER
[default: 0] The number of newest emails to output
'from' and 'subject' information for. Not applicable
at command line when using templates.
-w NUMBER, --maxwidth=NUMBER
[default: 80] Define the number of characters to
output per line
-l NUMBER, --linelimit=NUMBER
[default: 0] If above zero this limits the number of
lines output for mail info
-q CHAR, --quote=CHAR
[default: "] The character to use for quotations
around the subject line
-c NUMBER, --connectiontimeout=NUMBER
[default: 10] Define the number of seconds before a
connection timeout can occur. Not applicable at
command line when using templates.
-v, --verbose request verbose output, not a good idea when running
through conky!
-V, --version Displays the version of the script.
--errorlogfile=FILE If a filepath is set, the script appends errors to the
filepath.
--infologfile=FILE If a filepath is set, the script appends info to the
filepath.
The important thing to note now is that the script is called using this in Conky:
Code:
{execi 1800 conkyEmail ...options...}
Rather than something like this as before:
Code:
{execi 1800 python /path/to/file/conkyEmail.py ...options...}
Development History
Development history going forwards can be seen here https://code.launchpad.net/~conky-companions/+junk/conkyemail
All packages available from me can be found here: https://launchpad.net/~conky-companions/+archive/ppa
Re: Conky SSL Email Python Script
Hi kaivalagi,
I never realized there was a problem with the POP3 stuff as I use:
Code:
${color1}Hay ${color4}${execi 60 python /home/my_name/Conky/scripts/mail/conkyEmail.py --servertype=POP --servername=pop3.my_isp.com --username=my_name --password=my_password} ${color1}E-mail$color
and my setup "deletes mail" from the server when I download it.
That works for me.
CHIMO!
Bruce
EDIT: Hey, I just realized, I have a gmail account as well and it's set to a POP3 account, I can use this there too. (I only want a number anyway).
Re: Conky SSL Email Python Script
Quote:
Originally Posted by
Bruce M.
Hi kaivalagi,
I never realized there was a problem with the POP3 stuff as I use:
Code:
${color1}Hay ${color4}${execi 60 python /home/my_name/Conky/scripts/mail/conkyEmail.py --servertype=POP --servername=pop3.my_isp.com --username=my_name --password=my_password} ${color1}E-mail$color
and my setup "deletes mail" from the server when I download it.
That works for me.
CHIMO!
Bruce
EDIT: Hey, I just realized, I have a gmail account as well and it's set to a POP3 account, I can use this there too. (I only want a number anyway).
POP3 doesn't have an unread mail count feature, for that I'd need to keep track of all the emails to understand what is read and what is not, not easy outside of the main mail client used...POP3 is ancient really, outdated and should be disregarded as a protocol.
I recommend switching your gmail account to IMAP based rather then POP...it is more secure generally, and with SSL as well is the bee's knees :)
You can do this via the google mail settings online, and then it's a simple case of changes your account setting in thunderbird/evolution etc...
Your call though, just a recommendation...
Re: Conky SSL Email Python Script
Quote:
Originally Posted by
kaivalagi
I recommend switching your gmail account to IMAP based rather then POP...it is more secure generally, and with SSL as well is the bee's knees :)
You can do this via the google mail settings online, and then it's a simple case of changes your account setting in thunderbird/evolution etc...
Your call though, just a recommendation...
Thanks K, I'll definately check that out. Don't have an option with my ISP though, I think they only provide POP3. However I will check that out as well.
Regardless, I never leave mails on my server, they are deleted when I download them.
CHIMO!
Bruce
Re: Conky SSL Email Python Script
Hey, I've been trying to get this to work with my uni and gmail but it always says there are 0 new. Both using IMAP and google is configured right.
Re: Conky SSL Email Python Script
Same thing here:( I use ivleph's script and it works great.
Re: Conky SSL Email Python Script
Quote:
Originally Posted by
PurposeOfReason
Hey, I've been trying to get this to work with my uni and gmail but it always says there are 0 new. Both using IMAP and google is configured right.
I'll take a look at some point soon, it used to work...? And nothing is changed ??
Re: Conky SSL Email Python Script
UPDATE
Fixed the issue with IMAP counts not working properly, grab the tarball from this post.
I switched to using the "UNSEEN" IMAP search filter instead of "RECENT", recent no longer works as desired?
OPTIONAL
I have updated the first post, as conkyEmail is now available from my personal package archive at launchpad. If you install it this way you'll get any updates with minimal fuss...
Just bear in mind you'll need to change the conky calls from:
Code:
${execi 1800 python /path/to/script conkyEmail.py ...options...}
to:
Code:
${execi 1800 conkyEmail ...options...}
More extensive details to come shortly...
Re: Conky SSL Email Python Script
Thank you, it works great now!
Re: Conky SSL Email Python Script
Quote:
Originally Posted by
PurposeOfReason
Thank you, it works great now!
Did you use the new apt based install?
It's working well for conkyForecast...:)