<commit_before>XCMailr
=======
Summary
------
 * Name: XCMailr
 * Version: 1.0
 * Release: May 2013
 * License: Apache V2.0
 * License URI: http://www.apache.org/licenses/LICENSE-2.0.txt
 * Tags: AntiSpam, Testutility
 * Contributors:
    * <NAME>, Xceptance Software Technologies GmbH
    *  

Description:
------------
XCMailr helps you to reduce the amount of spam in your personal E-Mail-Account. Create temporary Mailaddresses which will be automatically forwarded to your own Mail. The Mail-Forwards will expire automatically after a given validity period or at every time you want to. XCMailr will not save any contents of your mails.


Requirements
-------------
 * Memcached ( http://memcached.org/ )


Configuration:
--------------
 * Open and edit the application.conf in conf/ 
 * It is strongly recommended to create a new application secret. This secret ensures that the Session-Cookie of a User has not been modified. 
 * You should especially customize the following settings:
    * **mbox.dlist**: the list of available domains
    * **mbox.host** the main-application-host 
    * ** mail.smtp.* ** the "outbound" SMTP-Server (the Server to which the Application will forward any "valid" Messages )
    * ** memcached.* ** the MemCached-Server (host and port)
    * ** ebean.* ** the Ebean-Configuration

 * To reach the Admin-Panel visit http://yourdomain/admin (a more comfortable solution will come in a later version).
 * HTTPS Support, Edit conf/jetty.xml-file: http://blog.callistaenterprise.se/2011/11/24/quick-start-jettys-maven-plugin-with-ssl/

Run the Application:
--------------------
 * Just edit the application.conf (see Configuration) and run the 'run.sh'-script
 * To drop and recreate all Tables (this will remove all data contained in this tables!) run the script with the parameter "-Dxcmailr.xcmstart.droptables=true"


Frameworks/Librarys/Code/etc which were provided by others:
-----------------------------------------------------------
 * Avaje Ebean 
    * http://www.avaje.org/
    * LGPL: http://www.gnu.org/licenses/lgpl.html

 * H2 Database Engine
    * http://www.h2database.com/
    * Dual licensed
         * H2 License, V1.0: http://www.h2database.com/html/license.html#h2_license
         * EPL: http://www.h2database.com/html/license.html#eclipse_license

 * Icons by Glyphicons (shipped with Twitter Bootstrap)
    * Copyright <NAME>
    * http://glyphicons.com/
    * Apache V2.0 License: https://github.com/twitter/bootstrap/wiki/License

 * Jetty 6
    * http://www.eclipse.org/jetty/
    * Apache V2.0 License: http://www.apache.org/licenses/LICENSE-2.0
  	
 * jQuery Tablesorter 2.0 plugin
    * http://tablesorter.com
    * Dual licensed 
         * MIT-License: http://www.opensource.org/licenses/mit-license.php
         * GPL: http://www.opensource.org/licenses/gpl-license.php

 * Spymemcached
    * http://code.google.com/p/spymemcached/
    * MIT-License: http://www.opensource.org/licenses/mit-license.php

 * JBCrypt - a Java BCrypt implementation 
    * Copyright (c) 2006 <NAME>
    * http://www.mindrot.org/projects/jBCrypt/
    * ISC/BSD License: http://www.mindrot.org/files/jBCrypt/LICENSE

 * JodaTime
    * http://joda-time.sourceforge.net
    * Apache V2.0 License: http://joda-time.sourceforge.net/license.html

 * NinjaFramework
    * http://www.ninjaframework.org/
    * Apache V2.0 License: https://github.com/reyez/ninja/blob/develop/license.txt

 * Twitter Bootstrap
    * Copyright 2011 Twitter, Inc.
    * http://twitter.github.io/bootstrap/
    * Apache V2.0 License: https://github.com/twitter/bootstrap/wiki/License




License:
--------
XCMailr is licensed under the Apache Version 2.0 license.
See LICENSE file for full license text.
<commit_msg>added some information about the logging-configuration in the readme.md<commit_after>XCMailr
=======
Summary
------
 * Name: XCMailr
 * Version: 1.0
 * Release: May 2013
 * License: Apache V2.0
 * License URI: http://www.apache.org/licenses/LICENSE-2.0.txt
 * Tags: AntiSpam, Testutility
 * Contributors:
    * <NAME>, Xceptance Software Technologies GmbH
    *  

Description:
------------
XCMailr helps you to reduce the amount of spam in your personal E-Mail-Account. Create temporary Mailaddresses which will be automatically forwarded to your own Mail. The Mail-Forwards will expire automatically after a given validity period or at every time you want to. XCMailr will not save any contents of your mails.


Requirements
-------------
 * Memcached ( http://memcached.org/ )


Configuration:
--------------
 * Open and edit the application.conf in conf/ 
 * It is strongly recommended to create a new application secret. This secret ensures that the Session-Cookie of a User has not been modified. 
 * You should especially customize the following settings:
    * **mbox.dlist**: the list of available domains
    * **mbox.host** the main-application-host 
    * ** mail.smtp.* ** the "outbound" SMTP-Server (the Server to which the Application will forward any "valid" Messages )
    * ** memcached.* ** the MemCached-Server (host and port)
    * ** ebean.* ** the Ebean-Configuration

 * To reach the Admin-Panel visit http://yourdomain/admin (a more comfortable solution will come in a later version).
 * You can configure the logging by editing conf/logback.xml, see http://logback.qos.ch/manual/ for documentation
 * HTTPS Support, Edit conf/jetty.xml-file as shown here: http://blog.callistaenterprise.se/2011/11/24/quick-start-jettys-maven-plugin-with-ssl/

Run the Application:
--------------------
 * Just edit the application.conf (see Configuration) and run the 'run.sh'-script
 * To drop and recreate all Tables (this will remove all data contained in this tables!) run the script with the parameter "-Dxcmailr.xcmstart.droptables=true"


Frameworks/Librarys/Code/etc which were provided by others:
-----------------------------------------------------------
 * Avaje Ebean 
    * http://www.avaje.org/
    * LGPL: http://www.gnu.org/licenses/lgpl.html

 * H2 Database Engine
    * http://www.h2database.com/
    * Dual licensed
         * H2 License, V1.0: http://www.h2database.com/html/license.html#h2_license
         * EPL: http://www.h2database.com/html/license.html#eclipse_license

 * Icons by Glyphicons (shipped with Twitter Bootstrap)
    * Copyright <NAME>
    * http://glyphicons.com/
    * Apache V2.0 License: https://github.com/twitter/bootstrap/wiki/License

 * Jetty 6
    * http://www.eclipse.org/jetty/
    * Apache V2.0 License: http://www.apache.org/licenses/LICENSE-2.0
  	
 * jQuery Tablesorter 2.0 plugin
    * http://tablesorter.com
    * Dual licensed 
         * MIT-License: http://www.opensource.org/licenses/mit-license.php
         * GPL: http://www.opensource.org/licenses/gpl-license.php

 * Spymemcached
    * http://code.google.com/p/spymemcached/
    * MIT-License: http://www.opensource.org/licenses/mit-license.php

 * JBCrypt - a Java BCrypt implementation 
    * Copyright (c) 2006 <NAME>
    * http://www.mindrot.org/projects/jBCrypt/
    * ISC/BSD License: http://www.mindrot.org/files/jBCrypt/LICENSE

 * JodaTime
    * http://joda-time.sourceforge.net
    * Apache V2.0 License: http://joda-time.sourceforge.net/license.html

 * NinjaFramework
    * http://www.ninjaframework.org/
    * Apache V2.0 License: https://github.com/reyez/ninja/blob/develop/license.txt

 * Twitter Bootstrap
    * Copyright 2011 Twitter, Inc.
    * http://twitter.github.io/bootstrap/
    * Apache V2.0 License: https://github.com/twitter/bootstrap/wiki/License




License:
--------
XCMailr is licensed under the Apache Version 2.0 license.
See LICENSE file for full license text.

{'fraction_non_alphanumeric': 0.14377121963959258, 'fraction_numerical': 0.013319404544267433, 'mean_word_length': 2.8799392097264436, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 6, 'lorem ipsum': 0, 'www.': 28, 'xml': 3}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5420996', 'n_tokens_mistral': 2367, 'n_tokens_neox': 2229, 'n_words': 659}