https://github.com/antibodies-online/bootstrap-email

This Project is a port of bootstrap-email of @stuyam
https://github.com/antibodies-online/bootstrap-email

bootstrap email mail php responsive

Last synced: 3 months ago
JSON representation

This Project is a port of bootstrap-email of @stuyam

• Host: GitHub
• URL: https://github.com/antibodies-online/bootstrap-email
• Owner: antibodies-online
• License: other
• Created: 2022-03-22T14:11:32.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-10T22:10:31.000Z (4 months ago)
• Last Synced: 2024-10-13T19:19:33.771Z (4 months ago)
• Topics: bootstrap, email, mail, php, responsive
• Language: HTML
• Homepage: https://www.antibodies-online.com
• Size: 253 KB
• Stars: 7
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bootstrap-email

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/antibodies-online/bootstrap-email/master/LICENSE)

[![Packagist](https://img.shields.io/packagist/v/antibodies-online/bootstrap-email.svg)](https://packagist.org/packages/antibodies-online/bootstrap-email)

[![GitHub issues](https://img.shields.io/github/issues/antibodies-online/bootstrap-email.svg)](https://github.com/antibodies-online/bootstrap-email/issues)

[![PHP Composer Test](https://github.com/antibodies-online/bootstrap-email/actions/workflows/php.yml/badge.svg)](https://github.com/antibodies-online/bootstrap-email/actions/workflows/php.yml)

This is a port of [Bootstrap Email](https://github.com/bootstrap-email/bootstrap-email). Thanks to @stuyam!

## Installation

To install, add it to your `composer.json` file:

```json

{

  "require": {

      "antibodies-online/bootstrap-email": "master"

  }

}

```

or direct from [packagist](https://packagist.org/packages/antibodies-online/bootstrap-email)

```shell

composer require antibodies-online/bootstrap-email

```

## Usage

You can use different methods to convert your boostrap-email html to an email client compatible html.

### Use DomDocument

```php

$scss = new ScssCompiler();

// Create a DOM Document

$doc = new DOMDocument('1.0', 'UTF-8');

\libxml_use_internal_errors(true);

$doc->loadHTML(mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8'));

\libxml_clear_errors();

$converter = new Compiler($scss);

$doc = $converter->convert($doc);

$html = $doc->saveHTML();

```

### Use Html

```php

$scss = new ScssCompiler();

$converter = new Compiler($scss);

$html = $converter->compileHtml();

```

### Use Custom Scss

```php

$scss = new ScssCompiler();

$scss->setScssFile(setScssHeadFile(compileHtml();

```

## Run Unit-Tests

```shell

composer test

```

## Features missing

- Add Stack https://bootstrapemail.com/docs/stack

## Documentations

For full documentation, visit [bootstrapemail.com](https://bootstrapemail.com/docs/introduction)

## Contributing

Really appreciate bug reports. Feel free to ask for additional functionality/fields. 

But be aware not all feature may be implemented.

A Pull Request for your Features would be amazing.

## Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

[Discuss Bootstrap Email on GitHub](https://github.com/bootstrap-email/bootstrap-email/discussions)

For PHP Port related questions, please open an issue.