İçeriğe geç

Gelen Kutusu, Formlar ve Uyarılar — Geliştirici Kılavuzu ve Yönetim Arayüzü

Terminal window
pnpm add @vicacha-devs/strapi-plugin-inbox

2. Sunucu Yapılandırması (config/plugins.ts)

Section titled “2. Sunucu Yapılandırması (config/plugins.ts)”

Strapi v5 projenizin config/plugins.ts dosyasına eklenti yapılandırmasını ekleyin:

config/plugins.ts
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({
"inbox": {
enabled: true,
config: {
enableRateLimiting: true,
doubleOptInRequired: true,
},
},
});

Gelen Kutusu, Formlar ve Uyarılar — Strapi v5 Settings Panel

3. Strapi v5 Yönetim Arayüzü (Admin UI) Turu

Section titled “3. Strapi v5 Yönetim Arayüzü (Admin UI) Turu”

Etkinleştirildiğinde eklenti, Strapi Design System v2 bileşenlerini kullanarak çalışma alanını ve ayarlarını yönetim paneline kaydeder:

Gelen Kutusu, Formlar ve Uyarılar — Strapi v5 Admin UI

Yerelleştirilmiş Arayüz Etiketleri (Türkçe)

Section titled “Yerelleştirilmiş Arayüz Etiketleri (Türkçe)”
Çeviri Anahtarı Arayüz Metni
page.ui.inbox_visual_form_builder_service_desk_casework Inbox, Visual Form Builder & Service-Desk Casework
page.ui.starter_form_templates_active_forms Starter Form Templates & Active Forms
page.ui.slug Slug
page.ui.title Başlık
page.ui.category Kategori
page.ui.fields Fields
page.ui.checklist Checklist
page.ui.submissions Submissions

4. İçerik Türü Varlıkları, Konumları ve Şemaları (strapi.documents)

Section titled “4. İçerik Türü Varlıkları, Konumları ve Şemaları (strapi.documents)”

Registers three Collection Types (plugin::inbox.submission, plugin::inbox.subscriber, and plugin::inbox.alert-banner). Submissions capture dynamic form payloads and service-desk tickets; Subscribers manage double opt-in topic lists; Alert Banners drive time-bounded site-wide urgent tickers.

Strapi v5 İçinde İçerik Türü Varlıkları Nerede Bulunur?

Section titled “Strapi v5 İçinde İçerik Türü Varlıkları Nerede Bulunur?”
  • Content Manager: /admin/content-manager/collection-types/plugin::inbox.submission, plugin::inbox.subscriber, and plugin::inbox.alert-banner (visible: true)
  • Content-Type Builder: /admin/plugins/content-type-builder under Collection Types (Inbox Submission, Inbox Subscriber, Inbox Alert Banner)
  • Plugin Workspace & Settings: /admin/plugins/inbox (Service Desk Inbox, Subscribers, Alert Banners) and /admin/settings/inbox
  • Database Tables: inbox_submissions, inbox_subscribers, and inbox_alert_banners

plugin::inbox.alert-banner — Inbox Alert Banner

Section titled “plugin::inbox.alert-banner — Inbox Alert Banner”

Time-bounded multi-language urgent announcement ticker / banner

Kind: collectionType · DB Table: inbox_alert_banners · Admin Location: /admin/content-manager/collection-types/plugin::inbox.alert-banner · Draft & Publish: No · i18n: No

Alan (Attribute) Strapi Türü Zorunlu Kısıtlamalar / İlişki
code string Yes —
title string Yes —
message text Yes —
severity enumeration Yes enum: info, warning, urgent, celebration; default: "info"
ctaLabel string No —
ctaUrl string No —
dismissible boolean No default: true
active boolean No default: true
priority integer No default: 10
startsAt datetime No —
endsAt datetime No —
translations json No default: {}

plugin::inbox.submission — Inbox Submission

Section titled “plugin::inbox.submission — Inbox Submission”

Form submission & Service-Desk Casework ticket

Kind: collectionType · DB Table: inbox_submissions · Admin Location: /admin/content-manager/collection-types/plugin::inbox.submission · Draft & Publish: No · i18n: No

Alan (Attribute) Strapi Türü Zorunlu Kısıtlamalar / İlişki
referenceCode string Yes —
formSlug string Yes —
formTitle string No —
category enumeration No enum: contact, service_desk, inquiry, application, volunteer, custom; default: "contact"
status enumeration Yes enum: new, read, under_review, scheduled, completed, rejected, archived; default: "new"
priority enumeration Yes enum: low, normal, high, urgent; default: "normal"
department string No default: "general"
locale string No default: "es"
applicantName string No —
applicantEmail email No —
applicantPhone string No —
data json Yes default: {}
checklistItems json No default: []
staffNotes text No —
assignedTo string No —
linkedBookingId string No —
linkedCertificateNumber string No —
formBuilderSubmissionId integer No —
ipAddress string No private: true
userAgent string No private: true
submittedAt datetime Yes —
secondaryDate json No —

plugin::inbox.subscriber — Inbox Subscriber

Section titled “plugin::inbox.subscriber — Inbox Subscriber”

Double Opt-In newsletter and community topic subscriber

Kind: collectionType · DB Table: inbox_subscribers · Admin Location: /admin/content-manager/collection-types/plugin::inbox.subscriber · Draft & Publish: No · i18n: No

Alan (Attribute) Strapi Türü Zorunlu Kısıtlamalar / İlişki
email email Yes —
fullName string No —
phone string No —
locale string No default: "es"
topics json No default: ["announcements"]
status enumeration Yes enum: pending, confirmed, unsubscribed; default: "pending"
confirmToken string No private: true
unsubscribeToken string Yes private: true
confirmedAt datetime No —
unsubscribedAt datetime No —
sourceFormSlug string No —

Strapi v5 İçerik Yöneticisi (Content Manager) Entegrasyonu (/admin/content-manager)

Section titled “Strapi v5 İçerik Yöneticisi (Content Manager) Entegrasyonu (/admin/content-manager)”

İçerik Yöneticisi Kenar Çubuğu Grubu: Inbox & Omnichannel Broadcasts

İçerik Yöneticisi Varlıkları ve Bileşenleri

Section titled “İçerik Yöneticisi Varlıkları ve Bileşenleri”
  • plugin::inbox.submission (Inbox Submission — /admin/content-manager/collection-types/plugin::inbox.submission)
  • plugin::inbox.subscriber (Inbox Subscriber — /admin/content-manager/collection-types/plugin::inbox.subscriber)
  • plugin::inbox.alert-banner (Inbox Alert Banner — /admin/content-manager/collection-types/plugin::inbox.alert-banner)

Gelen Kutusu, Formlar ve Uyarılar — Strapi v5 Content Manager Varlık ve Düzenleme Görünümü

Bu Eklenti Neden Content Manager Varlıkları Oluşturur?

Section titled “Bu Eklenti Neden Content Manager Varlıkları Oluşturur?”

@vicacha-devs/strapi-plugin-inbox registers all three of its entities (Inbox Submission, Inbox Subscriber, and Inbox Alert Banner) with pluginOptions['content-manager'].visible = true so service-desk coordinators, newsletter managers, and editors can combine the operational triage board in /admin/plugins/inbox with Strapi v5’s native Content Manager:

  • Structured Casework & Cross-Entity Linking: In Content Manager, Inbox Submission (plugin::inbox.submission) exposes referenceCode, category, status, priority, department, checklistItems, linkedBookingId, and linkedCertificateNumber while keeping ipAddress and userAgent protected (private: true).
  • Subscriber Topic & GDPR Compliance Management: Filter Inbox Subscriber (plugin::inbox.subscriber) by status (pending, confirmed, unsubscribed), locale, and topics while confirmToken and unsubscribeToken remain private.
  • Time-Bounded Urgent Alert Authoring: Author and schedule Inbox Alert Banner (plugin::inbox.alert-banner) records (severity: info, warning, urgent, celebration, startsAt, endsAt, translations) directly in Content Manager.

Strapi Content Manager İçinde Nasıl Kullanılır? (Adım Adım)

Section titled “Strapi Content Manager İçinde Nasıl Kullanılır? (Adım Adım)”
  1. Open in Content Manager: In the left sidebar, navigate to Content Manager -> Collection Types -> Inbox & Omnichannel Broadcasts and select Inbox Submission, Inbox Subscriber, or Inbox Alert Banner.
  2. Manage Urgent Alert Banners: Open Inbox Alert Banner (/admin/content-manager/collection-types/plugin::inbox.alert-banner) to create or toggle site-wide announcements (RAMADAN-HILAL-1447, JUMUAH-LIVE-KHUTBAH, WINTER-BLANKET-CAMPAIGN).
  3. Filter & Assign Service-Desk Submissions: Open Inbox Submission (/admin/content-manager/collection-types/plugin::inbox.submission) to filter tickets by priority = urgent, department, or status = under_review, and update assignedTo and staffNotes.
  4. Workspace vs. Content Manager: Use Content Manager for bulk filtering, alert banner scheduling, and subscriber list audits; use the Inbox Workspace (/admin/plugins/inbox) for dynamic form schema design and interactive service-desk SLA triage.

Content Manager ve Eklenti Çalışma Alanı Senkronizasyonu

Section titled “Content Manager ve Eklenti Çalışma Alanı Senkronizasyonu”

Content Manager Kullanım Senaryoları ve Editöryal İş Akışları

Section titled “Content Manager Kullanım Senaryoları ve Editöryal İş Akışları”

Content Manager Use Case 1 — Scheduling Multilingual Urgent & Celebration Alert Banners

Section titled “Content Manager Use Case 1 — Scheduling Multilingual Urgent & Celebration Alert Banners”
  • Amacı ve Neden Kullanıldığı: Publish time-bounded header banners for Ramadan Hilal confirmation (severity: 'celebration'), Friday live khutbah streams (info), or emergency relief appeals (urgent).
  • Content Manager İçinde Uygulama Adımları: Open /admin/content-manager/collection-types/plugin::inbox.alert-banner, click + Create new entry, set code, title, message, severity, startsAt, endsAt, and translations, and save.

Content Manager Use Case 2 — Auditing Service-Desk Submissions & Linking Bookings/Certificates

Section titled “Content Manager Use Case 2 — Auditing Service-Desk Submissions & Linking Bookings/Certificates”
  • Amacı ve Neden Kullanıldığı: Filter high-priority counseling or matrimonial requests in Content Manager and link them to an appointment (linkedBookingId) or certificate (linkedCertificateNumber).
  • Content Manager İçinde Uygulama Adımları: Open /admin/content-manager/collection-types/plugin::inbox.submission, filter by priority = high, and update the record.

5. Uçtan Uca Kullanım Senaryoları ve İş Akışları

Section titled “5. Uçtan Uca Kullanım Senaryoları ve İş Akışları”

Use Case 1 — Dynamic Public Form Builder & Service-Desk Casework Triage

Section titled “Use Case 1 — Dynamic Public Form Builder & Service-Desk Casework Triage”
  • What it is for: Render multi-step contact, matrimonial, counseling, or volunteer forms on the frontend and triage submissions with SLA priorities and staff checklists.
  • How it works: Fetch form schemas via GET /api/inbox/forms/{slug}, submit via POST /api/inbox/submit (creating plugin::inbox.submission with a referenceCode), and track status via GET /api/inbox/track/{referenceCode}.

Inbox, Forms & Alert Banners — Strapi v5 Admin Workspace

Use Case 2 — Double Opt-In Newsletter & Topic Subscription Management

Section titled “Use Case 2 — Double Opt-In Newsletter & Topic Subscription Management”
  • What it is for: Collect GDPR-compliant newsletter and community topic subscribers with tokenized confirmation and 1-click unsubscribe.
  • How it works: POST /api/inbox/subscribe creates a plugin::inbox.subscriber in pending status; POST /api/inbox/confirm and POST /api/inbox/unsubscribe verify confirmToken / unsubscribeToken (private: true).

Inbox, Forms & Alert Banners — Strapi v5 Settings Panel

Use Case 3 — Time-Bounded Multilingual Site-Wide Alert Banners

Section titled “Use Case 3 — Time-Bounded Multilingual Site-Wide Alert Banners”
  • What it is for: Publish urgent announcements (e.g., Ramadan Hilal sighting, weather closure, live stream alert) in the website header ticker.
  • How it works: Create plugin::inbox.alert-banner records with severity (info, warning, urgent, celebration), startsAt, endsAt, and translations; fetch active banners via GET /api/inbox/alerts.

Inbox, Forms & Alert Banners — Strapi v5 Content Manager Entities

6. REST API Uç Noktaları (content-api ve admin)

Section titled “6. REST API Uç Noktaları (content-api ve admin)”
Metot Uç Nokta Yolu Kapsam Denetleyici (Handler) Kimlik Doğrulama
GET /api/inbox/forms content-api inboxController.listForms Public
GET /api/inbox/forms/{slug} content-api inboxController.getFormBySlug Public
POST /api/inbox/forms/{slug}/submit content-api inboxController.submitForm Public
POST /api/inbox/subscribers content-api inboxController.subscribe Public
GET /api/inbox/subscribers/confirm/{token} content-api inboxController.confirmSubscription Public
GET /api/inbox/subscribers/unsubscribe/{token} content-api inboxController.unsubscribe Public
GET /api/inbox/public/unsubscribe content-api inboxController.unsubscribe Public
GET /api/inbox/alerts content-api inboxController.getActiveAlerts Public
GET /inbox/settings admin inboxController.getSettings Bearer JWT
PUT /inbox/settings admin inboxController.updateSettings Bearer JWT
GET /inbox/templates admin inboxController.listTemplates Bearer JWT
GET /inbox/form-builder-forms admin inboxController.listFormBuilderForms Bearer JWT
POST /inbox/forms/sync-builder admin inboxController.syncFormBuilder Bearer JWT
GET /inbox/forms admin inboxController.listForms Bearer JWT
POST /inbox/forms admin inboxController.saveForm Bearer JWT
POST /inbox/forms/from-template admin inboxController.createFromTemplate Bearer JWT
GET /inbox/submissions admin inboxController.listSubmissions Bearer JWT
PUT /inbox/submissions/{documentId}/casework admin inboxController.updateCasework Bearer JWT
POST /inbox/submissions/{documentId}/schedule-booking admin inboxController.scheduleBooking Bearer JWT
POST /inbox/submissions/{documentId}/issue-certificate admin inboxController.issueCertificate Bearer JWT
GET /inbox/submissions/export-csv admin inboxController.exportCsv Bearer JWT
POST /inbox/captcha/test admin inboxController.testCaptcha Bearer JWT
GET /inbox/subscribers admin inboxController.listSubscribers Bearer JWT
GET /inbox/alerts admin inboxController.getActiveAlerts Bearer JWT
POST /inbox/alerts admin inboxController.upsertAlertBanner Bearer JWT

7. Sunucu Tarafı Programatik Kullanım (strapi.plugin ve strapi.documents)

Section titled “7. Sunucu Tarafı Programatik Kullanım (strapi.plugin ve strapi.documents)”
// Registered services on plugin "inbox": "settings", "formService", "submissionService", "subscriberService", "alertService"
const pluginService = strapi.plugin("inbox")?.service("formService");
// Querying records via the Strapi v5 Document Service API
const records = await strapi.documents("plugin::inbox.alert-banner").findMany({
limit: 25,
sort: "createdAt:desc",
});
  • Yönetim paneli değişiklikleri görünmüyor: config/plugins.ts dosyasını güncelledikten sonra pnpm strapi build komutunu çalıştırın.
  • Strapi bağımlılık izolasyonu: React bağlam çakışmalarını önlemek için pnpm-workspace.yaml içinde hoistPattern: ["*", "!@strapi/*"] ayarını koruyun.
  • Sıkı TypeScript kontrolü: Hem admin hem de server paketlerini doğrulamak için pnpm check komutunu çalıştırın.