OTRS Academy » Documentation » Configuration Options Reference » Core → Email

Core → Email

August 13, 2024

AdminEmail

Defines the system administrator’s email address.

This setting can not be deactivated.

Default value:

support@<OTRS_CONFIG_FQDN>

CheckEmailAddresses

Makes the application check the syntax of email addresses.

This setting can not be deactivated.

Default value:

1

CheckEmailInvalidAddress

Defines a regular expression that filters all email addresses that should not be used in the application.

This setting can not be deactivated.

Default value:

@(example)\.(..|...)$

CheckEmailValidAddress

Defines a regular expression that excludes some addresses from the syntax check (if “CheckEmailAddresses” is set to “Yes”). Please enter a regex in this field for email addresses, that aren’t syntactically valid, but are necessary for the system (i.e. “root@localhost”).

This setting can not be deactivated.

Default value:

^(root@localhost|admin@localhost)$

CheckMXRecord

Makes the application check the MX record of email addresses before sending an email or submitting a telephone or email ticket.

This setting can not be deactivated.

Default value:

1

CheckMXRecord::Nameserver

Defines the address of a dedicated DNS server, if necessary, for the “CheckMXRecord” look-ups.

This setting is not active by default.

Default value:

ns.example.com

Fetchmail::Bin

Defines the fall-back path to open fetchmail binary. Note: The name of the binary needs to be ‘fetchmail’, if it is different please use a symbolic link.

This setting is not active by default.

Default value:

/usr/bin/fetchmail

NotificationSenderEmail

Specifies the email address that should be used by the application when sending notifications. The email address is used to build the complete display name for the notification master (i.e. “OTRS Notifications” <otrs@your.example.com>). You can use the OTRS_CONFIG_FQDN variable as set in your configuration, or choose another email address.

This setting can not be deactivated.

Default value:

otrs@<OTRS_CONFIG_FQDN>

NotificationSenderName

Specifies the name that should be used by the application when sending notifications. The sender name is used to build the complete display name for the notification master (i.e. “OTRS Notifications” <otrs@your.example.com>).

This setting can not be deactivated.

Default value:

OTRS Notifications

Sendmail::DefaultHeaders

Defines default headers for outgoing emails.

This setting is not active by default.

Default value:

---
'Auto-Submitted:': auto-generated
'Precedence:': bulk

Sendmail::Template

Defines a template for manipulating data mapping of outgoing emails. All email specific data are available for the mapping. Additionally any ticket related data including dynamic fields are provided if an article is sent. The following mappings: “To”, “From”, “Subject”, “Body” and “Charset” are added automatically, but can be overwritten. Desired additional email headers are set via the “CustomHeaders” element. Any empty element (e.g. due to missing mapping data) is rejected.

This setting is not active by default.

Default value:

---
X-OTRS-TicketNumber: TicketNumber

SendmailBcc

Sends all outgoing email via bcc to the specified address. Please use this only for backup reasons.

Default value:

''

SendmailEncodingForce

Forces encoding of outgoing emails (7bit|8bit|quoted-printable|base64).

This setting is not active by default.

Default value:

base64

SendmailEnvelopeFrom

If set, this address is used as envelope sender in outgoing messages (not notifications – see below). If no address is specified, the envelope sender is equal to queue e-mail address.

This setting is not active by default.

Default value:

''

SendmailModule

Defines the module to send emails. “DoNotSendEmail” doesn’t send emails at all. Any of the “SMTP” mechanisms use a specified (external) mailserver. “Sendmail” directly uses the sendmail binary of your operating system. “Test” doesn’t send emails, but writes them to $OTRS_HOME/var/tmp/CacheFileStorable/EmailTest/ for testing purposes.

This setting can not be deactivated.

Default value:

Kernel::System::Email::Sendmail

SendmailModule::AuthPassword

If any of the “SMTP” mechanisms was selected as SendmailModule, and authentication to the mail server is needed, a password must be specified.

This setting is not active by default.

Default value:

MailserverPassword

SendmailModule::AuthUser

If any of the “SMTP” mechanisms was selected as SendmailModule, and authentication to the mail server is needed, an username must be specified.

This setting is not active by default.

Default value:

MailserverLogin

SendmailModule::CMD

If “Sendmail” was selected as SendmailModule, the location of the sendmail binary and the needed options must be specified.

This setting can not be deactivated.

Default value:

/usr/sbin/sendmail -i -f

SendmailModule::Host

If any of the “SMTP” mechanisms was selected as SendmailModule, the mailhost that sends out the mails must be specified.

This setting can not be deactivated.

Default value:

mail.example.com

SendmailModule::Port

If any of the “SMTP” mechanisms was selected as SendmailModule, the port where your mailserver is listening for incoming connections must be specified.

This setting is not active by default.

Default value:

25

SendmailModule::SSL::CaFile

SSL CA file path.

This setting is not active by default.

Default value:

''

SendmailModule::SSL::CaPath

SSL CA certificates path.

This setting is not active by default.

Default value:

''

SendmailModule::SSL::Fingerprint

SSL certificate fingerprint.

This setting is not active by default.

Default value:

''

SendmailModule::SSL::VerifyCN_Name

SSL CN name to verify.

This setting is not active by default.

Default value:

''

SendmailModule::SSL::VerifyMode

Enable SSL checks.

This setting is not active by default.

Default value:

0

SendmailNotificationEnvelopeFrom

If set, this address is used as envelope sender header in outgoing notifications. If no address is specified, the envelope sender header is empty (unless SendmailNotificationEnvelopeFrom::FallbackToEmailFrom is set).

This setting is not active by default.

Default value:

''

SendmailNotificationEnvelopeFrom::FallbackToEmailFrom

If no SendmailNotificationEnvelopeFrom is specified, this setting makes it possible to use the email’s from address instead of an empty envelope sender (required in certain mail server configurations).

This setting is not active by default.

Default value:

0

AgentFrontend::TicketCreate::Email###001-Framework

The default column layout configuration for the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
BusinessObjectType: Ticket
ColumnLayout:
  OneColumn:
    '1':
    - Name: CreateProperties
    - Name: CustomerInformation
    - Name: CustomerUserHistory
    - Name: CustomerHistory
  ThreeColumns:
    '1':
    - Name: CreateProperties
    '2':
    - Name: CustomerInformation
    '3':
    - Name: CustomerUserHistory
    - Name: CustomerHistory
  TwoColumns:
    '1':
    - Name: CreateProperties
    '2':
    - Name: CustomerInformation
    - Name: CustomerUserHistory
    - Name: CustomerHistory
Type: BusinessObjectCreate

AgentFrontend::TicketCreate::Email###100-Custom

User-defined configuration extensions for the column layouts of the New Email Ticket screen. With this configuration you can only add keys to the framework configuration, it is not possible to change or remove keys. See the related configuration ended with “###001-Framework”.

Default value:

---
ColumnLayout: ~

AgentFrontend::TicketCreate::Email###110-OTRSCustomContactInformation

User-defined configuration extensions for the column layouts of the New Email Ticket screen. With this configuration you can only add keys to the framework configuration, it is not possible to change or remove keys. See the related configuration ended with “###001-Framework”.

Default value:

---
ColumnLayout:
  OneColumn:
    '1':
    - Name: CustomContactInformation
  ThreeColumns:
    '2':
    - Name: CustomContactInformation
  TwoColumns:
    '2':
    - Name: CustomContactInformation

AgentFrontend::TicketCreate::Email::Widget###CreateProperties

Default configuration for the Properties widget of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  Active: 1
  Config: {}
  IsAlwaysPresent: 1
  IsDuplicatable: 0
  IsVisible: 1
  Title: Properties
Group: []
GroupRo: []
Type: CreateProperties

AgentFrontend::TicketCreate::Email::Widget###CustomContactInformation

Default configuration for the Contact Information widget of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  Active: 1
  Config: {}
  IsAlwaysPresent: 0
  IsDuplicatable: 1
  IsVisible: 1
  Title: Contact Information
Group: []
Type: CustomContactInformation

AgentFrontend::TicketCreate::Email::Widget###CustomerHistory

Default configuration for the Customer History widget of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  Active: 1
  Config: {}
  IsAlwaysPresent: 0
  IsDuplicatable: 1
  IsVisible: 1
  Title: Customer History
Group: []
GroupRo: []
Type: CustomerHistory

AgentFrontend::TicketCreate::Email::Widget###CustomerInformation

Default configuration for the Customer Information widget of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  Active: 1
  Config:
    ShowPropertyOnEmpty: 1
  IsAlwaysPresent: 0
  IsDuplicatable: 1
  IsVisible: 1
  Title: Customer Information
Group: []
GroupRo: []
Type: CustomerInformation

AgentFrontend::TicketCreate::Email::Widget###CustomerUserHistory

Default configuration for the Customer User History widget of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  Active: 1
  Config: {}
  IsAlwaysPresent: 0
  IsDuplicatable: 1
  IsVisible: 1
  Title: Customer User History
Group: []
GroupRo: []
Type: CustomerUserHistory

AgentFrontend::TicketCreate::Email::WidgetType###CreateProperties

Default configuration for the Properties widget type of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  Collapsed: 0
  Hidden: 0
  SubmitButtonText: Send email
Module: Kernel::WebApp::Util::BusinessObject::Widget::Ticket::CreateProperties

AgentFrontend::TicketCreate::Email::WidgetType###CustomerHistory

Default configuration for the Customer History widget type of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  ActiveFilters: {}
  AdditionalExportColumns:
    ArticleTree: 0
  AvailableDynamicFieldFilters: []
  BusinessObjectType: Ticket
  Collapsed: 0
  Columns:
    Age:
      IsVisible: 1
    Changed:
      IsVisible: 1
    Created:
      IsVisible: 2
    CustomerCompanyName:
      IsVisible: 1
    CustomerID:
      IsVisible: 2
    CustomerName:
      IsVisible: 1
    CustomerUserID:
      IsVisible: 1
    EscalationResponseTime:
      IsVisible: 1
    EscalationSolutionTime:
      IsVisible: 1
    EscalationTime:
      IsVisible: 1
    EscalationUpdateTime:
      IsVisible: 1
    Lock:
      IsVisible: 2
    Owner:
      IsVisible: 2
    PendingTime:
      IsVisible: 1
    Priority:
      IsVisible: 1
    Queue:
      IsVisible: 2
    Responsible:
      IsVisible: 1
    SLA:
      IsVisible: 1
    Sender:
      IsVisible: 2
    Service:
      IsVisible: 1
    State:
      IsVisible: 2
    Subject:
      IsVisible: 1
    TicketNumber:
      IsVisible: 2
    Title:
      IsVisible: 2
    Type:
      IsVisible: 1
    Watch:
      IsVisible: 2
  DefaultColumnOrder:
  - TicketNumber
  - State
  - Title
  - Priority
  - Created
  - Age
  - Changed
  - PendingTime
  - EscalationTime
  - EscalationUpdateTime
  - EscalationResponseTime
  - EscalationSolutionTime
  - Sender
  - Subject
  - Lock
  - Queue
  - Owner
  - Responsible
  - CustomerID
  - CustomerCompanyName
  - CustomerName
  - CustomerUserID
  - Type
  - Service
  - SLA
  - Watch
  FilterPresets: {}
  Hidden: 0
  HideAvailableFilters: []
  ItemsPerPage: 10
  Limit: 1000
  SortBy:
  - Column: Created
    Direction: Down
  Type: BusinessObject
Module: Kernel::WebApp::Util::BusinessObject::Widget::Ticket::CustomerHistory

AgentFrontend::TicketCreate::Email::WidgetType###CustomerUserHistory

Default configuration for the Customer User History widget type of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
Config:
  ActiveFilters: {}
  AdditionalExportColumns:
    ArticleTree: 0
  AvailableDynamicFieldFilters: []
  BusinessObjectType: Ticket
  Collapsed: 0
  Columns:
    Age:
      IsVisible: 1
    Changed:
      IsVisible: 1
    Created:
      IsVisible: 2
    CustomerCompanyName:
      IsVisible: 1
    CustomerID:
      IsVisible: 2
    CustomerName:
      IsVisible: 1
    CustomerUserID:
      IsVisible: 1
    EscalationResponseTime:
      IsVisible: 1
    EscalationSolutionTime:
      IsVisible: 1
    EscalationTime:
      IsVisible: 1
    EscalationUpdateTime:
      IsVisible: 1
    Lock:
      IsVisible: 2
    Owner:
      IsVisible: 2
    PendingTime:
      IsVisible: 1
    Priority:
      IsVisible: 1
    Queue:
      IsVisible: 2
    Responsible:
      IsVisible: 1
    SLA:
      IsVisible: 1
    Sender:
      IsVisible: 2
    Service:
      IsVisible: 1
    State:
      IsVisible: 2
    Subject:
      IsVisible: 1
    TicketNumber:
      IsVisible: 2
    Title:
      IsVisible: 2
    Type:
      IsVisible: 1
    Watch:
      IsVisible: 2
  DefaultColumnOrder:
  - TicketNumber
  - State
  - Title
  - Priority
  - Created
  - Age
  - Changed
  - PendingTime
  - EscalationTime
  - EscalationUpdateTime
  - EscalationResponseTime
  - EscalationSolutionTime
  - Sender
  - Subject
  - Lock
  - Queue
  - Owner
  - Responsible
  - CustomerID
  - CustomerCompanyName
  - CustomerName
  - CustomerUserID
  - Type
  - Service
  - SLA
  - Watch
  FilterPresets: {}
  Hidden: 0
  ItemsPerPage: 10
  Limit: 1000
  SortBy:
  - Column: Created
    Direction: Down
  Type: BusinessObject
Module: Kernel::WebApp::Util::BusinessObject::Widget::Ticket::CustomerUserHistory

Forms###AgentFrontend::TicketCreate::Email::CreateProperties

Configurable form for the Properties widget of the New Email Ticket screen.

This setting can not be deactivated.

Default value:

---
- Collapsible: 1
  Fields:
  - Name: TypeID
  Label: Classification
- Collapsible: 1
  Fields:
  - Name: CustomerUserID
  - Disabled: 1
    Name: CustomerID
  Label: Customer
- Collapsible: 1
  Fields:
  - ColumnLayout: 3
    Fields:
    - Name: QueueID
  - ColumnLayout: 3
    Fields:
    - Name: OwnerID
  - ColumnLayout: 3
    Fields:
    - Name: ResponsibleID
  Label: Assignment
- Collapsible: 1
  Fields:
  - ColumnLayout: 3
    Fields:
    - Name: ServiceID
      Required: 0
  - ColumnLayout: 3
    Fields:
    - Name: SLAID
      Required: 0
  - ColumnLayout: 3
    Fields:
    - Default: 3
      Name: PriorityID
      Required: 1
  - ColumnLayout: 3
    Fields:
    - Config:
        StateType:
        - open
        - pending auto
        - pending reminder
        - closed
      Default: 4
      Name: StateID
      Required: 1
  - ColumnLayout: 3
    Fields:
    - Name: PendingDate
  Label: Service Level Management
- Collapsible: 1
  Fields:
  - Name: To
  - Name: Cc
  - Name: Bcc
  - Name: StandardTemplateID
  - Name: Subject
    Required: 1
  - Name: KnowledgeBaseArticleAddToObject
  - Name: Body
    Required: 1
  - Name: RelevantKnowledge
  - Name: EmailSecurity
  - Name: Signature
  - Name: Attachments
  - Name: AccountedTime
  Label: Communication
- Default: EmailAgent
  Hidden: 1
  Name: HistoryType
- Default: ''
  Hidden: 1
  Name: HistoryComment
- Default: agent
  Hidden: 1
  Name: SenderType
- Default: 1
  Hidden: 1
  Name: IsVisibleForCustomer
- Hidden: 1
  Name: LinkTicketID
- Hidden: 1
  Name: LinkType
- Hidden: 1
  Name: EndpointContext
FacebookXEmailLinkedIn
Scroll to Top