Layton ServiceDesk - Settings - System Settings - Email Server Settings
m (Added "Advanced Check" section) |
m (Removed Center tag.) |
||
(57 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <p align="right">[[File:btn_back_up.png|link=User Guide for Layton | + | <p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p> |
+ | <p align="right">[[File:btn_back_up.png|link=Layton ServiceDesk - Settings - System Settings - Application Font]] [[Layton ServiceDesk - Settings - System Settings - Application Font |<u>Previous article in this series: ''Application Font''</u>]]</p> | ||
__FORCETOC__ | __FORCETOC__ | ||
+ | =Overview= | ||
+ | We recommend the POP or IMAP methods for connecting with a mail server. If these are not possible, we have the alternative methods CDO and WebDAV. | ||
+ | |||
+ | |||
+ | [[File:Lsd admin email stgs01.png|center|link=]] | ||
+ | |||
=Special Note= | =Special Note= | ||
Please consult with your mail-server admin for these details before contacting support. The email system is reliable. The details entered are the only variables. | Please consult with your mail-server admin for these details before contacting support. The email system is reliable. The details entered are the only variables. | ||
− | + | If you are a Microsoft Office 365 user, please see '''[[Layton_ServiceDesk_-_General_Troubleshooting_-_Outgoing_Email_Stops#Microsoft_Office_365|this note]]''' for configuration details. | |
− | [[ | + | |
− | + | Don't configure the settings in '''[[Layton ServiceDesk - Settings - System Settings - Exchange Online Settings|Exchange Online Settings]]'''. Those settings are not relevant in an environment that doesn't use Exchange Online. | |
− | + | ||
− | + | ||
− | + | ||
+ | ==Changing Email Server Settings== | ||
+ | If you need to change your email server settings, please schedule a time when you can change them, then restart the ''World Wide Web Publishing Service'' and ''LaytonServiceDesk service'' in the Windows Services console. Restarting the ''World Wide Web Publishing Services'' is disruptive and Layton ServiceDesk will be unavailable to users while it is restarting. | ||
+ | |||
+ | Failure to restart these services will not purge the old details from memory, and Layton ServiceDesk will continue to try to use the old settings, causing failures to import and send mail. | ||
+ | |||
+ | =Standard Configuration= | ||
+ | We use the industry-standard POP3 and SMTP protocols. For systems where these protocols are disabled, see '''[[Layton ServiceDesk - Settings - System Settings - Email Server Settings#Alternative Configuration|Alternative Configuration]]''' below. | ||
+ | |||
+ | ==Incoming== | ||
+ | ===POP3=== | ||
+ | POP3 is the easiest method to configure. It's also the only method that will delete the emails from the server; all other methods mark them as read and they have to be deleted as a separate action. | ||
+ | |||
+ | [[File:Lsd admin email stgs02a.png|link=]] | ||
+ | |||
+ | ====Settings==== | ||
+ | =====POP3 Server===== | ||
+ | If not using SSL, this can be the server name or IP address. If using SSL, it must be the same as the SSL certificate name. | ||
+ | |||
+ | =====Account===== | ||
+ | Mail account. We recommend you create an account just for Layton ServiceDesk. The format may or may not include the domain name, depending on how your mail server has been configured. | ||
+ | |||
+ | =====Port===== | ||
+ | Without SSL, the default is ''110''. With SSL, the default is ''995''. Your mail server may be using a different port number. | ||
+ | |||
+ | =====SSL/TLS===== | ||
+ | Check if using SSL or TLS. | ||
+ | |||
+ | ====Test Settings==== | ||
Click the ''Test Settings'' link to test the settings. If successful, you will be informed. | Click the ''Test Settings'' link to test the settings. If successful, you will be informed. | ||
− | ==Advanced Check== | + | ====Advanced Check==== |
− | On the mail server, run the following command using Windows Command Prompt | + | #On the mail server, run the following command using Windows Command Prompt:<p><code>netstat -an</code></p> |
+ | #Look for ''0.0.0.0:110'' (non-SSL) or ''0.0.0.0:995'' (SSL). The port should have the state ''LISTENING''. | ||
+ | |||
+ | ====Service-Specific Settings==== | ||
+ | =====Gmail===== | ||
+ | [[File:Lsd emailconf in gmail.png|link=]] | ||
+ | <p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p> | ||
+ | |||
+ | ===IMAP=== | ||
+ | [[File:Lsd admin email stgs02b.png|link=]] | ||
+ | ====Settings==== | ||
+ | =====IMAP Server===== | ||
+ | If not using SSL, this can be the server name or IP address. If using SSL, it must be the same as the SSL certificate name. | ||
+ | |||
+ | =====Account===== | ||
+ | Mail account. We recommend you create an account just for Layton ServiceDesk. The format may or may not include the domain name, depending on how your mail server has been configured. | ||
+ | |||
+ | =====Port===== | ||
+ | Without SSL, the default is ''143''. With SSL, the default is ''993''. Your mail server may be using a different port number. | ||
+ | |||
+ | =====SSL/TLS===== | ||
+ | Check if using SSL or TLS. | ||
+ | |||
+ | =====Mailbox===== | ||
+ | Specify the mailbox name. Most likely this will be ''Inbox''. | ||
+ | |||
+ | ====Test Settings==== | ||
+ | Click the ''Test Settings'' link to test the settings. If successful, you will be informed. | ||
+ | |||
+ | ====Advanced Check==== | ||
+ | #On the mail server, run the following command using Windows Command Prompt:<p><code>netstat -an</code></p> | ||
+ | #Look for ''0.0.0.0:143'' (non-SSL) or ''0.0.0.0:993'' (SSL). The port should have the state ''LISTENING''. | ||
+ | |||
+ | ==Outgoing== | ||
+ | [[File:Lsd_emailconf_out.png|link=]] | ||
+ | |||
+ | ===Settings=== | ||
+ | ====SMTP Server==== | ||
+ | If not using SSL, this can be the server name or IP address. If using SSL, it must be the same as the SSL certificate name. | ||
+ | |||
+ | ====User & Password==== | ||
+ | Mail account. We recommend you create an account just for Layton ServiceDesk. The format may or may not include the domain name, depending on how your mail server has been configured. | ||
+ | |||
+ | ====Display Name==== | ||
+ | The name that will appear as the Author of the email. | ||
+ | |||
+ | ====Port==== | ||
+ | Without SSL, the default is ''25''. With SSL, the default is ''465''. Your mail server may be using a different port number. | ||
+ | |||
+ | ====Email==== | ||
+ | Specify the outbound email account. | ||
+ | |||
+ | ====Reply Email==== | ||
+ | Specify the account to be used for replies. This can be, and frequently is, the same as the above Email. | ||
+ | |||
+ | ====SSL/TLS==== | ||
+ | Check if using SSL or TLS. | ||
+ | |||
+ | ===Test Settings=== | ||
+ | Click the ''Test Settings'' link to test the settings. If successful, you will be informed and an email will be received. | ||
+ | |||
+ | ===Service-Specific Settings=== | ||
+ | ====Microsoft Office 365==== | ||
+ | [[File:Lsd smtp office365.png|link=]] | ||
+ | |||
+ | |||
+ | '''Note''': After saving these settings, the Layton ServiceDesk server must be restarted in order for them to take effect. | ||
+ | |||
+ | ====Gmail==== | ||
+ | Gmail requires SSL: | ||
+ | |||
+ | [[File:Lsd emailconf out gmail 02.png|link=]] | ||
+ | |||
+ | ==Auto Import Settings== | ||
+ | [[File:Lsd emailconf auto import.png|link=]] | ||
+ | |||
+ | ===Settings=== | ||
+ | ====Auto Import Email Requests==== | ||
+ | Enable this to have emails received by LSD automatically converted to request tickets. | ||
+ | |||
+ | ====Auto Import Email Comments==== | ||
+ | Enable this to have emails received by LSD automatically added to requests as comments. Email subject must include the ticket number to be added as a comment to a ticket. | ||
+ | <p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p> | ||
+ | |||
+ | =Queues= | ||
+ | Both the incoming and outgoing mail queues can be viewed. | ||
+ | |||
+ | ==Incoming Email Queue== | ||
+ | The Incoming Email queue is available on the Email Server Settings page by clicking the ''View Incoming Emails'' link, or by clicking the Email Queue button in the header. '''[[Layton ServiceDesk - Logging a New Request from Email|See here for details on how to use the queue]]'''. | ||
+ | |||
+ | ==Outgoing Email Queue== | ||
+ | The Outgoing Email queue is only available on the Email Server Settings page by clicking the ''View Pending Outgoing Emails'' link. You would not normally need to monitor this page, but would access it to debug outgoing mail. | ||
+ | |||
+ | [[File:Lsd email outgoing 01.png|link=]] | ||
+ | |||
+ | ===Controls=== | ||
+ | ====Re-Send==== | ||
+ | To force one or more emails to be re-sent, click the checkbox(es) to select individual emails, or the checkbox in the header to select all, then click the ''Re-Send'' button above the list. Note that the header checkbox is a toggle that will select and deselect all, alternatively. | ||
+ | |||
+ | ====Delete==== | ||
+ | To delete one or more emails, click the checkbox(es) to select individual emails, or the checkbox in the header to select all, then click the ''Delete' button above the list. Note that the header checkbox is a toggle that will select and deselect all, alternatively. | ||
+ | |||
+ | =Alternative Incoming Email Settings= | ||
+ | It is recommended that POP3/SMTP be used as it is the most reliable configuration we have developed so far. However, in systems where these protocols have been disabled, we offer an alternative configuration via CDO or WebDAV. | ||
+ | |||
+ | Click the Alternative Email Settings button [[File:Lsd btn cdo.png|link=]] in the lower-right of the Email Server Settings page. | ||
+ | |||
+ | |||
+ | [[File:Lsd email svr stgs alt01.png|link=]] | ||
+ | |||
+ | |||
+ | ==SMTP/POP3(IMAP)== | ||
+ | [[File:Lsd email svr stgs alt02.png|link=]] | ||
+ | |||
+ | |||
+ | With this radio button checked, the details on the previous Email Server Settings page will apply and the other settings on the page will not apply. | ||
+ | |||
+ | ==CDO== | ||
+ | [[File:Lsd email svr stgs alt03.png|link=]] | ||
+ | |||
+ | #Download and install '''[https://www.microsoft.com/en-au/download/details.aspx?id=3671 CDO 1.2.1]'''. | ||
+ | #In Layton ServiceDesk, click the ''CDO'' radio button. | ||
+ | #''Incoming Drop Folder'': By default, this should be ''C:\inetpub\mailroot\drop''. Click the ''Test Settings'' link to test. | ||
+ | #''Reply Email'': Enter the email address you will use for Layton ServiceDesk. Click the ''Test Settings'' link to test. Enter an address (doesn't have to be the same) in the dialog and click the ''OK'' button. If correctly configured, you will get a message saying ''Successfully put mail in the Pickup Folder''. Check to see that the email arrived. | ||
− | + | ===Troubleshooting=== | |
+ | #Navigate to the folder entered in the ''Incoming Drop Folder'' field. | ||
+ | #Right-click the folder and Select ''Properties''. | ||
+ | #Click the ''Security'' tab. | ||
+ | #Ensure that both IUSR and IIS_IUSRS accounts have ''Full Control'' permissions. | ||
− | + | ==WebDAV== | |
− | <p align="right">[[File:btn_back_up.png|link=User Guide for Layton | + | [[File:Lsd email svr stgs alt04.png|link=]] |
+ | <p align="right">[[Layton ServiceDesk - Settings - System Settings - Exchange Online Settings |<u>Next article in this series: ''Exchange Online Settings''</u>]] [[File:Btn forward.png|link=Layton ServiceDesk - Settings - System Settings - Exchange Online Settings]]</p> | ||
+ | <p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p> |
Latest revision as of 00:12, 1 November 2022
Previous article in this series: Application Font
Contents |
[edit] Overview
We recommend the POP or IMAP methods for connecting with a mail server. If these are not possible, we have the alternative methods CDO and WebDAV.
[edit] Special Note
Please consult with your mail-server admin for these details before contacting support. The email system is reliable. The details entered are the only variables.
If you are a Microsoft Office 365 user, please see this note for configuration details.
Don't configure the settings in Exchange Online Settings. Those settings are not relevant in an environment that doesn't use Exchange Online.
[edit] Changing Email Server Settings
If you need to change your email server settings, please schedule a time when you can change them, then restart the World Wide Web Publishing Service and LaytonServiceDesk service in the Windows Services console. Restarting the World Wide Web Publishing Services is disruptive and Layton ServiceDesk will be unavailable to users while it is restarting.
Failure to restart these services will not purge the old details from memory, and Layton ServiceDesk will continue to try to use the old settings, causing failures to import and send mail.
[edit] Standard Configuration
We use the industry-standard POP3 and SMTP protocols. For systems where these protocols are disabled, see Alternative Configuration below.
[edit] Incoming
[edit] POP3
POP3 is the easiest method to configure. It's also the only method that will delete the emails from the server; all other methods mark them as read and they have to be deleted as a separate action.
[edit] Settings
[edit] POP3 Server
If not using SSL, this can be the server name or IP address. If using SSL, it must be the same as the SSL certificate name.
[edit] Account
Mail account. We recommend you create an account just for Layton ServiceDesk. The format may or may not include the domain name, depending on how your mail server has been configured.
[edit] Port
Without SSL, the default is 110. With SSL, the default is 995. Your mail server may be using a different port number.
[edit] SSL/TLS
Check if using SSL or TLS.
[edit] Test Settings
Click the Test Settings link to test the settings. If successful, you will be informed.
[edit] Advanced Check
- On the mail server, run the following command using Windows Command Prompt:
netstat -an
- Look for 0.0.0.0:110 (non-SSL) or 0.0.0.0:995 (SSL). The port should have the state LISTENING.
[edit] Service-Specific Settings
[edit] Gmail
[edit] IMAP
[edit] Settings
[edit] IMAP Server
If not using SSL, this can be the server name or IP address. If using SSL, it must be the same as the SSL certificate name.
[edit] Account
Mail account. We recommend you create an account just for Layton ServiceDesk. The format may or may not include the domain name, depending on how your mail server has been configured.
[edit] Port
Without SSL, the default is 143. With SSL, the default is 993. Your mail server may be using a different port number.
[edit] SSL/TLS
Check if using SSL or TLS.
[edit] Mailbox
Specify the mailbox name. Most likely this will be Inbox.
[edit] Test Settings
Click the Test Settings link to test the settings. If successful, you will be informed.
[edit] Advanced Check
- On the mail server, run the following command using Windows Command Prompt:
netstat -an
- Look for 0.0.0.0:143 (non-SSL) or 0.0.0.0:993 (SSL). The port should have the state LISTENING.
[edit] Outgoing
[edit] Settings
[edit] SMTP Server
If not using SSL, this can be the server name or IP address. If using SSL, it must be the same as the SSL certificate name.
[edit] User & Password
Mail account. We recommend you create an account just for Layton ServiceDesk. The format may or may not include the domain name, depending on how your mail server has been configured.
[edit] Display Name
The name that will appear as the Author of the email.
[edit] Port
Without SSL, the default is 25. With SSL, the default is 465. Your mail server may be using a different port number.
[edit] Email
Specify the outbound email account.
[edit] Reply Email
Specify the account to be used for replies. This can be, and frequently is, the same as the above Email.
[edit] SSL/TLS
Check if using SSL or TLS.
[edit] Test Settings
Click the Test Settings link to test the settings. If successful, you will be informed and an email will be received.
[edit] Service-Specific Settings
[edit] Microsoft Office 365
Note: After saving these settings, the Layton ServiceDesk server must be restarted in order for them to take effect.
[edit] Gmail
Gmail requires SSL:
[edit] Auto Import Settings
[edit] Settings
[edit] Auto Import Email Requests
Enable this to have emails received by LSD automatically converted to request tickets.
[edit] Auto Import Email Comments
Enable this to have emails received by LSD automatically added to requests as comments. Email subject must include the ticket number to be added as a comment to a ticket.
[edit] Queues
Both the incoming and outgoing mail queues can be viewed.
[edit] Incoming Email Queue
The Incoming Email queue is available on the Email Server Settings page by clicking the View Incoming Emails link, or by clicking the Email Queue button in the header. See here for details on how to use the queue.
[edit] Outgoing Email Queue
The Outgoing Email queue is only available on the Email Server Settings page by clicking the View Pending Outgoing Emails link. You would not normally need to monitor this page, but would access it to debug outgoing mail.
[edit] Controls
[edit] Re-Send
To force one or more emails to be re-sent, click the checkbox(es) to select individual emails, or the checkbox in the header to select all, then click the Re-Send button above the list. Note that the header checkbox is a toggle that will select and deselect all, alternatively.
[edit] Delete
To delete one or more emails, click the checkbox(es) to select individual emails, or the checkbox in the header to select all, then click the Delete' button above the list. Note that the header checkbox is a toggle that will select and deselect all, alternatively.
[edit] Alternative Incoming Email Settings
It is recommended that POP3/SMTP be used as it is the most reliable configuration we have developed so far. However, in systems where these protocols have been disabled, we offer an alternative configuration via CDO or WebDAV.
Click the Alternative Email Settings button in the lower-right of the Email Server Settings page.
[edit] SMTP/POP3(IMAP)
With this radio button checked, the details on the previous Email Server Settings page will apply and the other settings on the page will not apply.
[edit] CDO
- Download and install CDO 1.2.1.
- In Layton ServiceDesk, click the CDO radio button.
- Incoming Drop Folder: By default, this should be C:\inetpub\mailroot\drop. Click the Test Settings link to test.
- Reply Email: Enter the email address you will use for Layton ServiceDesk. Click the Test Settings link to test. Enter an address (doesn't have to be the same) in the dialog and click the OK button. If correctly configured, you will get a message saying Successfully put mail in the Pickup Folder. Check to see that the email arrived.
[edit] Troubleshooting
- Navigate to the folder entered in the Incoming Drop Folder field.
- Right-click the folder and Select Properties.
- Click the Security tab.
- Ensure that both IUSR and IIS_IUSRS accounts have Full Control permissions.
[edit] WebDAV