Set up e-mails with Hawkeye server

Hawkeye server supports the use of emails in three ways.

  • Deliver generated reports though e-mails.
  • Deliver error notification e-mails of test results including failure or error reasons.
  • Deliver real service test e-mails for XR probes

To send reports and test results in e-mails, you must make available a mail client and configure it for the Hawkeye server. You do not need to configure mail client for Hawkeye server for real service tests.

Configure e-mail for reports and test results

Configure Email section in Administration > Preferences of Hawkeye server UI to set up a mail client. You will need to configure your SMTP server settings and your organization’s e-mail account credentials in this section for the Hawkeye server to send e-mails.

Configure an Email SMTP server in Preferences. Following is a sample configuration.

 

SMTP server: mail.smtp2go.com

SMTP Authentication: Enable

SMTP Security: SSL (match whatever your email service uses SSL/TLS?)

Port: 465

Configure port 465 for SSL, 587 port for TLS or 25 default SMTP port for no security, no other value is supported. Port 25 was the most commonly used port, but for security many email providers now block it as it is used by spammers.

Username: freds_fish_n_chips@gmail.com

This e-mail address is for reference.

Password: ********

Email address: freds_fish_n_chips @gmail.com

Full name: freds_fish_n_chips @gmail.com

These are the credentials from e-mail server.

Max Email attempts: 3

The e-mail process is abandoned after maximum attempt is attained.

 

Workflow of sending and retrieving e-mails

Outgoing and incoming mail are handled by two different types of server.

  • SMTP server to send e-mail
  • POP3/IMAP server to retrieve e-mail

You send email from your mail client (now running on Hawkeye server) by using the configured email address to the outgoing SMTP server using the configured port. The SMTP server first validates security and authentication, that is, connection security (SSL/TLS/25), port, username, password. The SMTP server works like the post office and performs a DNS lookup to find where to send the email (destination domain). The SMTP server may store the actual email on a local server (owned by domain sender) close to the Hawkeye server instead of the main SMTP server (that is, gmail in the above sample configuration). The SMTP server then sends the email to the destination domain Message Transfer Agent (MTA) server for long term storage. If the email destination domain is the same as the source (that is, gmail in the above sample configuration), the SMTP server will act as the MTA server. If different sender/dest email domain and no issues, it can be routed or forwarded. The email is sent by SMTP protocol to the (destination domain) MTA server. The received email is stored on the destination domain MTA (POP3/IMAP) server. The MTA (POP3/IMAP) server uses POP3 or IMAP protocol to transfer email to recipient’s inbox (email client on the computer) when requested.

 

Workflow of real service test e-mail

Real service test e-mail works by using an email client on the probe. Only the XR2000 currently supports an email client. Configuring the Email section of Preferences is not used in this case.

Configure real service test email

Configure the following parameters to send and receive real service test emails.

  • Sending email server credentials
  • Email address
  • Outgoing Mail server
  • Outgoing Mail port
  • SMTP authentication: SSL
  • SMTP Authentication user
  • SMPT Authentication password
  • Receiving email server credentials
  • Incoming mail server
  • Incoming mail port
  • Incoming mail protocol
  • Mail user
  • Mail Password

The real service test e-mail times different stages, but most important is when the destination POP3/IMAP server receives the sent email. Probe will poll every second to check received email.