nf_documentation_template.html

<!--1. Documentation should include the simplest, most concise way for a new user to run your addon successfully.  -->
<!--2. Use the simplest use case possible for each feature, broken down into easy to digest steps.  -->
<!--3. As a general rule of thumb, no more than two mouse clicks should take place in each distinct step (a choice and save/action, for example).-->
<!--4. If you plugin can handle fringe, advanced use cases you may document these in an "Advanced" section after the simple setup.-->
<!--5. Every single option, filter, or shortcode in your plugin should be documented at the END of the documentation, after the simple set up.  -->
<!--   -You may reference it in the above docs and create an anchor link to your definition, but do not expound on them in the body.-->


<a name="top"></a>
<ul>
	<li><a href="#emails_actions">Emails & Actions</a>
	<ul class="action-contents">
		<li><a href="#shortcodes">Shortcodes</a></li>
		<li><a href="#email_action">Email Actions</a></li>
		<li><a href="#success_action">Success Messages</a></li>
		<li><a href="#redirect_action">Redirect Actions</a></li>
	</ul>
	</li>
</ul>

<h2>Emails & Actions</h2>

<p>You may have noticed that as of version 2.9 we have renamed "Notifications" to "Emails and Actions."  This change was to make the purpose of the tab clearer to a majority of our users. Please read on to see how the new Emails and Actions system works to replace all the various settings.</p>

<p>To create a new Email or Action, first open the form you want to attach the Email or Action to.</p>

<p>You will notice a "Email and Actions" tab at the top of your screen. Open it.</p>

<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/emails-and-actions/file-vktlxint9d.png" /></p>

<p>Next, you will add a new Email or Action with the "Add New" button: </p>

<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/emails-and-actions/file-dky4anogj1.png" /></p>

<p>Choose the type of action you want to add: </p>

<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/emails-and-actions/file-uncvtxduoo.png" /></p>

<p>There are three options for Email and Action types in a default Ninja Forms installation, explained below.</p>

<hr /> <a class="doc-jump" href="#top" name="shortcodes">[Jump to top]</a>

<h3>Emails and Actions: Special Shortcodes</h3>

<h4>Shortcodes in Email & Alerts</h4>
To display all the fields of a form, input the [ninja_forms_all_fields] shortcake into your email or success message.<br />
<br />
<strong>Input:</strong><br />
[ninja_forms_all_fields]<br />
<br />
<strong>Displays:</strong><br />
<img alt="" src="/customer/portal/attachments/463314" style="width: 683px; height: 319px;" /><br />
<br />
If you would like to choose the fields you would like to display you can use the shortcode [ninja_forms_field id=#] where # is the field ID number that contains that data you would like to display.<br />
<br />
<strong>Input:</strong><br />
[ninja_forms_field id=1] [ninja_forms_field id=2]<br />
[ninja_forms_field id=3] [ninja_forms_field id=4]<br />
[ninja_forms_field id=5]<br />
[ninja_forms_field id=6]<br />
<br />
<strong>Displays:</strong><br />
<img alt="" src="/customer/portal/attachments/463316" style="width: 448px; height: 217px;" />
<p>The shortcode can be used on the Form Settings page in the following fields:</p>

<ul>
	<li>Success message</li>
	<li>Administrator email subject</li>
	<li>Administrator email message</li>
	<li>User email subject</li>
	<li>User email message.</li>
</ul>
<strong>Input:</strong><br />
<br />
[nf_sub_seq_num]<br />
 
<p>This will replace the shortcode with the sequential ID number of the submission.</p>

<p>Example:</p>

<blockquote>Hello, User! Your reference number for this submission is  <span style="color: #3d3c40">[nf_sub_seq_num].</span></blockquote>
<strong>Displays:</strong>

<blockquote>Hello, User! Your reference number for this submission is 174 <span style="color: #3d3c40">.</span></blockquote>

<hr /> <a class="doc-jump" href="#top" name="email_action">[Jump to top]</a>

<h3>Email Action</h3>

<p>In Ninja Forms 2.8, email notifications were moved from the "Forms Settings" tab to the "Notifications Tab."</p>

<article><iframe allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/VOxQcm0GCjI" width="560"></iframe>

<ol>
	<li>In your "Notifications" tab, select "Add New" to create a new notification.
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---creating-an-email-message/file-h80r3ho5cz.png" /></p>
	</li>
	<li>Name your notification and select the "E-Mail" notification type
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---creating-an-email-message/file-fp5if4rpjn.png" /></p>
	</li>
	<li>Select your e-mail settings.  <em>A list of e-mail fields from your form will open in a drop down selector to create dynamic notifications.  When the form is submitted, whatever e-mail address was set in these fields by the user will be automatically notified.</em>
	<ul>
		<li>Attach CSV  - Attaches a Comma Separated Value of the form submission to the email which can be opened in a spreadsheet program like Excel, Google Docs, or Number.</li>
		<li>From Name  - The name of the person or organization sending the email.</li>
		<li>From Address  - The Email address of the person or organization sending the email. This should NOT match an address in the "To", "Cc", or "Bcc" fields.</li>
		<li>Reply To  - The e-mail address which will be replied to is a user selects "Reply" from their e-mail client. (NOTE: Some popular e-mail clients, such as GMail, do not respect this setting.)</li>
		<li>To  - The email address(es) of the primary organization or individual who will be receiving the notification. None of these addresses should match the address in the "From Address" field.</li>
		<li>Cc  - The email address(es) of the organization and individual who will be receiving the notification but who are not the primary recipients. Other recipients of this email WILL know that addresses in this field were also sent a copy. None of these addresses should match the address in the "From Address" field.</li>
		<li>Bcc  - The email address(es) of the organization and individual who will be receiving the notification but who are not the primary recipients. Other recipients of this email will NOT know that addresses in this field were also sent a copy. None of these addresses should match the address in the "From Address" field.</li>
		<li>Subject  - The heading/topic of the notification.</li>
	</ul>
	</li>
	<li>Lastly, it is time to populatethe content of our message.  You mayinput whatever message you like into the form, and you can populate dynamic content form the submitted form in a few different ways.
	<ul>
		<li>Add Media- Allows you to add media content from your WordPress Media Library to the content of your email.</li>
		<li>Select a field- Search for the name or ID of your field (or use the drop down selector) to automatically insert a shortcode which will populate your message with data from the form submission</li>
		<li>Insert All Fields  - Creates an editable table at the bottom of your notification with a list of ALL fields and data submitted with the form.For example, with our default contact form, you could create a message like the image here:</li>
	</ul>
	</li>
	<li>For example, a message configured like the one below:
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---creating-an-email-message/file-dxpwpe5l8f.png" /></p>

	<p>Would output a message like this when the person in the "To" field receives your email:</p>

	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---creating-an-email-message/file-vwibq75c9r.png" style="height: auto; vertical-align: middle; border-color: rgb(214, 214, 214);" /></p>
	</li>
</ol>

<hr /><a class="doc-jump" href="#top" name="success_action">[Jump to top]</a>

<h3>Success Message</h3>

<p>In Ninja Forms 2.9, success messages were moved from the "Notifications" tab to the "Emails and Actions" tab.</p>
<iframe allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/ewyTi5E-j9k" width="560"></iframe>

<ol>
	<li>In your "Notifications" tab, select "Add New" to create a new notification.
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---success-message/file-h80r3ho5cz.png" /></p>
	</li>
	<li>Name your notification and select the "Success Message" notification type.  You may also choose to display this before or after the form if your form is not set to disappear after a successful submission (If your form is cleared, this setting does not matter.)
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---success-message/file-uss4skjjey.png" /></p>
	</li>
</ol>

<p>Lastly, it is time to populate the content of our message.  You may input whatever message you like into the form, and you can populate dynamic content form the submitted form in a few different ways.</p>

<ol>
	<li>Add Media - Allows you to add media content from your WordPress Media Library to the content of your email.</li>
	<li>Select a field - Search for the name or ID of your field (or use the drop down selector) to automatically insert a shortcode which will populate your message with data from the form submission</li>
	<li>Insert All Fields  - Creates an editable table at the bottom of your notification with a list of ALL fields and data submitted with the form.For example, with our default contact form, you could create a message like the image here:</li>
</ol>

<p>For example, a message configured like the one below:</p>

<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---success-message/file-dxpwpe5l8f.png" /></p>

<p>Would output a message on your page after the form is submitted like this:</p>

<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---success-message/file-vwibq75c9r.png" /></p>

<p>**Please note that redirects ALWAYS take precedence over success messages.  If you have both a redirect and a success message set, the success message will never display.</p>

<hr /> <a class="doc-jump" href="#top" name="redirect_action">[Jump to top]</a>

<h3>Redirect Action</h3>

<p>In Ninja Forms 2.8, email notifications were moved from the "Forms Settings" tab to the "Notifications Tab."</p>
<iframe allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/kCjhVqz33dU" width="560"></iframe>

<ol>
	<li>In your "Notifications" tab, select "Add New" to create a new notification.
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---redirect/file-h80r3ho5cz.png" /></p>
	</li>
	<li>Name your notification and select the "Redirect" notification type.  You may then add a link to a page on your own site or even somewhere else on the web altogether.  The user will be redirected to this page after successfully completing the form.
	<p><img src="https://desk-customers.s3.amazonaws.com/Toolbelt/migration/wpninjas/actions---redirect/file-fpztln10mo.png" /></p>
	**Please note that redirects ALWAYS take precedence over success messages.  If you have both a redirect and a success message set, the success message will never display.</li>
</ol>
<a class="doc-jump" href="#top" name="shortcodes">[Jump to top]</a></article>