API Reference - Email Outbox Logs

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108101

← Back to API Reference | Getting Started

Email Outbox Logs

Email Outbox Logs record delivery events for emails processed through the Email Outbox queue. Each log entry captures a single provider-reported event (such as delivered, bounced, or dropped) for a specific outbox message and links to the original outbox record.

Model name in URL: email_outbox_log — DB table: email_outbox_log

The Email Outbox Log Object

FieldTypeDescription
log_idintegerUnique log entry ID (primary key, read-only)
databasestringName of the related database table (typically email_outbox)
database_idintegerID of the related record in the database table (links to outbox_id in email_outbox)
emailstringEmail address of the recipient
eventstringDelivery event type (EG delivered, bounce, dropped, open, click, spamreport)
responsestringSMTP or provider response message for the event
datestringDate and time the event was recorded (format: YYYYMMDDHHmmss)
smtp_idstringUnique message ID assigned by the SMTP provider (EG SendGrid message ID)

List Email Outbox Log Entries

GET /api/v2/email_outbox_log/get

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/email_outbox_log/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "log_id": "1",
      "database": "email_outbox",
      "database_id": "1",
      "email": "recipient@example.com",
      "event": "dropped",
      "response": "",
      "date": "20240531083708",
      "smtp_id": "z5DplwBiQQefq5Iw6gjpwg@geopod-ismtpd-17"
    },
    {
      "log_id": "2",
      "database": "email_outbox",
      "database_id": "2",
      "email": "member@example.com",
      "event": "delivered",
      "response": "250 2.0.0 OK  1717486537 6a1803df08f44-6ae4a732a70si103354576d6.97 - gsmtp",
      "date": "20240604003537",
      "smtp_id": "Wz3PoB11ScaPOH5SE8uwHQ@geopod-ismtpd-canary-0"
    }
  ],
  "total": "2489",
  "current_page": 1,
  "total_pages": 100,
  "next_page": "MipfKjI1"
}

Retrieve an Email Outbox Log Entry

GET /api/v2/email_outbox_log/get/{log_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/email_outbox_log/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "log_id": "1",
      "database": "email_outbox",
      "database_id": "1",
      "email": "recipient@example.com",
      "event": "dropped",
      "response": "",
      "date": "20240531083708",
      "smtp_id": "z5DplwBiQQefq5Iw6gjpwg@geopod-ismtpd-17"
    }
  ],
  "total": "2489",
  "current_page": 1,
  "total_pages": 1
}

Create an Email Outbox Log Entry

POST /api/v2/email_outbox_log/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/email_outbox_log/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "database=email_outbox" \
  -d "database_id=251" \
  -d "email=recipient%40example.com" \
  -d "event=delivered" \
  -d "response=250+OK" \
  -d "date=20240401120500" \
  -d "smtp_id=abc123xyz%40geopod-ismtpd-1"

Example Response

Copy
{
  "status": "success",
  "message": {
    "log_id": "2490",
    "database": "email_outbox",
    "database_id": "251",
    "email": "recipient@example.com",
    "event": "delivered",
    "response": "250 OK",
    "date": "20240401120500",
    "smtp_id": "abc123xyz@geopod-ismtpd-1"
  }
}

Update an Email Outbox Log Entry

PUT /api/v2/email_outbox_log/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/email_outbox_log/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "log_id=2490" \
  -d "event=open" \
  -d "response="

Example Response

Copy
{
  "status": "success",
  "message": {
    "log_id": "2490",
    "database": "email_outbox",
    "database_id": "251",
    "email": "recipient@example.com",
    "event": "open",
    "response": "",
    "date": "20240401120500",
    "smtp_id": "abc123xyz@geopod-ismtpd-1"
  }
}

Delete an Email Outbox Log Entry

DELETE /api/v2/email_outbox_log/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/email_outbox_log/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "log_id=2490"

Example Response

Copy
{
  "status": "success",
  "message": "email_outbox_log record was deleted"
}