mirror of
https://github.com/opdavies/gmail-filter-builder.git
synced 2025-09-04 04:35:33 +01:00
Initial commit
This commit is contained in:
commit
d56e7c6620
7 changed files with 389 additions and 0 deletions
175
src/GmailFilter.php
Normal file
175
src/GmailFilter.php
Normal file
|
@ -0,0 +1,175 @@
|
|||
<?php
|
||||
|
||||
class GmailFilter
|
||||
{
|
||||
/**
|
||||
* @param array
|
||||
*/
|
||||
private $conditions = [];
|
||||
|
||||
/**
|
||||
* @param array
|
||||
*/
|
||||
private $labels = [];
|
||||
|
||||
private $archive = false;
|
||||
|
||||
private $spam = false;
|
||||
|
||||
private $trash = false;
|
||||
|
||||
/**
|
||||
* @return boolean
|
||||
*/
|
||||
public function isTrash() {
|
||||
return $this->trash;
|
||||
}
|
||||
|
||||
private $neverSpam = false;
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
public function getConditions() {
|
||||
return $this->conditions;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
public function getLabels() {
|
||||
return $this->labels;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return boolean
|
||||
*/
|
||||
public function isArchive() {
|
||||
return $this->archive;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return boolean
|
||||
*/
|
||||
public function isSpam() {
|
||||
return $this->spam;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return boolean
|
||||
*/
|
||||
public function isNeverSpam() {
|
||||
return $this->neverSpam;
|
||||
}
|
||||
|
||||
public function __get($name) {
|
||||
return $this->$name;
|
||||
}
|
||||
|
||||
public static function create()
|
||||
{
|
||||
return new static();
|
||||
}
|
||||
|
||||
public function contains($value) {
|
||||
return $this->condition('hasTheWord', $value);
|
||||
}
|
||||
|
||||
public function subject($value) {
|
||||
return $this->condition('subject', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a label.
|
||||
*
|
||||
* @param string $label
|
||||
* The label to assign.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function label($label) {
|
||||
$this->labels[] = $label;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return $this
|
||||
*/
|
||||
public function archive() {
|
||||
$this->archive = true;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark as spam.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function spam() {
|
||||
$this->spam = true;
|
||||
$this->neverSpam = false;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Never mark as spam.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function neverSpam() {
|
||||
$this->neverSpam = true;
|
||||
$this->spam = false;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Who the email is from.
|
||||
*
|
||||
* @param array $values
|
||||
* An array of names or email addresses for the sender.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function from(array $values)
|
||||
{
|
||||
$this->condition('from', implode('||', $values));
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Who the email is sent to.
|
||||
*
|
||||
* @param array $values
|
||||
* An array of names or email addresses for the receiver.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function to(array $values)
|
||||
{
|
||||
$this->condition('to', implode('||', $values));
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a condition.
|
||||
*
|
||||
* @param string $type
|
||||
* The type of condition.
|
||||
* @param $value
|
||||
* The value of the condition.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
private function condition($type, $value)
|
||||
{
|
||||
$this->conditions[] = [$type, $value];
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
77
src/GmailFilterBuilder.php
Normal file
77
src/GmailFilterBuilder.php
Normal file
|
@ -0,0 +1,77 @@
|
|||
<?php
|
||||
|
||||
class GmailFilterBuilder
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $name;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $email;
|
||||
|
||||
/**
|
||||
* @var \Twig_Environment
|
||||
*/
|
||||
private $twig;
|
||||
|
||||
/**
|
||||
* An array of filters.
|
||||
*
|
||||
* @var GmailFilter[]
|
||||
*/
|
||||
private $filters = [];
|
||||
|
||||
public function __construct($name, $email, $filters)
|
||||
{
|
||||
$this->name = $name;
|
||||
$this->email = $email;
|
||||
|
||||
$this->twig = new Twig_Environment(
|
||||
new Twig_Loader_Filesystem(__DIR__ . '/../templates')
|
||||
);
|
||||
|
||||
$this->filters = $filters;
|
||||
|
||||
return $this->generate();
|
||||
}
|
||||
|
||||
public function __toString()
|
||||
{
|
||||
return $this->generate();
|
||||
}
|
||||
|
||||
/**
|
||||
* Build Gmail filters.
|
||||
*
|
||||
* @param string $name
|
||||
* The author name.
|
||||
* @param string $email
|
||||
* The author email address.
|
||||
* @param GmailFilter[] $filters
|
||||
* An array of filters to process.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public static function build($name, $email, array $filters)
|
||||
{
|
||||
return new static($name, $email, $filters);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
private function generate()
|
||||
{
|
||||
return $this->twig->render(
|
||||
'filters.xml.twig',
|
||||
[
|
||||
'name' => $this->name,
|
||||
'email' => $this->email,
|
||||
'filters' => $this->filters,
|
||||
]
|
||||
);
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue