View source for Email Configuration

[[Category:Support]]
This article covers configuring X2CRM for sending (and, in special cases, receiving) email.

= Introduction =
X2CRM provides the means to send email, natively, within the web application. Furthermore, with Professional Edition, the local MTA on the web server (if any) can be configured to allow X2CRM to receive emails and automatically associate them with the addressee's contact record.

= <span class="noglossary">Configuring SMTP Accounts</span> =
This section describes the current, recommended method of sending email in X2CRM. It makes use of a credentials storage system X2CRM features, which encrypts passwords and other authentication data at the database storage level. It is currently only used for storing email account passwords, but may in the foreseeable future be extended to store other types of passwords. To access the credentials manager, click "Manage Apps" under the user menu.

== Creating Credentials Records ==
[[File:New-Email-Account.png|200px|thumb|right|The create page for a generic email account]]
To create a new email account, first select a type in the dropdown menu next to the '''Add New''' button. Then, click '''Add New'''. The easiest type of email account to add is Google Mail (i.e. GMail or email accounts offered via Google Apps for businesses). For such email accounts, SMTP server data such as the host name, port, and security type are already set, and all you have to enter is your username, password, and sender name. For all other types of email, first contact your email hosting provider or peruse their documentation on configuring email client programs (i.e. Outlook / Thunderbird) for use with their email service. The essential information that you need:
* '''Server''': host name, i.e. smtp.email.com
* '''Port''': a 2-3 digit number, i.e. 25 for unsecured SMTP, or 465 (legacy) or 587 for secure SMTP.
* '''Security Type''': TLS/SSL. In most cases these are interchangeable.
* '''User name'''/'''Password''': If the SMTP server does not use authentication, leave these blank. Otherwise, set them according to the username/password used for logging in to the email

== Creating System-Owned Credentials ==
One may wish to have all users use a specific email account/address for email blasting, or set a sender account for system notifications, or responses to service case submitters (etc). One can do so by creating publicly-usable email accounts. Such accounts will be usable by all users, but may only be viewed or edited by administrators, and thus are ideal for such purposes as they aren't necessarily attached to / identified with any given user.

To designate an account as system-owned, set the '''Owner''' to be "System" when creating it.

== Creating Non-Private Credentials ==
Non-administrators also have the ability to create credentials that can be used by administrators, in the rare case where it may be desirable for the owner to send mail on their behalf. To do so (allowing administrators to masquerade as the other user when sending email), that user must consent to allow their email account to be used by other people, by un-checking the '''Private''' checkbox. Note, however, that this will not allow administrators to view or edit the credentials, only to use them as a delivery method option when sending email.

== Setting Personal Default Credentials ==
[[File:1-my-default.png|300px|thumb|right|Setting one's own personal default credentials]]
It is usually desirable to have a preferred email account for use in X2CRM, while at the same time having the option to send email using the system-wide (legacy) method, or via some other email account set up through the credentials manager.

Next to each credentials record, there will be a "pill" with a checkbox in it that says "Set as my default", or "Set as default" (when system-owned and being viewed by an administrative user). When the box is checked, an "apply" button will appear to enact the change. After clicking "apply" a green pill label appears on the record to denote that it has been selected as default. What this means is that whenever one opens the inline email widget (i.e. on a contact view, by clicking the email button), the "send as" field will be set to the selected account by default. This way it still allow switching email accounts on-the-fly, but removes an extra step that would otherwise be necessary to remember whenever sending an email.

== Setting System Default Credentials ==
[[File:System-Default.png|300px|thumb|right|Setting default credentials for the system and/or oneself]]]
All users have the ability to set system-owned credentials as their personal defaults. However, administrative users can also designate the credentials for system use purposes, i.e. bulk email and system notifications. For each credentials record owned by the system, when being viewed as the administrator, the pill will say "set as default" instead. When the box is checked, it will display a dropdown menu of system roles for which the account isn't already selected to use by default. After selecting the appropriate role to apply it as default for, and clicking "apply" as one would for setting personal defaults, it will be set as the default email account to use for that purpose.

Note, also, setting defaults for system roles in the credentials manager is just another way of changing settings in "Email Server Configuration" (accessed from within the Admin panel), and vice versa. These settings are actually synchronized. Some definitions of system uses:

;Bulk Email Account
: Will be selected by default when users create a new campaign (overrides the users' personal default)
;Service Case Email Account
: Used when sending responses to service case submitters.
;System Response Emailer
: Used when sending responses to web leads, and is selected by default in X2Flow's send-an-email actions (but can be changed).
;System Notification Emailer
: Used for miscellaneous notification tasks, most notably, sending "broadcast event" emails to targeted users when users broadcast an event, select users to broadcast it to, and enable the option to notify users by email.

= Using The Legacy (system-wide) Email Delivery Methods =
Apart from using separate, third-party SMTP accounts for each user (and system purpose), there is a way to use a singular email delivery method for all emails sent via X2CRM. However, this method is not recommended, unless your web server also serves as your mail server. It is very much considered a legacy feature.


There are four options for methods of sending email, which can be found in the '''Outbound Email Server''' section in '''Email Settings''' under the '''Email Configuration''' section in the '''Admin''' page. These methods are:

# PHP Mail
# Sendmail
# QMail
# SMTP

If any of these aren't available, they won't be listed in the '''Method''' menu.

PHP Mail, Sendmail and QMail each, while independent of any offsite, third-party service, require that an MTA be available on the web server. The main difference is that PHP Mail uses whichever MTA that PHP itself is configured to use, whereas the Sendmail and QMail methods are specific to the Exim4/Postfix and QMail MTA's (respectively). To use PHP Mail, you can check that PHP is configured for using an MTA using [[requirements:|requirements.php]]. 

For all instances of X2CRM Professional Edition cloud/ondemand, the methods available for sending mail include all of these except QMail.

== Circumventing Spam Filters ==
While the non-SMTP methods for sending email within X2CRM may work immediately, a common problem encountered with them is that email goes into spam folders on the receiving end, or is not being received at all. ''This is especially likely to happen when the email addresses specified by users in their profiles'' (which get used as the sender address in the headers of mail sent by X2CRM) ''do not belong to the same domain name as the server hosting X2CRM.'' So, for example, it would be problematic if a user uses an email address in their X2CRM profile that ends in gmail.com, and the X2CRM system is hosted on example123.com

This is '''not''' a fault in X2CRM (or [http://phpmailer.worxware.com/ PHPMailer], which X2CRM uses for mail delivery). Rather, it is endemic to all web applications (i.e. Wordpress, Drupal, etc.) due to how sender address spoofing (telling the recipient that the email comes from somewhere else) is a common behavior among spammers. Furthermore, the general proliferation of email spam through various means (but especially PHP scripts running on web servers) has resulted in greatly elevated standards in the spam-detection mechanisms and heuristics of most email servers. This generally poses an entry barrier to getting around spam filters. It is thus recommended that, before sending emails using these legacy methods, measures are taken to ensure that mail sent will have the best chance of avoiding spam filters.

=== Work-around 1: Aliasing ===
This works by first creating mail forwarding aliases on the server, i.e. through a Virtualmin or CPanel control interface, or manually, by editing the MTA's virtual user aliases table (see their respective documentation for more information). Next, instruct all users to use these email addresses as their contact address in their X2CRM profile, so that when contacts reply, the response emails will be forwarded to the desired addresses (or even a list of addresses) specified by each alias.

=== Work-around 2: Migration ===
This, of course, is the most straightforward solution: to use the hosting provider's email service. However, it requires switching from one's existing email service/addresses to service and addresses provided by the hosting provider, and it is also extra effort.

=== Work-around 3: Third-party Service ===
''Note, using this method is '''not''' recommended; see <span class="noglossary">[[#Configuring SMTP Accounts|Configuring SMTP Accounts]]</span> for the preferred method of using SMTP for email delivery.''

Using this method, the entire organization that uses X2CRM sends email using a single email account managed by a third-party service that supports SMTP. Thus, sending the email and digital signing are handled by the third-party service, and getting caught in spam filters generally tends to be a smaller problem.

In most cases, this method will work. How it works is that the reply-to address in the email will be set to the email address of user who is sending the mail through X2CRM, while the actual mail system user is used to authenticate with the mail server. In such cases, the address of the mail user might still show up in one of the headers of the resulting email. However, '''this is known to not work with many email providers, most notably GMail''', which (for security and anti-spam purposes) does not permit sending emails if the sender address differs from the address associated with the Google account that was used to authenticate. If this is the case, it is recommended to use separate SMTP accounts via the credentials manager.

=== Using <span class="noglossary">DKIM</span> ===
(see [[wikipedia:DomainKeys_Identified_Mail|main article]] on Wikipedia)

This method, which requires server-end configuration, is a very secure and reliable method of distinguishing email as being of legitimate and trustworthy origin. '''Almost every''' reputable email service is configured to use a mail signing agent to add a special signature sent from such addresses, in addition to checking signatures of incoming emails. Emails that are digitally signed are far more likely to be recognized by mail servers worldwide as being from a reputable source, and thus less likely to go be caught in spam filters.

However, it still requires that the sender's email address be of the same domain as the email server. That is because the sender address cannot be "spoofed", because DKIM was designed to prevent this sort of activity (which is common among spammers). Furthermore, if outgoing email is signed for domains not corresponding to the point of origin, it may actually make matters worse; many reputable mail services (including GMail) themselves use DKIM to avoid their domain name being abused by address spoofing. Thus, if a DKIM signature header is added to the email, and the signature does not match the DKIM record of the sender's domain, it will be considered a forgery attempt and blocked/filtered by most email servers.<ref>DKIM uses the RSA public/private key cryptographic technique to ensure that signatures are secure and cannot be forged. Thus, there is no legitimate way of circumventing this issue.</ref>

= Configuring the "Email Dropbox" For Receiving Emails =
This feature, available in X2CRM Professional Edition, provides the means to automatically create contacts and email-type action records by capturing emails from external email software, i.e. Outlook and GMail. Customers of X2CRM Professional cloud/ondemand have this feature enabled and configured already. The methods for using it are as follows:
;CC
: When sending an email to a contact, include the email alias in the CC field.
;Forward
: After receiving an email from a contact, forward it to the email alias.
;Direct
: Send an email directly to the alias. A post in the social feed will be created using the contents of the email's body.

Setting it up requires a Linux/Unix server environment, a MTA, and knowledge of how to set up email aliases. There are two methods of integration: direct, and via API.

== Direct Integration ==
This method works by locally sending the email contents directly to X2CRM through the system console. It is more straightforward to configure, but requires that the MTA and web server hosting X2CRM be on the same machine, virtual or physical.
<ol>
<li>Using CPanel, Webmin/Virtualmin, or any other web host administrative tool, create a mail alias on the server that begins with "dropbox@", i.e. "dropbox@yourdomain.com". (Note: you can also do this manually by editing the mail server's configuration files, although doing that is beyond the scope of this guide.)</li>
<li>Find the absolute path on the web server's filesystem to X2CRM, if you're not sure where it is already:
<ol style="list-style-type:lower-alpha">
  <li>Paste the following into a PHP file called "path.php", in the same directory as X2CRM: <syntaxhighlight lang="php"><?php echo realpath(dirname(__FILE__)); ?></syntaxhighlight></li>
  <li>Navigate to the file using a web browser</li>
  <li>Record the path, append "/email.php", and use the resulting string as the path to the capture script in the mail alias.</li>
  <li>Delete the file "path.php" from the server.</li>
</ol></li>
<li>Create an email alias. Set its destination a pipe to a program: '''<tt>php /path/to/x2crm/email.php</tt>''' (versions up to 2.5.2) or '''<tt>/path/to/x2crm/protected/yiic emaildropbox</tt>''' (versions 2.7 and later)</li>
<li>(X2CRM versions 2.7 and later) Change the permissions on the <tt>protected/runtime</tt> folder to '''777''' (all users can read/write).<ref>If you cannot do this for security purposes, but are a system administrator, you can instead change them to 770. If you do so, however, you must change the group ownership of the directory to the group under which the MTA spawns processes (typically "nobody" or "nogroup").</ref></li>
<li>Test the alias by sending a message to a fictitious name/email address (i.e. <tt>"Sue Doenimm" <test@example.com></tt>) and CC-ing the mail alias. </li>
<li>Check in the Contacts module after sending the email, and if the fictitious contact was created, check to see that the email was attached properly to the contact record. If the contact was not created or the email was not imported, check the logs of the MTA for any errors.
<li>Test to see if your email software's forwarded message format is supported by forwarding an email from a contact to the mail alias.</li>
</ol>
== API Integration ==
This method works by sending the email contents to X2CRM through the remote API, and thus allows the MTA and X2CRM to live on different servers. Similar to the direct method, an alias will need to be constructed to receive the email and send it to a program, but in this case the program acts as a proxy by sending the contents to X2CRM via a web request. This method is more flexible, but takes more effort to set up;
<ol>
 <li>Using your file/FTP manager of choice, navigate to the <tt>protected</tt> folder inside X2CRM, find the <tt>integration</tt> folder, and inside of that, navigate to the "MTA" folder.</li>
 <li>Download/copy <tt>emailImport.php</tt></li>
 <li>Open the file in your editor of choice, and look for the following lines of code:
<syntaxhighlight lang="php">
///////////////////////////
// Configuration details //
///////////////////////////
// Set this to the IP address or domain name of the server
$host = '';
// Set this to the protocol (use "https://" for an SSL-enabled web server)
$proto = 'http://';
// Set this to the URI on the web server of X2CRM, without the trailing slash.
// So, if the login URL is "http://example.com/x2crm/index.php/site/login",
// this variable should be "/x2crm"
$baseUri = '';
// Leave this null if the host specified by $host will resolve correctly.
// Otherwise, if in an environment where (for instance) the domain does not resolve
// properly, and the IP address must be used, but the CRM is on a specifically-named
// virtual host on a shared IP, set this to the domain name of that host, and set
// $host to the IP address of the web server.
$hostName = '';
$data = array(
	'user' => '',
	'userKey' => '',
);</syntaxhighlight>
</li>
<li>Change the variables according to their comments by putting the appropriate values in the (currently empty) pairs of single quotes. For instance, if your CRM is hosted at "https://crm.domain.com/crm", you will put "https://" in for <tt>$proto</tt>, "crm.domain.com" for <tt>$host</tt>, and "/crm" for <tt>$baseUri</tt>.</li>
<li>In the <tt>$data</tt> array, set the <tt>user</tt> and <tt>userKey</tt> to the API user and API key to be used (see: [[Remote_API#Authenticating|Remote API: Authenticating]]). So, for "admin" and key "aabbccddee": 
<syntaxhighlight lang="php">
$data = array(
	'user' => 'admin',
	'userKey' => 'aabbccddee',
);</syntaxhighlight>
</li>
<li>Upload the script to the server to be handling email.</li>
<li>Ensure the script has proper ownership and permissions to be run by the MTA user.</li>
<li>Create an email alias on the server to be handling email. Make the alias pipe to the program, '''/usr/bin/php /path/to/emailImport.php''', replacing "/path/to" with the actual filesystem path where you uploaded the script.</li>
</ol>

== Troubleshooting ==
If you receive a response email notifying of an unsupported forwarded message format, or do not see the email attached to the appropriate contact in X2CRM, forward the the email to [mailto:customersupport@x2engine.com X2Engine Customer Support], using the same email software that was used to test the feature. Due to the great diversity of email software and the inconsistency of forwarded/attached message formatting across platforms, the forwarded message capture may not immediately work with your email software of choice. However, per request, support for new forwarded message formats will be added in the next release. A self-service page in the Administrative console that will allow users to build patterns for recognizing their own email software is also currently in progress and scheduled for a future release.

= Notes =
<references />