We reccomend the hosted version of selfmail to get started with our app. You can create a new account at the register page, we recommend to use a private or company mail address. After that, you can either join a workspace with an invitiation link or create a new one.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Selfmail","colors":{"primary":"#36b3e0","light":"#f1f1f1","dark":"#303030"},"logo":{"light":"https://mintcdn.com/selfmail-dc016b8c/aMdpF-DmfBgaSc3G/logo/light.svg?fit=max\u0026auto=format\u0026n=aMdpF-DmfBgaSc3G\u0026q=85\u0026s=6e057d5a665db430ad7b8e523c678528","dark":"https://mintcdn.com/selfmail-dc016b8c/aMdpF-DmfBgaSc3G/logo/dark.svg?fit=max\u0026auto=format\u0026n=aMdpF-DmfBgaSc3G\u0026q=85\u0026s=67bea45bbfcf645b02d0f38990c5507f"},"favicon":"/favicon.svg","navbar":{"links":[{"label":"Support","href":"mailto:support@selfmail.app"}],"primary":{"type":"button","label":"Home","href":"https://selfmail.app"}},"footer":{"socials":{"github":"https://github.com/selfmail/selfmail"}},"fonts":{"heading":{"family":"Geist","weight":600},"body":{"family":"Geist","weight":400}},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"selfmail-dc016b8c","hasAudioNarration":false,"actualSubdomain":"selfmail-dc016b8c","customDomains":["docs.selfmail.app"],"gitSource":{"type":"github","owner":"selfmail","repo":"selfmail","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20cc0de1e469eb7f72e3d2","collectionId":"bd744c28-0216-4df0-8825-f1ba10311d05","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{},"buildId":"6ac55653ae66c343c58bc00f:failure","clientVersion":"0.0.3939","searchFilterCounts":[{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Platform","count":3},{"language":"default","tag":"First Steps","count":2},{"language":"default","tag":"Developers","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"platform","slug":"/platform","pageMetadata":{"title":"Selfmail","description":"Basic knowdlege to start with Sefmail.","href":"/platform/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Basic knowdlege to start with Sefmail.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`get-started-with-selfmail`,children:`Get Started with Selfmail`}),`\n`,_jsxs(_components.p,{children:[`We reccomend the `,_jsx(_components.a,{href:`https://dashboard.selfmail.app`,children:`hosted version of selfmail`}),` to get started with our app. You can create a new account `,_jsx(_components.a,{href:`https://dashboard.selfmail.app/auth/register`,children:`at the register page`}),`, we recommend to use a private or company mail address. After that, you can either join a workspace with an invitiation link or create a new one.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Selfmail","description":"Basic knowdlege to start with Sefmail.","href":"/platform/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Get Started with Selfmail","slug":"get-started-with-selfmail","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"selfmail-dc016b8c","siteName":"Selfmail","title":"Selfmail - Selfmail","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-30T12:53:49.286Z","originalFileLocation":"platform/index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Basic knowdlege to start with Sefmail.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Selfmail\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Selfmail - Selfmail\">\u003cmeta data-mint-head property=\"og:description\" content=\"Basic knowdlege to start with Sefmail.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Selfmail\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.selfmail.app/platform\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://selfmail-dc016b8c.mintlify.app/_mintlify/api/og/v2?division=Platform\u0026amp;title=Selfmail\u0026amp;description=Basic+knowdlege+to+start+with+Sefmail.\u0026amp;theme=5bf835f9bf78621d93633e38\u0026amp;signature=5e93cc829aa600867348bccf1376dcae404acbf94162b024069ca6c6229d61f3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Selfmail - Selfmail\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Basic knowdlege to start with Sefmail.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://selfmail-dc016b8c.mintlify.app/_mintlify/api/og/v2?division=Platform\u0026amp;title=Selfmail\u0026amp;description=Basic+knowdlege+to+start+with+Sefmail.\u0026amp;theme=5bf835f9bf78621d93633e38\u0026amp;signature=5e93cc829aa600867348bccf1376dcae404acbf94162b024069ca6c6229d61f3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/selfmail-dc016b8c/8HmPwEDCWlWrmzxF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Selfmail\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36b3e0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.selfmail.app/platform\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.selfmail.app/#organization\",\"name\":\"Selfmail\",\"url\":\"https://docs.selfmail.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/selfmail-dc016b8c/aMdpF-DmfBgaSc3G/logo/light.svg?fit=max\u0026auto=format\u0026n=aMdpF-DmfBgaSc3G\u0026q=85\u0026s=6e057d5a665db430ad7b8e523c678528\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.selfmail.app#website\",\"name\":\"Selfmail\",\"url\":\"https://docs.selfmail.app\",\"publisher\":{\"@id\":\"https://docs.selfmail.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.selfmail.app/platform#webpage\",\"url\":\"https://docs.selfmail.app/platform\",\"name\":\"Selfmail\",\"description\":\"Basic knowdlege to start with Sefmail.\",\"dateModified\":\"2025-09-30T12:53:49.286Z\",\"isPartOf\":{\"@id\":\"https://docs.selfmail.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.selfmail.app/platform#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.selfmail.app/platform#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.selfmail.app/platform/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Selfmail\",\"item\":\"https://docs.selfmail.app/platform\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.selfmail.app/platform#article\",\"headline\":\"Selfmail\",\"name\":\"Selfmail\",\"description\":\"Basic knowdlege to start with Sefmail.\",\"url\":\"https://docs.selfmail.app/platform\",\"mainEntityOfPage\":{\"@id\":\"https://docs.selfmail.app/platform#webpage\"},\"dateModified\":\"2025-09-30T12:53:49.286Z\",\"publisher\":{\"@id\":\"https://docs.selfmail.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.selfmail.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Selfmail\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Selfmail","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"First Steps","pages":[{"title":"Selfmail: The open-source email provider for businesses.","icon":"book-open-text","sidebarTitle":"Introduction","href":""},{"title":"Quickstart","description":"Start building awesome documentation in minutes","icon":"rocket","href":"/quickstart"}]},{"group":"Platform","pages":[{"title":"Selfmail","href":"/platform/index"},{"title":null,"description":null,"href":"/platform/navigation"},{"title":null,"href":"/platform/members"}]},{"group":"Developers","pages":[{"title":"Starting","icon":"braces","href":"/dev/index"}]}]}]},"title":"Selfmail - Selfmail","buildId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","deploymentId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","dynamics":[],"chunks":[]}
