uccello/email-history

An Uccello package to log email sent.

v1.1.0 2021-02-09 15:43 UTC

Requires

• uccello/uccello: 1.*|2.*

MIT

• Jonathan SARDO
• Michaël GUERINO

README

This package allows you to track with Uccello emails sent.

Installation

Install with composer

composer require uccello/email-history

Publish assets

php artisan vendor:publish --tag=email-history-assets

Usage

Create Related Lists

With a migration, create a Related List to display emails sent related to a record:

php artisan make:migration create_email_history_rl

<?php

use Illuminate\Database\Migrations\Migration;
use Uccello\Core\Models\Module;
use Uccello\Core\Models\Relatedlist;

class CreateEmailHistoryRl extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        $module = Module::where('name', 'account')->first(); // Change 'account' with the source module's name

        $relatedModule = Module::where('name', 'email')->first();
        Relatedlist::create([
            'module_id' => $module->id,
            'related_module_id' => $relatedModule->id,
            'related_field_id' => $relatedModule->fields->where('name', 'entity')->first()->id,
            'tab_id' => null,
            'label' => 'relatedlist.emails',
            'type' => 'n-1',
            'method' => 'getDependentList',
            'sequence' => $module->relatedlists()->count(),
            'data' => null
        ]);
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        $module = Module::where('name', 'account')->first(); // Change 'account' with the source module's name

        $relatedModule = Module::where('name', 'email')->first();
        Relatedlist::where('module_id', $module->id)
            ->where('related_module_id', $relatedModule->id)
            ->where('label', 'relatedlist.emails')
            ->delete();
    }
}

Helper

A helper allows you to add easily a new email and link it to a record.

<?php

    use Uccello\EmailHistory\Facades\EmailHistory;

    // Use function params
	EmailHistory::add(
        $domain, // Current domain
        $record->uuid, // Record uuid
        'Hi everyone!', // Email subject
        'A beautiful email to remember install this package', // Email body
        '[e-mail]', // To
        Carbon::now(), // Sent at - optional
        [ // An array with all attachments (File name => File path in storage) - optional
        "File1.pdf" => "uccello/files/zPODV1l0WF4wEJsad7xHsX6G7D7Cu004AEKjDSkd.pdf",
        "File2.pdf" => "uccello/files/zPODV1l0WF4wEJsad7xHsX6G7D7Cu004AEKjDSkd.pdf"
        ],
        '[e-mail]', // Cc - optional
        '[e-mail]' // Bcc - optional
    );

    // Use array
	EmailHistory::addWithArray([
        'subject' => $subject,
        'body' => $body,
        'sent_at' => $sentAt, // Optional
        'to' => $to,
        'cc' => $cc, // Optional
        'bcc' => $bcc, // Optional
        'attachment' => $attachment, // Optional
        'domain_id' => $domain->id,
        'entity' => $entity_uuid
    ])