GRC - GMail Rules Creator

This project provides a tool to generate XML files for configuring Gmail filters based on a YAML input file. It allows for easy management and customization of mail filters while adhering to a specified structure.

Features

• Accepts a YAML input file containing author details, default values, and filter configurations.
• Automatically applies default values to filters when optional parameters are omitted.
• Outputs a formatted XML file compatible with Gmail's filter configuration.

Project Structure

project/
├── resources/
│   └── example.yaml  # Example YAML file for testing
├── main.go           # Main source code file
├── Makefile          # Build and execution commands
├── .gitignore        # Ignored files and directories
└── README.md         # Project documentation

Prerequisites

• Go (Golang) 1.16 or later

Getting Started

1. Clone the repository

git clone <repository-url>
cd project

2. Prepare your YAML input file

Ensure that a YAML file with the required structure exists in the resources/ directory. You can use the provided example.yaml as a reference:

author:
  name: "John Doe"
  email: "[email protected]"

default:
  shouldArchive: true
  shouldNeverSpam: true
  shouldNeverMarkAsImportant: false

filters:
  - from: "[email protected]"
    label: "Work"
  - from: "[email protected]"
    label: "Personal"

3. Build the project

Run the following command to compile the binary:

make build

4. Generate XML

Use the provided build-xml Makefile target to create the XML file:

make build-xml

This will generate an XML file in the resources/ directory based on the YAML input.

5. Clean up

To remove generated files, use:

make clean

Usage

Run the compiled binary directly with a specified YAML file as input:

./grc rules.yaml

The output XML file will be saved in the same directory as the input YAML file, with the .xml extension.

License

This project is licensed under the MIT License. See the LICENSE file for more details.