opdavies/gmail-filter-builder
1
0
Fork 0
mirror of https://github.com/opdavies/gmail-filter-builder.git synced 2025-01-22 20:17:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
PHP library for generating importable Gmail filters in XML
23 commits 6 branches 29 tags 250 KiB
PHP 100%
Find a file
Oliver Davies ff0c07a560 Start adding tests
2016-10-12 22:27:30 +01:00
src Use ob_start and ob_get_contents 2016-09-30 12:59:32 +01:00
templates Add twig-extensions and use TwigBooleanStringExtension 2016-07-15 02:52:31 +01:00
tests Start adding tests 2016-10-12 22:27:30 +01:00
.editorconfig Initial commit 2016-07-12 20:54:44 +01:00
.gitignore Ignore XML files 2016-07-12 22:15:27 +01:00
composer.json Require phpunit 2016-10-12 21:44:39 +01:00
composer.lock Require phpunit 2016-10-12 21:44:39 +01:00
phpunit.xml Add phpunit.xml 2016-10-12 21:46:07 +01:00
README.md Update README 2016-09-30 13:03:42 +01:00

README.md

gmail-filter-builder

Description

Inspired by the gmail-britta Ruby library, the Gmail Filter Builder generates XML that can be imported into Gmail’s filter settings.

Usage

  • Run composer require opdavies/gmail-filter-builder to download the library.
  • Create a new PHP file and require autoload.php.
  • Create an array of GmailFilter objects, each with it’s required methods.
  • Pass the filters into an instance of GmailFilterBuilder.
require __DIR__ . '/vendor/autoload.php';

$filters = [];

// Add filters.
$filters[] = GmailFilter::create(
    ...
);

// Display the output.
new GmailFilterBuilder($filters);

To generate the output, run PHP on the file - e.g. php generate.php.

By default, the output is displayed on screen. To generate a file, use the greater than symbol followed by a file name - e.g. php generate.php > filters.xml.

Example

For a working example, see the opdavies/gmail-filters repository.

License

MIT