README

AI Email Detection for Laravel

🚀 Leverage AI API to detect and extract email addresses from text content.

Check the details at SharpAPI's AI Emails Detector API page.

Requirements

PHP >= 8.1
Laravel >= 9.0

Installation

Follow these steps to install and set up the SharpAPI Laravel Email Detection package.

Install the package via composer:

composer require sharpapi/laravel-content-detect-emails

Register at SharpAPI.com to obtain your API key.
Set the API key in your .env file:

SHARP_API_KEY=your_api_key_here

[OPTIONAL] Publish the configuration file:

php artisan vendor:publish --tag=sharpapi-content-detect-emails

Key Features

AI-Powered Email Detection: Efficiently detect email addresses in any text content.
Multiple Email Detection: Identifies all email addresses present in the provided text.
Format Validation: Ensures detected emails are properly formatted.
Obfuscated Email Detection: Can detect emails that are partially obfuscated or formatted in non-standard ways.
Robust Polling for Results: Polling-based API response handling with customizable intervals.
API Availability and Quota Check: Check API availability and current usage quotas with SharpAPI's endpoints.

Usage

You can inject the ContentDetectEmailsService class to access email detection functionality. For best results, especially with batch processing, use Laravel's queuing system to optimize job dispatch and result polling.

Basic Workflow

Dispatch Job: Send text content to the API using detectEmails, which returns a status URL.
Poll for Results: Use fetchResults($statusUrl) to poll until the job completes or fails.
Process Result: After completion, retrieve the results from the SharpApiJob object returned.

Note: Each job typically takes a few seconds to complete. Once completed successfully, the status will update to success, and you can process the results as JSON, array, or object format.

Controller Example

Here is an example of how to use ContentDetectEmailsService within a Laravel controller:

<?php

namespace App\Http\Controllers;

use GuzzleHttp\Exception\GuzzleException;
use SharpAPI\ContentDetectEmails\ContentDetectEmailsService;

class ContentController extends Controller
{
    protected ContentDetectEmailsService $emailDetectionService;

    public function __construct(ContentDetectEmailsService $emailDetectionService)
    {
        $this->emailDetectionService = $emailDetectionService;
    }

    /**
     * @throws GuzzleException
     */
    public function detectEmailAddresses(string $text)
    {
        $statusUrl = $this->emailDetectionService->detectEmails($text);
        
        $result = $this->emailDetectionService->fetchResults($statusUrl);

        return response()->json($result->getResultJson());
    }
}

Handling Guzzle Exceptions

All requests are managed by Guzzle, so it's helpful to be familiar with Guzzle Exceptions.

Example:

use GuzzleHttp\Exception\ClientException;

try {
    $statusUrl = $this->emailDetectionService->detectEmails('Contact us at support@example.com or sales@example.com');
} catch (ClientException $e) {
    echo $e->getMessage();
}

Optional Configuration

You can customize the configuration by setting the following environment variables in your .env file:

SHARP_API_KEY=your_api_key_here
SHARP_API_JOB_STATUS_POLLING_WAIT=180
SHARP_API_JOB_STATUS_USE_POLLING_INTERVAL=true
SHARP_API_JOB_STATUS_POLLING_INTERVAL=10
SHARP_API_BASE_URL=https://sharpapi.com/api/v1

Email Detection Data Format Example

{
  "data": {
    "type": "api_job_result",
    "id": "06f4a1ba-b6b1-48b3-b071-807e3d41db4d",
    "attributes": {
      "status": "success",
      "type": "content_detect_emails",
      "result": [
        "example@email.com",
        "lorem.ipsum@email.com"
      ]
    }
  }
}

Support & Feedback

For issues or suggestions, please:

Open an issue on GitHub
Join our Telegram community

Changelog

Please see CHANGELOG for a detailed list of changes.

Credits

A2Z WEB LTD
Dawid Makowski
Enhance your Laravel AI capabilities!

License

The MIT License (MIT). Please see License File for more information.

Stay updated with news, tutorials, and case studies:

sharpapi / laravel-content-detect-emails

Maintainers

Details