summaryrefslogtreecommitdiff
path: root/src/mailman/commands/cli_aliases.py
blob: dcb494ebbc35be6d751ee52bac94fd8c8550a5ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Copyright (C) 2009-2011 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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.
#
# GNU Mailman 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
# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.

"""Generate Mailman alias files for your MTA."""

from __future__ import absolute_import, unicode_literals

__metaclass__ = type
__all__ = [
    'Aliases',
    ]


import sys

from zope.interface import implements

from mailman.config import config
from mailman.core.i18n import _
from mailman.interfaces.command import ICLISubCommand
from mailman.utilities.modules import call_name



class Aliases:
    """Regenerate the aliases appropriate for your MTA."""

    implements(ICLISubCommand)

    name = 'aliases'

    def add(self, parser, command_parser):
        """See `ICLISubCommand`."""
        command_parser.add_argument(
            '-o', '--output',
            action='store', help=_("""\
            File to send the output to.  If not given, a file in $VAR/data is
            used.  The argument can be '-' to use standard output.."""))

    def process(self, args):
        """See `ICLISubCommand`."""
        output = None
        if args.output == '-':
            output = sys.stdout
        elif args.output is None:
            output = None
        else:
            output = args.output
        # Call the MTA-specific regeneration method.
        call_name(config.mta.incoming).regenerate(output)