Vanilla Pop - Forum Email Interaction - HL Vanilla Community
<main> <article class="userContent"> <p><span class="safeEmoji nativeEmoji">🚧</span> This feature is in Maintenance and will be replace with Notification Improvements in the future. <span class="safeEmoji nativeEmoji">🚧</span> </p><p>Vanilla Pop is a feature of Vanilla’s Enterprise forums that allows you to interact with your forum through email.</p><p>With Vanilla Pop you can:</p><ul><li>Reply to an emailed discussion on the community or through email.</li><li>Have conversations through email, but keep a record on Vanilla.</li></ul><h2 data-id="your-forums-email-address">Your Forum’s Email Address</h2><p>The top of the page tells you your forum’s email address. This is the address that the application will send emails to, in order to interact with your forum. This email may not be the email address you want to show your users, so you should forward all emails from the address that you want to share. </p><p><strong>Important: Make sure your outgoing email address is the same as the one that forwards to your forum’s email address or else email replies will not work.</strong></p><h3 data-id="email-directly-into-a-category">Email Directly into a category</h3><p>You can also set up additional email addresses to forward to individual categories. To do this forward email to the appropriate categorycode, using the following syntax: categorycode.forumname@vanillacommunity.email.</p><p>The “categorycode”, is the URL Slug of the category.</p><h2 data-id="vanilla-pop-settings">Vanilla Pop Settings</h2><p>When you have Vanilla Pop enabled you will see an <strong>Incoming Email</strong> item in your dashboard under Site Settings. The page looks like this:</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/859/Y7E40WQKNJZD.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/859/Y7E40WQKNJZD.png" alt="image.png" height="556" width="786" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><br></p><p>Let’s run down the settings one by one:</p><h3 data-id="default-category">Default Category</h3><p>Emails that are sent to your forum will start a new discussion. These discussions will be put into the category you specify here. We recommend using roles & permissions to limit the visibility of this category to just moderators and administrators. (Usually people that email you don’t expect their email to be publicly viewable to the world.) The choice is up to you, though.</p><h2 data-id="allow-users-to-be-registered-through-email">Allow Users to be Registered through Email</h2><p>When a user emails your forum, we check their email address to see what user to post as. If there is no user associated with that email address then a new user is created. This is fine in cases where you are handling support requests through email, but it may not be fine in more tightly-knit communities. Use this setting to control whether or not new users can be registered by sending their first email.</p><h3 data-id="add-information-to-the-from-field-in-email-addresses-to-help-with-replies">Add Information to the From Field in Email Addresses to Help with Replies</h3><p>If you enable this setting, information is added to the from field of email sent from the forum. This is done by adding a plus (+) sign and code before the @ symbol in the email address. We recommend this option because some devices, such as Blackberry, don’t send correct header information with their emails. Disable this option if your email server doesn’t allow the plus signs.</p><h3 data-id="outgoing-email-address">Outgoing Email Address</h3><p>This is the email address that shows up in the from field of email sent from the forum. This is also the email address that people will reply to.</p><h3 data-id="email-content">Email Content</h3><p>You can modify the content included in your Vanilla Pop emails, some of the items:</p><ul><li>{Category.Name} = Includes the Category Name</li><li>[{Title}] = Includes Discussion Title</li><li>{Body} = Includes Content of the item</li></ul><p><strong>This feature is only available on Vanilla Cloud</strong></p><p><a href="https://vanillaforums.com/" rel="nofollow noreferrer ugc"><strong>Learn More...</strong></a></p><h2 data-id="vanilla-pop-with-site-hub">Vanilla Pop with Site Hub</h2><p>Vanilla Pop works in much the same way on the hub as it does on regular sites. The node email addresses are slightly different and there are a few more features which are detailed below.</p><h2 data-id="node-email-addresses">Node Email Addresses</h2><p>Each node’s email address is comprised of two parts: The node slug and the hub slug separated by a dot, followed by a vanillaforums.email domain. You can see this by going to the <strong>Incoming Email</strong> page in your nodes’ dashboards.</p><h3 data-id="example">Example</h3><p>Let’s say you are on the <strong>acme</strong> hub and you create a node with the slug <strong>anvil</strong>. You will see that the node’s email address will be shown as <code class="code codeInline" spellcheck="false" tabindex="0">anvil.acme@vanillaforums.emal</code>.</p><h3 data-id="emailing-directly-into-a-category">Emailing Directly Into a Category</h3><p>You can email directly into a category by prepending the category’s URL code to the node’s email address followed by a dot.</p><h3 data-id="example-1">Example</h3><p>Let’s say in the above example you want to email the <strong>general</strong> category. You would send an email to <code class="code codeInline" spellcheck="false" tabindex="0">general.anvil.acme@vanillaforums.email</code>.</p><h2 data-id="using-one-email-address-for-an-entire-hub">Using One Email Address for an Entire Hub</h2><p>The hub provides a flexible way to email any node and even any category within a node. However, let’s say you want to set up a single email address for your entire hub and have emails route into the nodes.</p><p>Each hub can use an abbreviated email address and then make use of the email subject to route the email to the correct node. If you want to do this then the email address for your entire hub is the hub slug followed by the vanillaforums.email domain. Then the first word of the subject will be matched against a node and optional category. You can optionally enclose the first word in square brackets.</p><h3 data-id="example-2">Example</h3><p>From the above examples, you have the <strong>acme</strong> hub, and the <strong>anvil</strong> node, and the <strong>general</strong> category.</p><ul><li>The hub’s email address is <code class="code codeInline" spellcheck="false" tabindex="0">acme@vanillaforums.email</code></li><li>An email with the subject <code class="code codeInline" spellcheck="false" tabindex="0">[anvil] I need some help</code> will be routed to the anvil node.</li><li>An email with the subject <code class="code codeInline" spellcheck="false" tabindex="0">[general.anvil] I need some help</code> will be routed to the general category of the anvil node.</li></ul><h3 data-id="removing-the-node-slug-to-email-categories">Removing the Node Slug to Email Categories</h3><p>You can have your hub configured to remove the need for node slugs in the subject of emails. To do so you must do the following:</p><ol><li>Ensure that you use unique URL codes across all of your nodes. This is your responsibility.</li><li>Make a support request to configure your hub to look at the category of a node first.</li></ol><h3 data-id="setting-up-a-custom-email-address-for-your-hub">Setting Up a Custom Email Address for Your Hub</h3><p>The reason why the hub supports a single email address is to allow you to set up a single custom email address for your communities and then use the subject to route emails accordingly. In order to do so you must have control over the email address and then you must do the following:</p><ol><li>Set up your email address to forward all emails to the hub’s email address.</li><li>Make a support request notifying Vanilla staff of your forward. Tell them what the email address is and they will configure your hub to send emails from that address.</li></ol><p>In order to make the email forwarding work you must ensure the following:</p><ol><li>The emails must not be altered when being forwarded (ex. don’t add a “Fw: “ prefix to the subjects).</li><li>In order to ensure the best email routing the email should re-add any arguments<strong> </strong>in the email address to the forum’s email address. This is common behaviour amongst most email servers. For example, if the email is being sent to <code class="code codeInline" spellcheck="false" tabindex="0">john@example.com </code>then the email address is <code class="code codeInline" spellcheck="false" tabindex="0">john@example.com</code> and <code class="code codeInline" spellcheck="false" tabindex="0">1234</code> are the arguments.</li></ol><h2 data-id="email-replies-and-hub-email-addresses">Email Replies and Hub Email Addresses</h2><p>Most emails sent to your communities will be in reply to a notification such as a comment or a private message. In this case Vanilla adds special routing information to help make sure the reply is routed to the correct community. In this case this information will take precedence over the specific email address. In most cases users will not know this, but if you specifically try and alter an email address when replying to try and make the email send to a specific community, you might still find that the email still goes to its originally intended destination.</p><h2 data-id="emailing-to-a-non-existant-node">Emailing to a Non-Existant Node</h2><p>If your email address or subject is malformed in such a way that Vanilla cannot find the node you are trying to email then it will send back a response telling you that the site you are trying to email could not be found.</p> </article> </main>