Tài liệu Yuva
Yuva gom email, chat trực tiếp và tin nhắn trong ứng dụng từ khách hàng của bạn vào một hộp thư cho nhóm bạn. Hãy bắt đầu với Bắt đầu; mọi hướng dẫn được liệt kê bên dưới.
Tài liệu này được viết bằng tiếng Anh.
Bắt đầu
Kênh
- E-mailAn e-mail channel gives an inbox a support address. Mail to it opens or continues a conversation, and replies go out from that address in the same thread.
- Web widget<yuva-chat> puts live chat on your website, or a conversation thread inside your own product. It works in any page or framework.
- Mobile SDKsNative SDKs for iOS (SwiftUI) and Android (Jetpack Compose) give your app a conversation list, a thread with attachments and a feedback form.
- Documentation pagesAdd "Was this page helpful?" and a public discussion area to your documentation site. Your pages stay where they are; two web components send ratings and private feedback to the Yuva inbox and show the page's discussions: threads with replies, votes and an accepted answer, like GitHub Discussions.
- Status pagesA status page tells your customers whether your product works: components with a state, incidents, planned maintenance and a history. It belongs to an inbox, so the live chat and the apps of that inbox show an open incident before a customer writes, and the conversations an outage brings can be answered together.
Gửi hàng loạt
- Mailing lists and subscribe formsA mailing list belongs to an inbox and holds the people who agreed to hear from you. Visitors join with a form on your site, your backend adds people it already has consent for, and every change is written to a consent log you can export.
- Importing subscribersBring people who already agreed to hear from you onto a mailing list by uploading a CSV file. Yuva checks every address before it adds anything, and keeps a record of where the people agreed.
- E-mail designs and templatesA design is the look of a mail: blocks such as headings, text, images and buttons, and a theme with colours and fonts. You build it once in the panel, start from one of the templates that ship with Yuva, and use it for your broadcasts. The server turns it into mail HTML that works in the common mail apps, with a plain-text part and a dark mode.
- Sending broadcastsA broadcast is one e-mail sent to the subscribers of your mailing lists: a newsletter, a product update, an announcement. It uses an e-mail design, goes out through one of your inbox's e-mail channels, and a reply to it becomes a conversation in that inbox. Yuva shows what happened afterwards: who got it, who bounced, unsubscribed or replied.
- DeliverabilityWhether your broadcasts reach the inbox depends mostly on the sending domain being set up properly and on people not marking your mail as spam. Yuva has a check that tests the set-up of an e-mail channel by sending it a test mail, and this page shows how to read it and how to fix what it finds.
Phân tích
- AnalyticsYuva Analytics counts the visitors, pages, sources, places and devices of your own websites, without cookies and without keeping IP addresses. It lives in the same panel as your inbox, and its numbers are open through the API.
- Events, goals and funnelsEvents are the things visitors do besides viewing a page: sign up, buy, download a file, follow a link. Send them from your pages or apps, turn the ones that matter into goals to see how many visitors reached them and how much revenue they brought, and chain goals into funnels to see where visitors drop off. This builds on Analytics; install it first.
- Analytics in appsThe Swift and Kotlin libraries count screens, events and revenue of your iOS and Android apps in the same analytics property as your website, without cookies, advertising ids or anything that follows a person from one launch to the next. This builds on Analytics; add the property there first.
- Server-side eventsSome things only your backend sees: an account that was created, a payment that went through, a subscription that renewed. Your server can send them to an analytics property, and an event that carries the visitor's address and browser joins that visitor's visit on your website. This builds on Analytics and the event rules in Events, goals and funnels.
- Sharing and exporting analyticsA share link shows part of a website's numbers to people who have no Yuva account, read-only, and can sit in an iframe on your own pages. An export writes a website's numbers or raw events to a file you download. Both belong to a website of Yuva Analytics; the API calls it a property.
- Support and trafficLink a website of Yuva Analytics to an inbox and its pages show how much support they lead to: conversations, page feedback, ratings and discussions, counted per page and day next to the page's views. The same numbers feed insights, alerts, weekly and monthly e-mail reports and the analytics tools of AI assistants. Yuva runs no model for any of it: every insight and alert is a fixed rule you can read below.
- Consent featuresBy default Yuva Analytics cannot recognise a visitor from one day to the next (Analytics and privacy). Consent features change that for visitors who agreed: with their yes, your site or app keeps a random id on their device, and you get returning visitors, retention, funnels that run over several days and, for signed-in users, their recent visits on their contact page. Everyone who did not agree is counted exactly as before.
- Analytics and privacyThis page says what Yuva Analytics keeps about your visitors and for how long, whether your website needs a cookie banner, and gives you text for your privacy notice. It is information with sources, not legal advice; laws differ by country and change, so check your own situation with a lawyer or your data protection authority.
- Data processing for AnalyticsIf a Yuva server is run for you by someone else (a hosted service), that operator processes your visitors' data when you use Analytics. This is the outline of the agreement that Article 28 of the GDPR asks for between you and the operator. It is a starting point to adapt with your lawyer, not legal advice, and not a signed contract. On your own server you are the controller and nobody processes the data for you, so you need none of this.
Chuyển sang Yuva
- Move to YuvaBring the history of the mailbox you answer from today into a Yuva inbox, then switch its mail over. Yuva only reads the old mailbox: nothing in it is changed or deleted, and your team keeps working meanwhile.
- Move from GmailCopy the history of a Gmail mailbox (an address ending in @gmail.com) into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva; on a work or school address, use the Google Workspace guide.
- Move from Google WorkspaceCopy the history of a Google Workspace mailbox (your own domain on Gmail) into Yuva and send its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva; for an address ending in @gmail.com, use the Gmail guide.
- Move from Outlook.comCopy the history of an Outlook.com, Hotmail, Live or MSN mailbox into Yuva and send its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva; for a work or school mailbox use the Microsoft 365 guide.
- Move from Microsoft 365Copy the history of a Microsoft 365 (Exchange Online) mailbox into Yuva and send its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva; for Outlook.com, Hotmail and Live use the Outlook.com guide.
- Move from Outlook.com or Microsoft 365Both connect with "Sign in with Microsoft", but the steps differ. Pick the guide by the address of the mailbox:
- Move from YandexCopy the history of a Yandex Mail mailbox into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from iCloud MailCopy the history of an iCloud Mail mailbox into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from Zoho MailCopy the history of a Zoho Mail mailbox into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from Yahoo MailCopy the history of a Yahoo Mail mailbox into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from FastmailCopy the history of a Fastmail mailbox into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from GMX or mail.comCopy the history of a GMX or mail.com mailbox into Yuva and forward its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from ZendeskCopy the tickets of a Zendesk Support account into Yuva and send its support address to Yuva. Yuva only reads Zendesk. The overview is in Move to Yuva.
- Move from Help ScoutCopy the conversations of a Help Scout account into Yuva and send its support address to Yuva. Yuva only reads Help Scout. The overview is in Move to Yuva.
- Move from any IMAP serverCopy the history of a mailbox on any server that speaks IMAP into Yuva and send its new mail there. Yuva only reads the mailbox. The overview is in Move to Yuva.
- Move from an export fileBring the history of a mailbox into Yuva from a file you exported, without giving Yuva any access to the account. This suits a very large mailbox, a program that has no IMAP, or an account Yuva cannot sign in to. The overview is in Move to Yuva.
- Move to Yuva for operatorsHow to run Move to Yuva on your own server: the forwarding domain, the settings, what to check to trust that the old mailbox is only read, and the limits for a server shared by many workspaces. IMAP mailboxes are the only source built so far.
Nhà phát triển
- Identity tokensAn identity token lets a user who is signed in to your app chat as themselves in the widget or the mobile SDKs. Your backend signs it; Yuva never sees your users or passwords.
- WebhooksYuva sends your backend a signed HTTP request when something happens, so you can send pushes, sync contacts or automate. Requests follow Standard Webhooks.
- HeadlessEverything the panel and the widget do is open to your own code: your own inbox on /v1, your own chat on the contact API, or a bot that answers with drafts. Working code is in examples/, MIT licensed.
- AI assistants (MCP)Yuva has a built-in MCP server. Assistants such as Claude, ChatGPT, Cursor, VS Code and Gemini CLI can search your inbox, read and triage conversations and draft replies, with the access you give them.
- Tài liệu tham khảo APIMọi endpoint và sự kiện webhook của Yuva, được tạo từ hợp đồng OpenAPI 3.1.
Tự lưu trữ
- ConfigurationYuva reads its settings from environment variables when it starts. A wrong value stops the server with a message that names the variable.
- OperationsHow to upgrade, back up, restore and watch a Yuva server. The examples use the Compose setup from the install guide and run from its directory.
Dự án
- ArchitectureYuva is one place to answer every user of every product you run: e-mail, live chat on websites and panels, and private in-app conversations in mobile apps. It is a single Go binary and a Postgres database.
- RoadmapEach milestone is a GitHub issue. A milestone is done when every acceptance item is shown working on a running instance, not when the code exists.