com.anrisoftware.sscontrol.security.spamassassin.SpamassassinService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sscontrol-security-spamassassin Show documentation
SpamAssassin perl-based spam filter using text analysis. - http://www.spamassassin.org/
The newest version!
/*
 * Copyright 2014-2015 Erwin Müller 
 *
 * This file is part of sscontrol-security-spamassassin.
 *
 * sscontrol-security-spamassassin is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * sscontrol-security-spamassassin 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 Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with sscontrol-security-spamassassin. If not, see .
 */
package com.anrisoftware.sscontrol.security.spamassassin;

import java.util.List;
import java.util.Map;

import com.anrisoftware.sscontrol.security.service.SecService;

/**
 * Spamassassin service.
 *
 * @see http://www.spamassassin.org/
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface SpamassassinService extends SecService {

    /**
     * Returns the debug logging for the specified key.
     * 
     * The example returns the following map for the key "level":
     *
     * 
     * {["log": 5]}
     * 
     *
     *      * service "spamassassin", {
     *     debug "log", level: 1
     * }
     * 
     *
     * @return the {@link Map} of the debug levels or {@code null}.
     */
    Map debugLogging(String key);

    /**
     * Returns clear headers type.
     * 
     *
     * 
     * service "spamassassin", {
     *     clear ClearType.headers
     * }
     * 
     *
     * @return the {@code ClearType} type or {@code null}.
     */
    ClearType getClearHeaders();

    /**
     * Returns the header to rewrite on spam detection.
     * 
     * The example returns the following map:
     *
     * 
     * {["subject": "*SPAM*"]}
     * 
     *
     *      * service "spamassassin", {
     *     rewrite RewriteType.subject, header: "*SPAM*"
     * }
     * 
     *
     * @return the {@link Map} of the headers to rewrite or {@code null}.
     */
    Map getRewriteHeaders();

    /**
     * Returns the header to add.
     *
     *      * service "spamassassin", {
     *     add MessageType.spam, name: "Flag", header: "_YESNOCAPS_"
     *     add MessageType.all, name: "Level", header: "_STARS(*)_"
     *     add MessageType.all, name: "Status", header: "_YESNO_, score=_SCORE_"
     * }
     * 
     *
     * @return the {@link List} of the headers to add or {@code null}.
     */
    List getAddHeaders();

    /**
     * Returns the trusted networks.
     * 
     *
     * 
     * service "spamassassin", {
     *     trusted networks: "192.168.0.40"
     * }
     * 
     *
     * @return the {@link List} of the trusted networks or {@code null}.
     */
    List getTrustedNetworks();

    /**
     * Returns the spam detection score.
     * 
     *
     * 
     * service "spamassassin", {
     *     spam score: 5.0
     * }
     * 
     *
     * @return the detection {@link Double} score or {@code null}.
     */
    Double getSpamScore();
}