Browse Source

ADD mail_check_mailbox_size

Send an email with a summary of remote IMAP mailbox folders, with their total space used.
pull/342/head
eLBati 6 years ago
committed by Leonardo Pistone
parent
commit
5d9378d900
  1. 90
      mail_check_mailbox_size/README.rst
  2. 3
      mail_check_mailbox_size/__init__.py
  3. 23
      mail_check_mailbox_size/__manifest__.py
  4. 17
      mail_check_mailbox_size/data/cron_data.xml
  5. 3
      mail_check_mailbox_size/models/__init__.py
  6. 137
      mail_check_mailbox_size/models/fetchmail.py
  7. 5
      mail_check_mailbox_size/readme/CONFIGURE.rst
  8. 1
      mail_check_mailbox_size/readme/CONTRIBUTORS.rst
  9. 3
      mail_check_mailbox_size/readme/DESCRIPTION.rst
  10. 428
      mail_check_mailbox_size/static/description/index.html
  11. 18
      mail_check_mailbox_size/views/fetchmail_view.xml

90
mail_check_mailbox_size/README.rst

@ -0,0 +1,90 @@
==================
Check mailbox size
==================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
:target: https://github.com/OCA/social/tree/10.0/mail_check_mailbox_size
:alt: OCA/social
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/social-10-0/social-10-0-mail_check_mailbox_size
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/205/10.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
Send an email with a summary of remote IMAP mailbox folders, with their total space used.
**Table of contents**
.. contents::
:local:
Configuration
=============
To enable the mailbox check, you have to configure an Incoming Mail Server setting
Server Type = IMAP Server
Select 'Check Size' and fill 'Contacts to notify' with the list of partners to be notified with the summary of mailbox folders size.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_check_mailbox_size%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* Agile Business Group
Contributors
~~~~~~~~~~~~
* Lorenzo Battistini <https://github.com/eLBati>
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
.. |maintainer-eLBati| image:: https://github.com/eLBati.png?size=40px
:target: https://github.com/eLBati
:alt: eLBati
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-eLBati|
This module is part of the `OCA/social <https://github.com/OCA/social/tree/10.0/mail_check_mailbox_size>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

3
mail_check_mailbox_size/__init__.py

@ -0,0 +1,3 @@
# -*- coding: utf-8 -*-
from . import models

23
mail_check_mailbox_size/__manifest__.py

@ -0,0 +1,23 @@
# -*- coding: utf-8 -*-
# Copyright 2018 Lorenzo Battistini
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
{
"name": "Check mailbox size",
"summary": "Send an email summarizing the current space used by a mailbox",
"version": "10.0.1.0.0",
"development_status": "Beta",
"website": "https://github.com/OCA/social",
"author": "Agile Business Group, Odoo Community Association (OCA)",
"maintainers": ["eLBati"],
"license": "LGPL-3",
"application": False,
"installable": True,
"depends": [
"fetchmail",
],
"data": [
"views/fetchmail_view.xml",
"data/cron_data.xml"
],
}

17
mail_check_mailbox_size/data/cron_data.xml

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<data noupdate="1">
<record id="ir_cron_check_mailbox_size" model="ir.cron">
<field name="name">Check mailbox size</field>
<field name="interval_number">1</field>
<field name="interval_type">days</field>
<field name="numbercall">-1</field>
<field name="doall" eval="False"/>
<field name="model">fetchmail.server</field>
<field name="function">_check_mailboxes_size_cron</field>
<field name="args">()</field>
<!-- Active flag is set on fetchmail_server.create/write -->
<field name="active" eval="False"/>
</record>
</data>
</odoo>

3
mail_check_mailbox_size/models/__init__.py

@ -0,0 +1,3 @@
# -*- coding: utf-8 -*-
from . import fetchmail

137
mail_check_mailbox_size/models/fetchmail.py

@ -0,0 +1,137 @@
# -*- coding: utf-8 -*-
import logging
from odoo import models, fields, api, _
_logger = logging.getLogger(__name__)
class Fetchmail(models.Model):
_inherit = 'fetchmail.server'
check_mailbox_size = fields.Boolean("Check Size")
mailbox_size_partner_ids = fields.Many2many(
"res.partner", string="Contacts to notify",
domain=[('email', '!=', False)]
)
@api.model
def _check_mailboxes_size_cron(self):
""" Method called by cron to fetch mails from servers """
return self.search([
('state', '=', 'done'),
('type', '=', 'imap'),
('check_mailbox_size', '=', True)
])._check_mailbox_size()
@api.multi
def _check_mailbox_size(self):
for server in self:
result_msg = ''
imap_server = None
try:
if not server.mailbox_size_partner_ids:
continue
result_msg += _('<h3>Server %s</h3>') % server.name
_logger.info(
"Starting to check mailbox size for server %s"
% server.name)
imap_server = server.connect()
# The list of all folders
result, list = imap_server.list()
if result != "OK":
raise Exception(_("Server responded %s") % result)
result_msg += _(
"<table>"
"<thead>"
"<tr>"
"<th style=\"text-align:left\">Folder</th>"
"<th style=\"text-align:right\"># Msg</th>"
"<th style=\"text-align:right\">Size</th>"
"</tr>"
"</thead>"
"<tbody>"
)
number_of_messages_all = 0
size_all = 0
for item in list:
x = item.split()
mailbox = x[-1]
# Select the desired folder
result, number_of_messages = imap_server.select(
mailbox, readonly=1)
if result != 'OK':
_logger.info(
"Server %s responded %s for folder %s"
% (server.name, number_of_messages, mailbox))
continue
number_of_messages_all += int(number_of_messages[0])
size_folder = 0
# Go through all the messages in the selected folder
typ, msg = imap_server.search(None, 'ALL')
# Find the first and last messages
m = [int(msg_part) for msg_part in msg[0].split()]
m.sort()
if m:
message_set = "%d:%d" % (m[0], m[-1])
result, sizes_response = imap_server.fetch(
message_set, "(UID RFC822.SIZE)")
for i in range(m[-1]):
tmp = sizes_response[i].split()
size_folder += int(tmp[-1].replace(')', ''))
else:
size_folder = 0
result_msg += (
"<tr>"
"<td style=\"text-align:left\">%s</td>"
"<td style=\"text-align:right\">%i</td>"
"<td style=\"text-align:right\">%s</td>"
"</tr>"
) % (mailbox, int(number_of_messages[0]), size_folder)
size_all += size_folder
result_msg += _(
"</tbody>"
"<tfoot>"
"<tr>"
"<td style=\"text-align:left;font-weight:bold\">Sum</td>"
"<td style=\"text-align:right;font-weight:bold\">%i</td>"
"<td style=\"text-align:right;font-weight:bold\">"
"%10.3fMB</td>"
"</tr>"
"</tfoot>"
"</table>"
) % (number_of_messages_all, size_all / 1e6)
except Exception as e:
result_msg = _(
"An error occured while checking mailbox %s:<br/>%s"
) % (server.name, str(e))
finally:
if imap_server:
imap_server.logout()
if result_msg:
self.env['mail.mail'].create({
'subject': _("Mailbox size for server %s") % server.name,
'body_html': result_msg,
'recipient_ids': [
(6, 0, server.mailbox_size_partner_ids.ids)]
})
@api.model
def _update_cron(self):
res = super(Fetchmail, self)._update_cron()
if self.env.context.get('fetchmail_cron_running'):
return res
try:
cron = self.env.ref(
'mail_check_mailbox_size.ir_cron_check_mailbox_size')
cron.toggle(model=self._name, domain=[
('state', '=', 'done'), ('type', '=', 'imap'),
('check_mailbox_size', '=', True),
])
except ValueError:
# Nevermind if ir_cron_check_mailbox_size cannot be found
pass
return res

5
mail_check_mailbox_size/readme/CONFIGURE.rst

@ -0,0 +1,5 @@
To enable the mailbox check, you have to configure an Incoming Mail Server setting
Server Type = IMAP Server
Select 'Check Size' and fill 'Contacts to notify' with the list of partners to be notified with the summary of mailbox folders size.

1
mail_check_mailbox_size/readme/CONTRIBUTORS.rst

@ -0,0 +1 @@
* Lorenzo Battistini <https://github.com/eLBati>

3
mail_check_mailbox_size/readme/DESCRIPTION.rst

@ -0,0 +1,3 @@
Send an email with a summary of remote IMAP mailbox folders, with their total space used.
This is especially relevant in cases where invoices are received by email to make sure they can get through.

428
mail_check_mailbox_size/static/description/index.html

@ -0,0 +1,428 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>Check mailbox size</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="check-mailbox-size">
<h1 class="title">Check mailbox size</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/social/tree/10.0/mail_check_mailbox_size"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-10-0/social-10-0-mail_check_mailbox_size"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Send an email with a summary of remote IMAP mailbox folders, with their total space used.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<p>To enable the mailbox check, you have to configure an Incoming Mail Server setting</p>
<p>Server Type = IMAP Server</p>
<p>Select ‘Check Size’ and fill ‘Contacts to notify’ with the list of partners to be notified with the summary of mailbox folders size.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_check_mailbox_size%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<ul class="simple">
<li>Agile Business Group</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<ul class="simple">
<li>Lorenzo Battistini &lt;<a class="reference external" href="https://github.com/eLBati">https://github.com/eLBati</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/eLBati"><img alt="eLBati" src="https://github.com/eLBati.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/10.0/mail_check_mailbox_size">OCA/social</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</body>
</html>

18
mail_check_mailbox_size/views/fetchmail_view.xml

@ -0,0 +1,18 @@
<?xml version="1.0"?>
<odoo>
<record id="view_email_server_form_check_size" model="ir.ui.view">
<field name="name">view_email_server_form_check_size</field>
<field name="model">fetchmail.server</field>
<field name="inherit_id" ref="fetchmail.view_email_server_form"/>
<field name="arch" type="xml">
<xpath expr="//notebook/page[2]/group[1]" position="after">
<group string="Mailbox size checking" col="4" attrs="{'invisible': [('type', '!=', 'imap')]}">
<field name="check_mailbox_size"/>
<field name="mailbox_size_partner_ids" widget="many2many_tags"
options="{'no_create': True}"/>
</group>
</xpath>
</field>
</record>
</odoo>
Loading…
Cancel
Save