Sugar's Emails module stores copies of email messages that have been sent from or archived to Sugar. While Sugar is not primarily an email application, it does allow users to send email using their personal email address or a system account and to archive copies of messages and attachments sent or received through a third-party email application.
This documentation will cover how to send and archive email messages and how to use the following modules:
In the Email Signatures, Email Templates, and Outgoing Email Accounts modules, you can view only the records that you have created with the exception of the system email account, which may be visible in the Outgoing Email Accounts list view. In the Emails module, you can search for and view emails that you have archived to Sugar or that have been archived by other users as allowed by your team membership, user access type, and assigned roles. Emails that are in a Draft status can only be seen by the created-by user and administrators. For more information on teams and roles, please refer to the Team Management and Role Management documentation in the Administration Guide.
Note: There are three types of outgoing email accounts in Sugar: system, user, and default user. This document focuses primarily on the user email account and the default user email account. For more information about the system email account and additional details on administering user email accounts, please refer to the Email documentation in the Administration Guide.
Sending and Receiving Email in Sugar
Emails sent from Sugar are automatically archived in Sugar and related to records that match the email addresses in the message. To send emails through Sugar, users must configure their default user email account via Email Settings. Users may add additional outgoing email accounts (e.g. work email, home email, school email) if the Administrator has enabled this option in Admin > System Email Settings.
Alternatively, the Administrator may choose to allow users to send email using the system email account via the option in Admin > System Email Settings (this is not common). In this scenario, users will not be able to configure their default email account and must instead utilize the system email account or create a new user email account. Users will see the system email account in the Outgoing Email Accounts list view with an asterisk to indicate that it is a system account.
Because Sugar is not an email application, users cannot receive email directly to Sugar via their user email accounts. Instead, users must archive emails they receive using one or more of the techniques listed in the Archiving Emails section of this page.
The Emails module contains email records, which are copies of the emails that have been sent from or archived to Sugar. Users can view, sort, filter, and favorite email records according to their team and role memberships even if the emails have been sent or archived by a different user.
For basic use and navigation of the emails module, please refer to the Working With Emails section, which contains links to the User Interface documentation for behaviors that are common among most Sidecar modules. More information is available on email-specific functionality such as sending, replying, archiving, and composing emails in the sections under the Composing Emails header below.
The Emails module contains the following fields:
|Assigned To||The Sugar user assigned to the email record||By default, the Assigned To user is the user who creates and sends the message. For messages saved as drafts, the Assigned To user is the only users who will be able to edit and send the draft later.|
|Attachments||Any attachments included with the email||For more information, please refer to the Adding Attachments section of this page.|
|Body||The content of the email message
||There is no label for this field in the application. The body of your message is composed in the TinyMCE text editor window. For more information on how to use the text editor, please refer to the User Interface documentation in the Application Guide.|
|Date||The date the message was sent, received, or modified, depending on the email's status and direction||
|From||The email address that the email was or will be sent from||This field shows your available outgoing email accounts and determines the From name and From address that the recipient(s) will see.|
|Inbound Account||The incoming email account that received the email||Not visible on record views, the Inbound Account field is available only for filtering the Emails list view.|
|Number of Attachments||An integer representing the quantity of individual files that are related to the email record as attachments||Not visible on record views or as a list view column, the Number of Attachments field is available only as an available filter field in the Emails list view.|
|The fields that contain email addresses of the email recipients||
For more information, please refer to the Working With Recipient Fields section of this page.
|Related To||The module and record that is related to this email||The email will be listed in a subpanel under its "Related To" record.|
The state of the message:
|Sugar does not differentiate between sent and received emails via the Status field, but users can find messages by direction using the "My Sent" and "My Received" filters in the Emails list view.|
|Subject||The subject line for the email message|
|Tags||User-created keywords that can be used to identify records in filters, dashlets, and reports||For more information on creating and using tags, please refer to the Tags documentation.|
|Teams||The Sugar team(s) whose users have access to the email record according to their role permissions|
Working With Emails
The following links open specific sections of the User Interface documentation where you can read about views and actions that are common across most Sidecar modules. The sections following the Working With Emails section describe email-specific behaviors and functionality.
|Emailing Sugar Records
Emailing via Emails Module
Emailing via Quick Create
Once an outgoing email account has been properly configured, Sugar allows users to compose email messages in the application and send them to recipients. Emails composed in Sugar utilize rich-text formatting utilizing the TinyMCE text editor.
The links to the left will take you to the corresponding section of the User Interface documentation where you can learn about the various ways to send emails to records in Sugar.
Viewing via List View
Viewing via Record View
Viewing via Recently Viewed
Viewing via Dashlets
Viewing via Activity Streams
Viewing via Preview
Viewing via Reports
The Viewing Records section describes the various methods of viewing archived email records, including via the Emails list view and record view, the Recently Viewed menu in the Emails module tab, list view dashlets showing email information, Activity Stream entries concerning email updates or where a user mentions an email, previewing emails in the right-hand side panel, and reports displaying email data.
|Searching for Emails
List View Search
Creating a Filter
Saving a Filter
The Searching for Records section provides an introduction to the two searching methods for locating emails: global search, which searches across all Sugar modules, and list view search, which searches and filters within the Emails module.
|Emails List View
Total Record Count
List View Search
Mass Actions Menu
Record Actions Menu
|The List View section walks through the many elements of the Emails List View layout which contains a filterable list of all email records in Sugar. While the generic menu options are described in the User Interface sections linked to the left, the options specifically available in the Emails list view are described in the List View Mass Actions Menu and List View Record Actions Menu sections of this page.|
|Emails Record View
Next or Previous Record
Related Record Subpanels
|The Record View section walks through the many elements of the Emails Record View layout which contains detailed information about a single email record. While the generic menu options are described in the User Interface sections linked to the left, the options specifically available in the Emails record view are described in the Record View Actions Menu section of this page.|
|The Editing Records section describes the various methods of editing existing email records, including inline via the Emails record view, in full edit mode on the record view, inline via the Emails subpanel on related module records, inline via the Emails list view, and via the Mass Update option on the list view. The Editing Fields section provides instructions for modifying the different field types available in Sugar records.
Note: Users cannot edit an email's content, dates, or recipients once it has been archived. Users with appropriate role permissions can, however, edit the Assigned To, Teams, Related To, and Tags fields for archived emails.
Deleting via Record View
Deleting via List View
Mass Deleting via List View
|The Deleting Records section describes the various methods of deleting unwanted emails, including via the Emails record view, an individual record's Actions menu on the Emails list view, and the Mass Actions menu on the list view.
Note: Deleting an email will also delete any attachments for the email from the Notes module. To preserve attachments, download and save email attachments either locally or into the Sugar Documents module before deleting an email.
|Exporting Emails||The Exporting Records section provides an introduction to the export functionality which allows you to download a list of emails and all their data as a .csv file for use outside of Sugar (e.g. in Microsoft Excel).|
Favoriting via List View
Favoriting via Record View
Favoriting via Subpanel
|The Favoriting Records section describes the various methods of marking emails as favorites, including via the Emails list view, Emails record view, or any Emails subpanel appearing on the record view of a related module. Favoriting an email allows you to easily access it from list views, dashlets, or the Emails module tab.|
The Emails module contains various options and functionality which are available via menus in the module tab, list view, and record view. The following sections present each menu and their options with links to more information about each option in the User Interface documentation or, for emails-specific functionality, within this page.
Emails Module Tab Menu
The Emails module tab is typically located under the More tab on the navigation bar at the top of any Sugar screen. Depending on your settings, you may have to click "Show More" in order to see the Emails module tab. Click the tab to access the Emails list view. You can also click the triangle on the Emails module tab to display the Actions and Recently Viewed menus. The Actions menu allows you to perform important actions within the module. The Recently Viewed menu displays the list of emails you last viewed in the module.
The Actions menu allows you to perform the following operations:
|Compose Email||Opens the composition layout to compose and send a new email message or, optionally, save the message as a draft|
|Create Archived Email||Opens the composition layout to create a historical record of an email message that was sent or received outside of the Sugar application|
|View Emails||Opens the Emails list view to search and display email messages|
|Create Email Template||Opens the Email Templates edit view layout to create a new email template|
|View Email Templates||Opens the Email Templates list view to search and display email templates|
|Create Email Signature||Opens the composition layout to create a new email signature|
|View Email Signatures||Opens the Email Signatures list view to search and display email signatures|
|Email Settings||Opens the Outgoing Email Accounts list view to display, edit, and create email accounts|
If you do not see the Emails module tab in Sugar, please check the following:
- The Emails module may be marked as hidden in your user preferences which will prevent the module tab from being displayed. Navigate to your user profile, click the Advanced tab, and check the Layout Options section. If you see the Emails module in the Hide Modules list, simply move it to the Display Modules list and save. For more information on hiding and displaying modules, please refer to the Layout Options section of the Getting Started documentation.
- The administrator may have disabled the Emails module for your entire Sugar instance. Reach out to your Sugar administrator to have the Emails module displayed. For more information on displaying and hiding modules throughout Sugar, please refer to the Developer Tools documentation in the Administration guide.
List View Menus
The Emails list view displays all email records and allows for searching and filtering to locate specific emails. You can view the basic details of each record within the columns of the list view or click an email's name to open the record view. To access a module's list view, simply click the module's tab in the navigation bar at the top of any Sugar page.
List View Mass Actions Menu
The Mass Actions menu allows you to perform mass actions on all currently selected records. You can use the checkbox on each record's row to select individual email records or click the checkbox in the list header to select all records displayed on the current set of list view results.
The Mass Actions menu allows you to perform the following operations:
|Mass Update||Mass update one or more email records at a time|
|Delete||Delete one or more emails at a time|
|Export||Export one or more email records to a CSV file|
List View Record Actions Menu
The Record Actions menu to the far right of each record's row allows you to perform actions on the individual email directly from the list view.
The list view's Record Actions menu allows you to perform the following operations:
|Preview (Eye icon)||Preview this email in the intelligence pane|
|Edit||Edit this email|
|Delete||Delete this email|
Record View Actions Menu
The Emails record view displays a single email in full detail including its fields, subpanels of related records, and activity stream. To access an email's record view, simply click a hyperlinked email subject from anywhere within Sugar. The record view's Actions menu appears on the top right of the page and allows you to perform various operations on the current record.
The Actions menu allows you to perform the following operations:
|Reply||Respond to the sender of this email|
|Reply All||Respond to the sender and all other recipients of this email|
|Edit||Edit this email|
|Delete||Delete this email|
When a copy of a sent or received email message is stored in Sugar, it is considered an archived email. Users cannot edit an email's content, dates, or recipients once it has been archived. Users with appropriate role permissions can, however, edit the Assigned To, Teams, Related To, and Tags fields for archived emails.
Note: Assignment notifications, password-reset emails, scheduled reports, and workflow emails sent from Sugar will not be stored in Sugar as archived emails.
There are several ways that emails may be archived in Sugar, including:
- Manually creating an archived email via "Create Archived Email"
- Composing and sending an email from Sugar via the Emails module
- Sending an email campaign via the Campaigns module
- Receiving a message to a Group Inbound Email account in Sugar
- Archiving emails via the Sugar Email Archiving service (a.k.a. "SNIP")
- Archiving emails via a connector, third-party application, or API (e.g. MS Outlook Plug-in, Collabspot)
Note: When an email record is archived to Sugar, the service that imports the email may set the Teams field for the email record. If the team is not set at the time of archive, the email's team will default to "Global". Users with the appropriate permissions may update the Teams field after the email has been archived in Sugar.
Manually Creating Archived Emails
Users who do not have an email account configured in Sugar or who would like to log an email that was not automatically archived can manually create copies of email messages for archival purposes. To create an archived email in Sugar, navigate to the Emails module and select "Create Archived Email" from the Emails module tab menu. Alternatively, navigate to the record that you would like to relate to the archived email and select "Create Archived Email" from the record's History dashlet.
The email composer window will open where you can manually copy the contents of an email you have already sent or received outside of Sugar. When creating an archived email, the Send button is hidden. Instead, there is an Archive button, which allows the user to log the message without actually transmitting it.
In addition to completing the standard email fields, indicate the date and time that the email was sent or received in the fields labeled "Date Sent". After copying the contents of the message you want to archive, click the "Archive" button to save the record in Sugar.
Please note that, like other archived emails in Sugar, you cannot edit the message's content, dates, or recipients once it has been archived. Users with appropriate role permissions can, however, edit the Assigned To, Teams, Related To, and Tags fields for archived emails.
There are several places in Sugar where you may create an email message, but this section focuses on the composition elements of the email message such as recipients, attachments, templates, and signatures. For more information on places you can create emails in Sugar, please refer to the User Interface documentation.
Working With Recipient Fields
Sugar allows multiple recipients for an email message using the To, Cc, and Bcc fields. To send a message, at least one of the three recipient fields must contain at least one valid recipient. For example, a user may send a message with recipients in only the Bcc field if they want to hide the recipients' email addresses from each other.
To include Cc or Bcc recipients, click the "Cc" or "Bcc" button to expand the recipient field. You can click the buttons again to hide them or simply click another area of the record such as the Body or Subject field.
Note: When composing email messages via Quick Create, Sugar will automatically hide the recipient form fields and populate the message's "To" and "Related To" fields with the name and email address of the record you are viewing. To edit or override the default recipient, click directly on the hard-coded name above the Subject field and the area will transform into the standard From/To/Cc/Bcc form seen in the image above. For more information, please refer to the User Interface documentation.
You can type email addresses directly in the recipient fields or look up recipients in the Address Book. For more information, please refer to the Freehand Address Entry and Using the Address Book sections of this page. When adding recipients, keep in mind the following tips for working with recipient fields:
- To select a recipient, click the recipient's pill in the recipient field and it will turn blue to indicate that it is in a selected state.
- To select multiple recipients within the same field, hold down the Shift or Command key then click the desired recipient pills.
- To move one or more recipients between the To, Cc, and Bcc fields, select the recipient(s) and drag your selection from one field to the other.
- To remove recipients from the message altogether, click the x inside the recipient's pill or select the recipient(s) and press the Delete key on your keyboard.
- To deselect recipient(s), click the blank space inside the field.
Using the Address Book
You can search across modules using the Address Book in the Emails module, which aggregates the users, contacts, leads, targets, and accounts in Sugar that have at least one valid email address.
To access the address book, click on the address book icon next to the recipient field you are working with.
You can search for and select multiple recipients from the Address Book and filter the Address Book's list view to restrict results to a specific module such as contacts or users.
You can also tap into the Address Book by typing a first name, last name, email address, or account name directly in any of the recipient fields on the email message. Sugar will find potential matches as you type and you can select the correct recipient from the suggestions. Each matching recipient option will display a badge that indicates which module contains the record (e.g. "Le" for Leads).
Freehand Address Entry
In addition to using the address book, you may choose to click inside any of the recipient fields and type one or more email addresses freehand. Email addresses do not need to be stored in Sugar to be used as email recipients. If an email address already exists in the database, then Sugar will find it as you type and you can select it from the suggestions. If the email address is not yet stored in the database, then simply hit the Enter key to commit the new address to the recipient field.
Note: Sugar validates email addresses on-the-fly and warns the user when an invalid email address has been entered.
Sugar allows you to send attachments along with your email. Attachments can be files from your local computer or documents from within Sugar. Any user who has permission to view the email record can also access attachments for the message. To include an email attachment, simply click on the Attachment icon in the toolbar:
The Attachment menu provides two options:
- Upload From Local : Opens your system's file navigator so you can find and attach a file that is saved on your computer
- Sugar Document : Opens the Search and Select screen so you can search for a file in Sugar's Documents module
Note: File attachments from your computer are stored in the Notes module, so you must have permission to create notes in order to upload attachments. If you do not have permission to create notes, the Attachment option will be hidden. Similarly, users who do not have role permission to view records in the Documents module will not see the "Sugar Document" attachment option. For more information on configuring roles in Sugar, please refer to the Role Management documentation in the Administration Guide.
After selecting the documents you want to attach to the message, they will appear under the body field of the email message.
Each attachment will display an approximate file size in parentheses next to the file name. If the file you are attaching exceeds or causes the total size of attachments on the message to exceed the system's maximum upload size, the attachment will fail to upload. For more information on configuring the system's maximum upload size, please refer to the System documentation in the Administration Guide.
To remove an attachment before sending a message, simply click on the x next to the attachment's name.
When viewing draft and archived emails in list view, a paper clip icon next to a record's subject will indicate that the email contains one or more attachments. You can download an archived email's attachments from the email record's preview or from record view by clicking on the file name.
Using a Template
Email templates can save time and reduce errors when composing common email messages. For more information on how to create an email template, please refer to the Email Templates section of this documentation.
As a best practice, send templates that contain variables to a single recipient only. If the template has any variable fields defined in it (i.e. $contact_name), Sugar will replace the variables with corresponding values from a related record. If multiple records share the same email address or multiple recipients are on the email, Sugar will pick only one of the record's values to place in the email template to send to all of the email addresses. If no related record is found, Sugar will warn you that the variable fields will be blank before you send the message. For more information on how to send a dynamic variable to many recipients, please refer to the Campaigns documentation in the Application Guide.
To use an email template, compose a new email message and click on the Template icon in the toolbar before completing any other fields on the email.
After clicking the Template icon, the Search and Select window will appear where you can find the appropriate template for your message. Select the radio button next to the template to pull all of its content and any attachments into your current message.
Note: If the body or subject of the email contains any data before a template is selected, the body and subject will be removed and replaced with the template data. Similarly, if the message contains an attachment, the attachment will be removed and replaced with any attachments that the template may contain.
Using an Email Signature
Email signatures are an easy way to standardize the messages you send with your contact details or other messaging. For more information on how to create an email signature, please refer to the Email Signatures section of this documentation.
Follow these steps to choose an email signature for a message:
- First, create a new email or edit a saved draft.
- If you have created a default signature, it will automatically appear in the body of the message and you can simply type your message above the signature.
- If you have not designated a signature as default or if you would like to select a different signature, continue to step 2.
- If you have created a default signature, it will automatically appear in the body of the message and you can simply type your message above the signature.
- Place your cursor inside the body of the message where you want the signature to appear.
- Click on the Email Signature icon in the toolbar and select your preferred signature from the dropdown list.
To remove a chosen signature, simply select another signature to replace it. If you decide to use no signature at all after a signature has been added to the composer, you must delete it manually in the composition window.
Note: The Email Signature button is disabled when the cursor is not in the body of the email composer field and when there are no signatures defined for the user.
Saving and Editing Draft Emails
To save a draft of an email that you do not want to send right away, simply start composing a new email message and click "Save Draft" instead of using the Send button. Any content, recipients, templates, and signatures used in the email are saved with the draft. Only the administrator and the Assigned To user can view and edit emails in a Draft status.
Note: Draft emails cannot be re-assigned to another user, so mass updating the Assigned To field for emails will not re-assign drafts if they are selected.
Users can only access the draft emails that they have created. A user's drafts appear alongside archived emails in the Emails list view and can be isolated in list view using the "My Drafts" filter.
Click on the subject of a draft email to launch the Compose Email screen where the email's assigned user can continue editing the email and save the email as a draft again or send the email, which will change the email's status to "Archived".
To send an email to the recipients in an email's To, Cc, and Bcc fields, simply click the Send button.
Sent emails will use the settings configured for the From account to send the email. A copy of the sent email will be saved to Sugar as "Archived" in the Emails module and can be isolated in list view using the "My Sent" filter.
Replying to Emails
Users can access the "Reply" and "Reply All" functions from the record view of emails that have an Archived status. Select "Reply" to reply to only the sender of the selected email or select "Reply All" to reply to the sender and all other recipients of the original email.
When replying to an email, Sugar creates a new email while populating the body, subject, and recipients of the email and carrying over the Related To, Assigned To, and Teams fields from the original email. The subject line of the email you are replying to carries over to the new email preceded by the letters "Re: ". The body of the email you are replying to is also carried over to the reply message with a line above the contents to separate the original email from the content you are adding to the reply.
Enter your reply above the divider line in the compose email screen. For more information on how to compose an email, please refer to the Composing Emails section.
Note: If the original email contained any attachments, they will not copy to the reply email.
Users can access the Forward function from the record view of emails that have an Archived status. Select "Forward" to open a compose window where you can specify one or more recipients.
When forwarding an email, Sugar creates a new email while populating the body and subject of the email and carrying over the Related To, Assigned To, and Teams fields from the original email. The subject line of the email you are forwarding carries over to the new email preceded by the letters "FW: ". The body of the email you are forwarding is also carried over to the message with a line above the contents to separate the original email from the content you may optionally add to the message. The recipient fields must be completed by the user before the email can be forwarded. For more information on adding recipients, please refer to the Working With Recipient Fields section of this page.
Optionally, enter a message above the divider line in the compose email screen. For more information on how to compose an email, please refer to the Composing Emails section.
Note: If the original email contained any attachments, they will not copy to the forwarded email.
Relating Emails to Records
Emails in Sugar are implicitly related to records in Sugar that match an email address in the From, To, or Cc fields in the email. This implicit relationship is made for emails sent from Sugar as well as emails archived in Sugar via incoming email accounts or the Sugar Email Archiving service. Implicitly related emails will show in the Emails subpanel and History dashlet of the related record.
While composing an email, users can set an explicit relationship via the Relates To field. This allows the user to relate the email to a Sugar record regardless of whether the record contains an email address related to the email.
In addition to using the Relates To field, you can link additional module records to emails via the related record subpanels on the email's record view. Conversely, you can also select emails to relate from the Emails subpanel of related records.
Understanding Email Address Opt-Outs
Email addresses can be marked as opted out in Sugar records to indicate that it should be excluded from receiving email marketing campaigns. To mark an email address as opted opt, users can simply click the button with a slashed circle to the right of the email address. Administrators can also configure whether new email addresses added to Sugar records default to opted-in or opted-out by using the "Opt-out new email addresses by default" option via Admin > System Email Settings. For more information regarding this option, please refer to the Email documentation in the Administration guide. In addition, when a recipient clicks the opt-out link in an email-type campaign, Sugar will automatically mark the recipient's email address as "Opted Out" in the corresponding record (e.g. contacts). For more information regarding opt-outs and campaigns, please refer to the Campaigns documentation.
Opted-out email addresses will display the opt-out status which is indicated by a blue circle with a line through it. Please keep in mind that although email addresses that are marked as opted out cannot receive campaign emails, users can continue to send them transactional emails in Sugar. For more information on opted-out email addresses, please refer to the User Interface documentation.
When composing emails in Sugar, you can include the opted-out email address in the recipient fields (i.e. To, Cc, Bcc) if you wish to send them a message. Please note that the recipient pill will display an opt-out status to indicate that it is an opted-out email address.
When an email is explicitly related to a record, users have the option of unliking the email record via the Emails subpanel. Please note that the unlink option is not available for email records that are implicitly related via a matching email address or automated email importing. As a result, the unlink option is not available when viewing the Emails subpanel in the following modules: Accounts, Contacts, Leads, Targets, Cases, and Opportunities. For more information on the different ways emails can be related to records in Sugar, please refer to the Relating Emails to Records section.
To delete the relationship between the record and the related email, simply navigate to the module record (e.g. Quotes) containing the related email and choose "Unlink" from the Actions menu on the far right of the desired record's row in the Emails subpanel. Please keep in mind that performing this action removes the relationship but does not delete the email record itself.
Email templates are used in Sugar to send simple form letters, automated email responses, or just commonly used emails to save time and prevent typos. They are also useful for ensuring a consistent style and voice for communications transmitted throughout your organization. Email templates can contain text, HTML content, images, and attachments. The content of templates may contain variables for field values like the recipient's name so that you can personalize the email for the recipient.
For information on using an existing template in an email message, please please refer to the Using a Template section of this page.
Note: Sugar's core product includes several places where email templates can be created for different purposes. For more information on alternative types of email templates in Sugar, please refer to the Understanding Email Templates for Campaigns, Workflows, and Advanced Workflow article.
Viewing Email Templates
To view the list of available templates, navigate to the Emails module and select "View Email Templates" from the Emails module tab menu. Please note that you will only be able to see email templates as allowed by your team membership, user access type, and assigned roles. For more information on teams and roles, please refer to the Team Management and Role Management documentation in the Administration guide.
Note: If you are logged in as an administrator, you can view and edit the "Forgot Password email" and "System-generated password email" system templates via the Email Templates list view.
Creating Email Templates
To create a new email template in Sugar, click the triangle on the Emails module tab and select "Create Email Template" from the module tab menu.
Refer to the Email Template Fields and Inserting Template Variables sections to complete the email template. For instructions on using templates in email messages, please refer to the Using a Template section of this page.
Email Template Fields
The Email Templates module contains the following fields:
|Assigned To||The Sugar user assigned to the process email template|
|Body||The content of the message including any text, HTML content, images, or variables
|Date Created||The date the email template record was created|
|Date Modified||The date the email template record or its content was last modified|
|Description||A description or other information about the email template|
|Name||A unique and descriptive name to help users find the template|
|Subject||The subject that recipients will see in their email inbox|
|Teams||The Sugar team(s) that should have access to the email template|
|Type||The type of email template
Note: The Type field defaults to "Email" when creating email templates via the Emails module. For more information on how to create an email template for campaigns, please refer to the Campaigns documentations.
Inserting Template Variables
When constructing the subject and body of an email template, Sugar allows you to insert variables that correspond with Sugar fields on related records. The variables will be replaced with the related record's field values when the email is sent from Sugar. For example, you can insert a variable for the recipient's first name on a template that you plan to send to leads or contacts.
Use the following steps to insert a variable for the recipient's first name into an email template:
- Click to place your cursor on the location in the subject or body where the recipient's first name should appear.
- In the Insert Variable row, select the module you would like to insert a variable from.
- Set the second dropdown to the desired field from the modules selected in the first dropdown. For our example, select "First Name".
- Click "Insert" to insert the generated variable name to your subject or body at your cursor's location.
If there are no images, links, or formatting in your email, then sending it as text only may be a good option. Click the Send Text Only checkbox to remove the HTML formatting options. Alternatively, you can click "Edit Plain Text" at the bottom of the page to have the plain text option send differently than the HTML text.
Editing Email Templates
To edit a template, navigate to the Emails module and select "View Email Templates" from the Emails module tab menu. Click on the name of the template you want to edit and adjust the content, fields, and variables as needed. Please note that you will only be able to see and edit email templates as allowed by your team membership, user access type, and assigned roles. For more information on teams and roles, please refer to the Team Management and Role Management documentation in the Administration guide.
An email signature is a snippet of text positioned below the body of an email message that typically contains the contact information of the sender. Sugar allows users to create multiple signature variations that they can insert during email composition. Optionally, users can mark one email signature as their default signature. Sugar will automatically insert the default signature when a user composes a new email, but the user has the option to delete it or replace it with a non-default signature.
For steps to insert signatures in email messages, please refer to the Using an Email Signature section of this page.
Note: You must have role access to the Emails module to view and create email signatures. For more information on roles, please refer to the Role Management documentation in the Administration Guide.
Viewing Email Signatures
To view your saved signatures, navigate to the Emails module and select "View Email Signatures" from the Emails module tab menu. Please note that you will only be able to see email signatures that you have created.
Creating Email Signatures
To create a new email signature, click the triangle on the Emails module tab and select "Create Email Signature" from the module tab menu.
Give your new signature a descriptive name (e.g. "Sugarcon Promo Signature") and compose your signature in the Signature composition area just as you want it formatted for outgoing messages. Optionally, enable the "Default" checkbox to make this your automatic signature on all new emails. Each user can have one default signature. Marking a signature as your default will uncheck the Default field on any signature you may have previously designated.
When you are satisfied with the signature you have created, click "Save" to add the signature to the Signatures dropdown on email compose views for your user. Other users cannot access the signatures that you have created.
For more information about the fields available on the email signature record, please refer to the Email Signature Fields section. For instructions on using signatures in email messages, please refer to the Using a Signature section of this page.
Email Signature Fields
The Email Signatures module contains the following fields:
|Name||A unique and descriptive name to help users find the template|
|Default||Designates the user's default email signature
Note: Each user can have one default signature. Marking a signature as your default will uncheck the Default field on any signature you may have previously designated.
|Signature||The content of the email signature including any text, HTML content, and images
Note: Use the TinyMCE functions to add formatting to the signature. For more information on using TinyMCE, please refer to the User Interface documentation. If images or advanced CSS are required in your email signature, it is highly recommended to host the images or CSS file on a publicly available hosting service and link to it in the email signature. For more information, please refer to the Using CSS in Email Templates article.
|Date Created||The date the email template record was created|
|Date Modified||The date the email template record or its content was last modified|
|Tags||User-created keywords that can be used to identify records in filters, dashlets, and reports
Note: For more information on creating and using tags, please refer to the Tags documentation.
Editing Email Signatures
To edit a signature, navigate to the Emails module and select "View Email Signatures" from the Emails module tab menu. Click on the name of the signature you want to edit and adjust the content as needed. Please note that you can only view and edit the email signatures that you have created. Click "Save" to preserve your changes to the signature.
The edited signature will be available the next time you insert the signature into a new message. Any drafts that were saved with the signature before it was edited will retain the old signature. You can re-select the same signature from the draft's Signatures menu, which will replace the old version with the new one.
Sugar Email Archiving Service
Sometimes referred to as SNIP, the Sugar Email Archiving service allows users to easily archive email to Sugar records simply by sending the email to a special email address. The email archiving service monitors the email address, imports the email into your Sugar instance, and links related records without the use of a plug-in or other syncing process.
Note: Before you can use Sugar Email Archiving, an administrator must enable the service for your instance. For activation instructions, please refer to the Email documentation in the Administration Guide.
Features and Limitations
Anyone can send emails to the Sugar Email Archiving address, so the capability is not limited to users. Sugar Email Archiving will not import messages that are larger than 10 MB including attachments.
When an email record is archived via the Sugar Email Archiving service, the email's team will default to "Global". Users with the appropriate permissions may update the Teams field after the email has been archived in Sugar.
If the sender's email client is configured to use non-English From, To, and Cc fields, forwarding emails to Email Archiving may not work. Instead, send the email to Email Archiving directly using the Cc and Bcc fields or forward the email as an attachment. For a large volume of non-English emails that need to be archived using Email Archiving, set a rule in your email application to copy the emails to the Sugar Email Archiving address.
Relating Archived Emails to Sugar Records
Sugar will scan incoming emails that are sent to the Email Archiving Service for the following relatable items:
- From, To, and Cc fields : The Sugar Email Archiving service scans the From, To, and Cc fields of the message and relates the email to any records it finds with a matching email address in Sugar. The archived email will appear in the Emails subpanel and History dashlet for any matching records in Sugar. Please note that Email Archiving cannot relate records based on email addresses in the Bcc field due to the field's hidden nature.
- Message body : The Sugar Email Archiving service scans the content in the body of the message and relates the email to any records it finds with a matching email address in Sugar. For an email address to be recognized in the body of an email, it must be preceded by "To:" and surrounded by opening and closing carets, for example, "To: <email@example.com>" or "To: John Smith <firstname.lastname@example.org>". The archived email will appear in the Emails subpanel and History dashlet for any matching records in Sugar.
- Case Macro : If an archived email's subject line contains a specially-formatted key known as the Case Macro, the message will automatically be associated with the corresponding case in Sugar's Cases module. For more information on using the case macro, please refer to the Automatically Associating Emails With Cases article.
- Calendar invites (.ics) : If the email contains a calendar event, Sugar will archive the email as well as create a Meeting record. Any users, contacts, or leads that share an email address with the meeting's attendees will be added as meeting invitees in Sugar.
The Sugar Email Archiving Service will relate emails to records in the following modules:
- Accounts, Contacts, Leads : relates emails with a matching email address
- Cases : relates emails containing a matching case number via Case Macro
- Meetings : creates meetings from emails with calendar invites; relates matching invitees
- Opportunities : relates emails from related contacts if the admin has enabled Related Contacts Emails for opportunities
Note: Any relationships between archived emails and custom modules must be made manually.
Sugar Email Archiving creates an implicit relationship between the email and matching records via the email addresses on the email. This implicit relationship behaves differently than an explicit relationship. For example, an email implicitly related (i.e. via Sugar Email Archiving by matching email address) to Beth Roberts' contact record would appear in her Emails subpanel just like one that is explicitly related (i.e. manually created relationship via subpanels). However, if Beth's email address is updated in Sugar, the emails created via Sugar Email Archiving will no longer appear in her subpanel since the email addresses no longer match. You can explicitly relate a contact to an email by navigating to the email's record view and selecting Beth Roberts in the email's Contacts subpanel.
Like other records in Sugar, an email can only be assigned to one user. The Sugar Email Archiving service assigns emails to a user based on a match between the email address stored in the user's profile settings and an email address listed in the From, To, or CC fields. Sugar looks for users' email addresses in the From field first, then the To field, and then the CC field, and assigns the email record to the first user it finds with a matching email address. For example, if three Sugar users appear on an email, two in the To field and one in the CC field, the first user listed in the To field will be assigned the email record in Sugar.
Outgoing Email Accounts
Navigate to the Emails module and select "Email Settings" in the Emails module tab to open the Outgoing Email Accounts list view, where users can add email accounts and edit their configured email accounts.
The Outgoing Email Accounts list view is empty by default unless the administrator has enabled "Allow users to use this account for outgoing email" in Admin > System Email Settings, in which case the system email account should be shown with an asterisk to indicate that it is a system account. Once you have configured an outgoing user email account, the list will display it here along with any other user accounts you choose to configure.
Note: The Outgoing Email Accounts list view does not support filtering, preview, or mass actions.
Creating Outgoing Email Accounts
Sugar lets users configure one or more personal email accounts to send email messages. Email messages sent from Sugar will be automatically archived and linked to existing records throughout the application.
Note: To send messages through the Sugar application, you must select "Sugar Email Client" from the Email Settings section of your user profile. For more information, please refer to the Getting Started documentation.
Use the following steps to add a new outgoing user email account:
- Navigate to the Emails module and select Email Settings from the module tab.
- Click "Create". If you do not see the Create button, talk to your administrator about enabling the system email setting "Allow users to configure email accounts".
- For Google (e.g. Gmail or Google Apps), Microsoft Exchange, or Microsoft Outlook accounts, click on the appropriate Email Provider logo to expose provider-specific fields pre-populated with their most common default settings. For accounts with any other email provider, select "Other".
Note: For Google accounts, you may be required to enable less-secure app access within your Google account. For more information, please refer to Google's help documentation.
- Complete the following fields for your email account. All required fields are marked as such and must be completed prior to saving. If you are not familiar with these terms or their values, please check with your IT department or email provider.
- Name : The name of the outgoing email account that will be used to identify it in list view and will appear as the "From" name on messages sent from Sugar via this account
- Email Address : The email address used to send messages for this account
- Server : The web address of the external email server from which emails will be viewed in Sugar
- Port : The communication port number used for connecting to the email server
- Transport Encryption : Select the appropriate option from the dropdown to use Secure Socket Layer (SSL), Transport Layer Security (TLS), or no encryption (None) when connecting to the email server.
- Use SMTP Authentication : Select this box to require server authentication for the account. Most email servers require authentication for security purposes. By default, authentication is required for Google, Exchange, and Outlook providers. If left unchecked, the SMTP server will accept anonymous connections, which is not recommended. The following fields are displayed when "Use SMTP Authentication" is enabled:
- Username : Enter the username for the external account. The username is often the email address.
- Password : The Password field group contains a grayed-out field that cannot be edited and the following two required fields:
- New Password : Enter the account's existing password.
- Confirm Password : Re-type the account's existing password. This value must exactly match the "New Password" value in order to properly authenticate.
- Once the necessary information is entered, click "Save" to preserve the changes. Sugar will automatically validate the settings and alert you if there has been an error.
Though uncommon, users may be able to use the system's outgoing email server if the administrator allows it. For more information on how to configure the system's outgoing email server, please refer to the Email documentation in the Administration Guide. For more information on configuring the system outgoing email server settings and allowing users to use the system account, please refer to the Email documentation in the Administration Guide.
Editing Outgoing Email Accounts
To edit an outgoing email account that you created, navigate to the Emails module and select Email Settings from the module tab. Click the pencil icon next to the account you want to edit.
Alternatively, click on the account's name and then click the Edit button on its record view.
Note: If the administrator has exposed the system email account to users, it will be listed in the Outgoing Email Accounts list view with an asterisk and cannot be edited by regular users.
Deleting Outgoing Email Accounts
To delete an outgoing email account that you created, navigate to the Emails module and select Email Settings from the module tab. Expand the record's Actions menu in the list view and select "Delete".
Alternatively, click on the account's name and then select "Delete" from the Actions menu on its record view.
Note: If the administrator has exposed the system email account to users, it will be listed in the Outgoing Email Accounts list view with an asterisk and cannot be deleted. In addition, the default user email account that was created when the user's record was created cannot be deleted.
Last modified: 2018-05-25 23:07:12