Initial draft commit

Author: camuthig

.gitignore

@@ -0,0 +1,3 @@
+/vendor
+/.idea
+/composer.lock

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 Quartzy, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

composer.json

@@ -0,0 +1,31 @@
+{
+    "name": "quartzy/php-email",
+    "type": "library",
+    "version": "0.1.0",
+    "license": "Apache-2.0",
+    "description": "A domain model for describing emails that is indifferent towards sending methods.",
+    "keywords": ["email", "domain-driven"],
+    "authors": [
+        {
+            "name": "Chris Muthig",
+            "email": "camuthig@gmail.com"
+        }
+    ],
+    "require": {
+        "php": "^5.6|^7.0",
+        "beberlei/assert": "^2.7"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.7"
+    },
+    "autoload": {
+        "psr-4": {
+            "Postcard\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Postcard\\Test\\": "tests/"
+        }
+    }
+}

src/Content.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Postcard;
+
+/**
+ * A blank interface to defining a hierarchy of email content. In a world with a multitude of third-party services for
+ * sending email, the content is no longer necessarily and HTML or text string. From here, anything can be defined,
+ * including emails based on third-party templates, text, or no content at all.
+ */
+interface Content
+{
+}

src/Content/EmptyContent.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Postcard\Content;
+
+use Postcard\Content;
+
+class EmptyContent implements Content
+{
+}

src/Content/SimpleContent.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Postcard\Content;
+
+use Postcard\Content;
+
+/**
+ * The standard content of an email, as we have always used it. All that is required is some HTML or a text string.
+ */
+class SimpleContent implements Content
+{
+    /**
+     * @var string|null
+     */
+    private $html;
+
+    /**
+     * @var string|null
+     */
+    private $text;
+
+    /**
+     * SimpleContent constructor.
+     *
+     * @param string|null $html
+     * @param string|null $text
+     */
+    public function __construct($html, $text)
+    {
+        $this->html = $html;
+        $this->text = $text;
+    }
+
+    /**
+     * @param string $html
+     *
+     * @return self
+     */
+    public static function html($html)
+    {
+        return new self($html, null);
+    }
+
+    /**
+     * @param string $text
+     *
+     * @return self
+     */
+    public static function text($text)
+    {
+        return new self(null, $text);
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getHtml()
+    {
+        return $this->html;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getText()
+    {
+        return $this->text;
+    }
+}

src/Content/TemplatedContent.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Postcard\Content;
+
+/**
+ * Email templates allow rendering of content to be handled by third-party service providers such as Postmark,
+ * Sparkpost and SendGrid. How an application stores the available third-party templates is up to the developer,
+ * so the goal of this interface is to give a standard interaction with some templated email content, knowing that a
+ * template must have an identifier provided by the third party service.
+ */
+interface TemplatedContent
+{
+    /**
+     * @return string
+     */
+    public function getTemplateId();
+}