Previous Topic: usp_lrel_true_bhv_true TableNext Topic: usp_mailbox_artifact_type Table


usp_mailbox Table

A mailbox object represents a connection to a mail server for a single inbox. The usp_mailbox table lists the filter, policy, and actions that must occur for an inbox.

Label

Field

Data Type

Reference

Description

id

 

INTEGER

UNIQUE KEY

 

Specifies the primary key of this table.

 

last_mod_dt

LOCAL_TIME

 

Specifies the time stamp of when this record was last modified.

 

last_mod_by

UUID REF

ca_contact

Specifies the UUID of the contact who last modified this record.

Active

del

INTEGER

NOT_NULL

 

Specifies if the mailbox is active. Inactive mailboxes are not polled.

Check Interval

check_interval

INTEGER

 

Specifies the number of seconds to wait between checks of the mailbox. 30 seconds is the default.

Name

name

STRING 60

UNIQUE

S_KEY

 

Names the mailbox connection

Allow Anonymous

allow_anonymous

INTEGER

 

Allows messages to create or update tickets with sender addresses not attached to a known Contact.

Email Type

email_type

STRING 10

 

Specifies the email type: NONE, IMAP, or POP3. If NONE is selected, the mailbox is not polled.

Hostname

host_name

STRING 128

 

Specifies the host name or IP address of the mail server.

Port Override

host_port

INTEGER

 

Specifies a port number to override the default for Email Type. The default is 110 for POP3 and 143 for IMAP.

Userid

userid

STRING 64

 

Specifies the userid to log in to the mail server.

Password

password

STRING 64

 

Specifies the password for userid.

Security Level

security_lvl

INTEGER

 

Specifies a security level for encoding of login information:

  • 0—Clear Text
  • 1—APOP (POP3 only)
  • 2—NTLM
  • 3—MD5

Attachment Repository

attmnt_repository

STRING 60

Document_Repository

Specifies the repository for attachments. The repository must be local to pdm_maileater_nxd. If not specified, the mailbox is not polled.

Attach Entire Email

attach_email

INTEGER

 

Attaches the entire email to a ticket. This option overrides the default value of splitting out attachments.

Force Attachment Splitout

split_out_ attachment

INTEGER

 

Forces attachment split out if attach Entire Email is set. The entire message and individual attachments are all attached to the ticket.

Save Unknown Emails

save_unknown_ emails

INTEGER

 

Saves emails that are not able to be processed in NX_ROOT/site/unknown_mails.

Description

description

STRING 1000

 

Describes the mailbox.

Email Address/Hour

email_address_ per_hour

INTEGER

 

Specifies the maximum number of emails per email address per hour. You can specify the following values:

  • -1—No limit (default)
  • 0—No emails allowed.
  • 1 or more—Maximum number of emails allowed.

Log Violation

log_policy_violation

INTEGER

usp_mailbox_violation_ log_type

Controls logging of policy violations to the standard log.You can specify the following values:

  • Do not log
  • First violation only (default)
  • All violations

Inclusion List

inclusion_list

STRING 32768

 

Specifies email addresses or domains that are allowed to process emails—only emails matching the list are allowed. You can specify multiple addresses or domains by delimiting them with a space character or new line.

Exclusion Lists

exclusion_list

STRING 32768

 

Specifies email addresses or domains that are not allowed to process emails. You can specify multiple addresses or domains by delimiting them with a space character or new line.

 

tenant

UUID

ca_tenant

Specifies the tenant.