* @author J0WI * @author Joas Schilling * @author Julius Härtl * @author Lukas Reschke * @author Morris Jobke * @author Roeland Jago Douma * @author scolebrook * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program 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, version 3, * along with this program. If not, see * */ // use OCP namespace for all classes that are considered public. // This means that they should be used by apps instead of the internal ownCloud classes namespace OCP; /** * public api to access default strings and urls for your templates * @since 6.0.0 */ class Defaults { /** * \OC_Defaults instance to retrieve the defaults * @since 6.0.0 */ private $defaults; /** * creates a \OC_Defaults instance which is used in all methods to retrieve the * actual defaults * @since 6.0.0 */ public function __construct(\OC_Defaults $defaults = null) { if ($defaults === null) { $defaults = \OC::$server->getThemingDefaults(); } $this->defaults = $defaults; } /** * get base URL for the organisation behind your ownCloud instance * @return string * @since 6.0.0 */ public function getBaseUrl(): string { return $this->defaults->getBaseUrl(); } /** * link to the desktop sync client * @return string * @since 6.0.0 */ public function getSyncClientUrl(): string { return $this->defaults->getSyncClientUrl(); } /** * link to the iOS client * @return string * @since 8.0.0 */ public function getiOSClientUrl(): string { return $this->defaults->getiOSClientUrl(); } /** * link to the Android client * @return string * @since 8.0.0 */ public function getAndroidClientUrl(): string { return $this->defaults->getAndroidClientUrl(); } /** * link to the Android client on F-Droid * @return string * @since 23.0.0 */ public function getFDroidClientUrl() { return $this->defaults->getFDroidClientUrl(); } /** * base URL to the documentation of your ownCloud instance * @return string * @since 6.0.0 */ public function getDocBaseUrl(): string { return $this->defaults->getDocBaseUrl(); } /** * name of your Nextcloud instance (e.g. MyPrivateCloud) * @return string * @since 6.0.0 */ public function getName(): string { return $this->defaults->getName(); } /** * Name of the software product (defaults to Nextcloud) * * @return string * @since 22.0.0 */ public function getProductName(): string { return $this->defaults->getProductName(); } /** * name of your ownCloud instance containing HTML styles * @return string * @since 8.0.0 * @depreacted 22.0.0 */ public function getHTMLName(): string { return $this->defaults->getHTMLName(); } /** * Entity behind your onwCloud instance * @return string * @since 6.0.0 */ public function getEntity(): string { return $this->defaults->getEntity(); } /** * ownCloud slogan * @return string * @since 6.0.0 */ public function getSlogan(?string $lang = null): string { return $this->defaults->getSlogan($lang); } /** * footer, short version * @return string * @since 6.0.0 */ public function getShortFooter(): string { return $this->defaults->getShortFooter(); } /** * footer, long version * @return string * @since 6.0.0 */ public function getLongFooter(): string { return $this->defaults->getLongFooter(); } /** * Returns the AppId for the App Store for the iOS Client * @return string AppId * @since 8.0.0 */ public function getiTunesAppId(): string { return $this->defaults->getiTunesAppId(); } /** * Themed logo url * * @param bool $useSvg Whether to point to the SVG image or a fallback * @return string * @since 12.0.0 */ public function getLogo(bool $useSvg = true): string { return $this->defaults->getLogo($useSvg); } /** * Returns primary color * @return string * @since 12.0.0 */ public function getColorPrimary(): string { return $this->defaults->getColorPrimary(); } /** * @param string $key * @return string URL to doc with key * @since 12.0.0 */ public function buildDocLinkToKey(string $key): string { return $this->defaults->buildDocLinkToKey($key); } /** * Returns the title * @return string title * @since 12.0.0 */ public function getTitle(): string { return $this->defaults->getTitle(); } /** * Returns primary color * @return string * @since 13.0.0 */ public function getTextColorPrimary(): string { return $this->defaults->getTextColorPrimary(); } } n value='vstakhov-proxy-compression'>vstakhov-proxy-compression Rapid spam filtering system: https://github.com/rspamd/rspamdwww-data
aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 23c0618cc982aaa42fb79876079747a80465d617 (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

# <a href="https://rspamd.com"><img src="https://rspamd.com/img/rspamd_logo_black.png" alt="Rspamd" width="220px"/></a>

[![DroneCI](https://ci.rspamd.com/api/badges/rspamd/rspamd/status.svg)](https://ci.rspamd.com/rspamd/rspamd)


## Introduction

[Rspamd](https://rspamd.com) is an advanced spam filtering system and email processing framework that allows evaluation of messages by a number of
rules including regular expressions, statistical analysis and custom services
such as URL black lists. Each message is analysed by Rspamd and given a verdict that might be used by MTA for further processing (e.g. to reject a message, or add a special header indicating spam) along with other information, such as possible DKIM signature or modifications suggested for a message.

Rspamd can act as a [Milter](https://en.wikipedia.org/wiki/Milter) allowing direct interaction with popular MTA systems, such as Postfix or Sendmail.

Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of
useful features including a comprehensive [Lua API](https://rspamd.com/doc/lua/) that allows access to messages processing in various aspects as well as [asynchronous](https://rspamd.com/doc/lua/sync_async.html) network API to access external resources, such as DNS, HTTP or even generic TCP/UDP services.


## Getting Started

A good starting point to study how to install and configure Rspamd is [the quick start guide](https://rspamd.com/doc/quickstart.html).

Rspamd is [packaged](https://rspamd.com/downloads.html) for the major Linux distributions, and is also available via [FreeBSD ports](https://freshports.org/mail/rspamd), NetBSD [pkgsrc](https://pkgsrc.org) and [OpenBSD ports](http://openports.se/mail/rspamd).

We advice to use packages provided by Rspamd project if available for your OS instead of packages that might be provided by some Linux distributives, as they are usually out of date and does not provide the desired spam filtering quality nor supported by Rspamd project.

## Spam filtering features

Rspamd is shipped with various spam filtering modules and features enabled just out of the box.
The full list of built-in modules could be found in the [Rspamd documentation](https://rspamd.com/doc/modules/).

If that is not enough, Rspamd provides an extensive [Lua API](https://rspamd.com/doc/lua/) to write your own rules and plugins: <https://rspamd.com/doc/tutorials/writing_rules.html>

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for details

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in `rspamd` by you, as defined in the APACHE 2.0 license, shall be licensed as above, without any additional terms or conditions.

## Authors

* **Vsevolod Stakhov** - [vstakhov](https://github.com/vstakhov)

See also the list of [contributors](AUTHORS.md) who participated in this project.


## References

* Home site: <https://rspamd.com>
* Development: <https://github.com/rspamd/rspamd>
* Site repository: <https://github.com/rspamd/rspamd.com>