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
gmail-filter-builder/README.md
Oliver Davies f90b2fcd9f Update README
2016-09-30 13:03:42 +01:00

1.1 KiB
Raw Blame History

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