isomorfeus-mailer 1.0.0.zeta16 → 1.0.0.zeta17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19dcfecd348c58dbd62d7098f5544fa611306a4b0bcac6921e62946eef02e8c1
-  data.tar.gz: 38d4b14a087396345a6b2c2218af9121051b0532f20d6c2b0a8f7355fef41492
+  metadata.gz: 52d9bd4e04bd1cdc98d6f4e554c60157d8e957696c893b3ad7c1d1ae270e04c4
+  data.tar.gz: '093267ef78db9fbe97e3e615d9504cd6c1d88ff005da48c8177539e300d4db20'
 SHA512:
-  metadata.gz: c70ff8167095e85c708de4cdc2fd400d5142baa6ea493ef2ad8ced81b10e1521dfe7d435afc9241a2393e4fc9b8756e3d6fa8d0e6d49b090e6d9d1510eb37f1a
-  data.tar.gz: 4038510b62a679cbeefd0332503cd1239cac79f4284ed1ef9a6a5566c250fcac4171058afeae8fd616009d997479739127adae30f540bf4c719d86103e052293
+  metadata.gz: a6c97e10fa49fd702df741a53dd47e2056af9b989e141c6f2d76367626e57fc042d64abd0b6c252498b70dcf675cb49fc4625ef3714104a505402be7f4c30ffa
+  data.tar.gz: 0f3161bce4725cb4473f0cc7c4c8e3ecac7e281d3dd9b71102a5f2b211bbd2cdb52215f3644481751eafdd521ca3630fffac721698f9ddd8e30601ac7d438b1d

data/README.md

@@ -16,11 +16,14 @@ All configuration options of Mailhandler can be passed in the hash. For Mailhand
 
 ### Usage
 
+#### Mail Components
 Within a isomorfeus project components for building emails are the app/mail_components directory.
 When using LucidComponent or LucidMaterial::Component the main component passed to the mail must be either a LucidApp or LucidMaterial::App component.
 Each mail template build of components can be considered a tiny App.
 
-One class is provided to actually build and send the mail: LucidMail. This class is only available on the server.
+Mail components are rendered using the React static renderer, so the React rules for static rendering apply.
+
+Inline styles work in Mail Components too.
 
 Example component:
 ```ruby
@@ -36,6 +39,10 @@ class EmailComponent < LucidApp::Base
 end
 ```
 
+#### Sending Mail
+
+One class is provided to actually build and send the mail: LucidMail. This class is only available on the server.
+
 Sending mail with the rendered component:
 ```ruby
 mail = LucidMail.new(component: 'EmailComponent', 
@@ -45,6 +52,22 @@ mail = LucidMail.new(component: 'EmailComponent',
                      subject: 'Welcome')
 mail.send
 ```
+#### Inspecting the rendered component
+
+The generated HTML is accessible after building the mail using:
+```ruby
+mail.build
+html = mail.rendered_component
+```
+
+#### Accessing the mail before sending
+
+It is possible to access the actual mail object after building it for further inspection or modification:  
+```ruby
+mail.build
+mail_object = mail.mail
+```
+For documentation about the Mail Object see the [Mail Documentation](https://github.com/mikel/mail).
 
 #### Triggering mail from a client
 LucidMail is available only on the server. It can be wrapped in a operation to allow triggering the sending of mail from a client. Example:

data/lib/isomorfeus/mailer/version.rb

@@ -1,5 +1,5 @@
 module Isomorfeus
   module Mailer
-    VERSION = '1.0.0.zeta16'
+    VERSION = '1.0.0.zeta17'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-mailer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.zeta16
+  version: 1.0.0.zeta17
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 16.12.17
+        version: 16.12.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 16.12.17
+        version: 16.12.18
 - !ruby/object:Gem::Dependency
   name: isomorfeus-redux
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.zeta16
+        version: 1.0.0.zeta17
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.zeta16
+        version: 1.0.0.zeta17
 - !ruby/object:Gem::Dependency
   name: opal-webpack-loader
   requirement: !ruby/object:Gem::Requirement