Hoa central
README
Hoa

Hoa is a modular, extensible and structured set of PHP libraries. Moreover, Hoa aims at being a bridge between industrial and research worlds.

Hoa

This library allows to compose and send rich emails (textual contents, HTML documents, alternative contents, attachments etc., this is very extensible). Email can be sent with sendmail or SMTP. The SMTP layer supports TLS and PLAIN, LOGIN and CRAM-MD5 authentications.

In a near future, this library will also allow to receive and parse emails.

Installation

With Composer, to include this library into your dependencies, you need to require `hoa/mail`:

```json { "require": { "hoa/mail": "~0.0" } } ```

Please, read the website to get more informations about how to install.

Quick usage

We propose a quick overview to send a very simple email with only one content, and then, a more complex email with an alternative content and an attachment.

Simple email

Before all, just like any messaging softwares, we have to setup the transport. We will send our email by using SMTP as the default transport. We will specify a socket to the SMTP server, a login and a password:

```php Hoa::setDefaultTransport( new Hoa( new Hoa('tcp://mail.domain.tld:587'), 'gordon_freeman', '*********' ) ); ```

Then, we will get an instance of a message and set all the headers, such as From, To and Subject, we will add a textual content and we will send it:

```php $message = new Hoa(); $message['From'] = 'Gordon Freeman gordo.nosp@m.n@fr.nosp@m.eeman.nosp@m..hf'; $message['To'] = 'Alyx Vance alyx@.nosp@m.vanc.nosp@m.e.hf'; $message['Subject'] = 'Hoa is awesome!';

$message->addContent( new Hoa('Check this out: http://hoa-project.net/!') );

$message->send(); ```

Notice that we can use any view or template library to produce the content of the mail!

Rich email

Now, instead of having only one textual content, we will have an alternative content: either textual or HTML.

```php $message->addContent( // We have either… new Hoa([ // … a text content new Hoa( 'Check this out: http://hoa-project.net/!' ), // … or an HTML content. new Hoa( 'Check this ' . 'out!' ) ]) ); ```

Then, to add an attachment, we will add a new kind of content. The attachment is an image that will be named Foobar.jpg. Thus:

```php $message->addContent( new Hoa( new Hoa('Attachment.jpg'), 'Foobar.jpg' ) ); ```

And finally, we send the email:

```php $message->send(); ```

Complex email

Now imagine we do not want the image to be only attached but appear in the HTML content. These contents are related. Here is how to construct the email (with more variables to clarify):

```php // The image. $attachment = new Hoa( new Hoa('Attachment.jpg'), 'Foobar.jpg' ); // The text content. $text = new Hoa('Check this out: http://hoa-project.net/!'); // The HTML content. $html = new Hoa( '

' );

$message->addContent( // Alternative contents and attachment are related. new Hoa([ // We still have 2 alternative contents: text or HTML. new Hoa([$text, $html]), $attachment ]) ); ```

Documentation

Different documentations can be found on the website: http://hoa-project.net/.

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see `LICENSE`.