Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Role required: admin.

Email account is the set of options that is responsible for the configuration of email processing. It can be a pre-configured account with the SMTP protocol (for sending emails), POP3 protocol (for receiving emails), and IMAP protocol (for sending and receiving emails).

TipRole required: admin

Use the simple.email.smtp.active property to enable or disable email sending from the account. 

To set it up, complete the steps below:

  1. Navigate to System Properties → All Properties.
  2. Find the simple.email.smtp.active property record using the list search boxesand open it.
  3. In the Value field, enter true to enable email sending, or false to disable it.
  4. Click Save or Save and Exit to apply the changes.

The email account configuration includes the following steps:

  1. Creating an email account
  2. Testing the connection (optional)
  3. Configuring default settings.

Creating an email account 
Anchor
creating an email account
creating an email account


Tip

It is recommended to configure email accounts within the Simple application due to the fact that Email Properties are located in this application. The email tuning will become easier if necessary properties and email accounts share the same application.

To create an email account, please complete the following steps:

  1. Navigate to the System Mailboxes → Email Accounts.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply changes.
Test Connection  Anchortest connectiontest connection

When you finish configuring the email account.

To test the connection, please follow these steps:

  • Select the Enable Debug checkbox and click Save.
  • Scroll down to the Related Links area (above the Related Lists area).
  • Click the Test Connection link.
  • If the connection is set, make the created account default.

In the Log (sys_log) table, you can track the operation processing:

  1. Navigate to System Logs → Main Log.
  2. Apply this filter: Source is Email Logger.
  3. Open a record if needed.

In our example, we set up an IMAP email account. In the screenshot below:

  1. IMAP authorization session has been set up.
  2. After the successful authorization, the list of email IDs was called from the server.
  3. The call was processed, and the list was received.

Image Removed

If connection fails, a warning message appears:

Image Removed

In this case, check logs to find the error cause. To perform this, navigate to System Logs → Main Log and make a log selection based on the criteria below:

  • Source = Email Logger
    AND
  • Level = Error

Use Condition Builder to build an appropriate filter. An example of the error record is given below:

Image Removed

Default email account Anchordefault email accountdefault email account

To start using the created email account, set your email accounts as default ones. The system will insert them automatically into every letter, incoming or outgoing.

To do this, complete the following steps:

  • Navigate to the System Mailboxes → Email Accounts.
  • Open the record you need.
  • Find the email account ID in the address bar (it is a long number sequence), and copy it to the clipboard. 

    Section

    Image Removed

  • Navigate to the System Properties → System Properties.
  • Find the default.email.account.send property using the search box.
  • Paste the email account ID from the clipboard in the Value field.
  • /

    /

    Table of Contents
    absoluteUrltrue
    classfixedPosition
    printablefalse

    Email Account form fields

    FieldMandatoryDescription
    NameYSpecify the displayed account name.
    TypeY

    Define the account type, based on a specific protocol. Available options:

    • SMTP
    • IMAP
    • POP3
    Info

    When SMTP option is selected, the From field appears on the form.


    FromY

    Sender address to be displayed in the From field of the message.

    Info

    This field appears when the SMTP option is selected in the Type field.


    ServerYSpecify the hostname of the server used for the mail processing.
    LoginYServer user login.
    PasswordYServer user password.
    Email user labelNDescriptive user label.
    ActiveNSelect this checkbox to activate the account.
    Enable debugNSelect this checkbox to have more extended logs. This will help to indicate issues while configuring email settings.
    PortYSpecify the port that the server will be running on.
    Enable SSLNSelect this checkbox to enable SSL encryption.
    Enable TLSNSelect this checkbox to enable TLS encryption.
    Disable certificate validationN

    Select this checkbox to allow connecting to the email server without checking the certificate. Disable Certificate Validation is unselected by default.

    Tip

    Disabling the validation is helpful when a self-signed certificate is used.


    Panel

    Email account is the set of options that is responsible for the configuration of email processing. It can be a pre-configured account with the SMTP protocol (for sending emails), POP3 protocol (for receiving emails), and IMAP protocol (for sending and receiving emails).

    Tip

    Role required: admin.

    The email account configuration includes the following steps:

    1. Creating an email account
    2. Testing the connection (optional)
    3. Configuring default settings.
    Creating an email account  Anchorcreating an email accountcreating an email account
    Tip

    It is recommended to configure email accounts within the Simple application due to the fact that Email Properties are located in this application. The email tuning will become easier if necessary properties and email accounts share the same application.

    To create an email account, please complete the following steps:

    1. Navigate to the System Mailboxes → Email Accounts.
    2. Click New and fill in the fields.
    3. Click Save or Save and Exit to apply changes.

    The simple.email.test.user property allows specifying a test email address for email debugging. After set up, all mail sent from the instance will be redirected to this address.

    To set it up, please complete the steps below:

    1. Navigate to System Properties → All Properties.
    2. Find the simple.email.test.user property record using the list search boxesand open it.
    3. In the Value field, enter the text you need.
    4. Click Save or Save and Exit to apply changes.

    Test

    Connection 

    connection
    Anchor
    test connection
    test connection


    When you finish configuring the email account.

    To test the connection, please follow these steps:

    • Select the Enable Debug checkbox and click Save.
    • Scroll down to the Related Links area (above the Related Lists area).
    • Click the Test Connection link.
    • If the connection is set, make the created account default.

    In the Log (sys_log) table, you can track the operation processing:

    1. Navigate to System Logs → Main Log.
    2. Apply this filter: Source is Email Logger.
    3. Open a record if needed.

    Main Log form fields

    Field

    Mandatory

    Description

    SourceYThe source from where the message was produced (IMAP Authorization, SMTP Authorization, Incoming mail, and others).
    LevelY

    Message category:

    • Debug – debug message
    • Info – information message
    • Warning – warning message
    • Error – error message.
    MessageNThe message containing information about the 
    UsernameNThe name of a user who created the log or the system if it was created automatically.
    Created byY

    Information about who has created the record.

    Created atYThis field stores information about the date and time of record creation.


    In our example, we set up an IMAP email account. In the screenshot below:

    1. IMAP authorization session has been set up.
    2. After the successful authorization, the list of email IDs was called from the server.
    3. The call was processed, and the list was received.


    If connection fails, a warning message appears:

    In this case, check logs to find the error cause. To perform this, navigate to System Logs → Main Log and and make a log selection based on the criteria below:

    • Source = Email Logger
      AND
    • Level = Error

    Use Condition Builder to build an appropriate filter. An example of the error record is given below:

    Default email account
    Anchor
    default email account
    default email account


    To start using the created email account, set your email accounts as default ones. The system will insert them automatically into every letter, incoming or outgoing.

    To do this, complete the following steps:

    1. Navigate to the System Mailboxes → Email Accounts.
    2. Open the record you need.
    3. Find the email account ID in the address bar (it is a long number sequence), and copy it to the clipboard. 

      Section


    4. Navigate to the System Properties → System Properties → All Properties.
    5. Find the default.email.account.send property using the search box.
    6. In the Value field, paste the email account ID from the clipboard.
    7. Click Save or Save and Exit.
    /

    /


    Table of Contents
    absoluteUrltrue
    classfixedPosition
    printablefalse