Revision b920ed30
Von Max Wessendorf vor 12 Monaten hinzugefügt
| SL/BackgroundJob/ImportRecordEmails.pm | ||
|---|---|---|
|
|
||
|
=head1 SYNOPSIS
|
||
|
|
||
|
This background job imports emails from an imap folder for records. The emails are
|
||
|
This background job imports emails from an imap folder. The emails are
|
||
|
imported into the email journal and can be processed with functions from
|
||
|
SL::Helper::EmailProcessing.
|
||
|
|
||
|
=head1 CONFIGURATION
|
||
|
|
||
|
In kivitendo.conf the settings for the IMAP server can be specified. The
|
||
|
default config is under [record_emails_imap]. The config for a specific record
|
||
|
type is under [record_emails_imap/record_type/<record_type>]. The config for a
|
||
|
specific record type overwrites the default config. The data fields in the backgroundjob config can
|
||
|
overwrite single or all configration values.
|
||
|
The data field in the backgroundjob config contains all configration values:
|
||
|
|
||
|
=over 4
|
||
|
|
||
|
=item record_type
|
||
|
=item hostname
|
||
|
|
||
|
=item username
|
||
|
|
||
|
=item password
|
||
|
|
||
|
The record type to set for each imported email in the email journal. This is used to get
|
||
|
a specific config under [record_emails_imap/record_type/<record_type>]. The
|
||
|
default value is C<catch_all>
|
||
|
=item port
|
||
|
|
||
|
=item folder
|
||
|
|
||
|
The folder to sync emails from. Sub folders are separated by a forward slash,
|
||
|
e.g. 'INBOX/Archive'. Subfolders are not synced.
|
||
|
e.g. 'INBOX/Archive'. Subfolders are not synced. Default is 'INBOX'.
|
||
|
|
||
|
=item record_type
|
||
|
|
||
|
The record type to set for each imported email in the email journal.
|
||
|
|
||
|
=item processed_imap_flag
|
||
|
|
||
|
=item not_processed_imap_flag
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
=back
|
||
|
|
||
| config/kivitendo.conf.default | ||
|---|---|---|
|
# If SSL is used, default port is 993
|
||
|
ssl = 1
|
||
|
|
||
|
# Import emails for records with BackgroundJob ImportRecordEmails
|
||
|
# Config can specified per type with [record_emails_imap/record_type/<record_type>]
|
||
|
# More configuration is possible in the data field of the BackgroundJob, for more see
|
||
|
# SL::BackgroundJob::ImportRecordEmails
|
||
|
[record_emails_imap]
|
||
|
hostname = localhost
|
||
|
username =
|
||
|
password =
|
||
|
# Use / for subfolders. Subfolders are not imported.
|
||
|
base_folder = INBOX
|
||
|
# Port only needs to be changed if it is not the default port.
|
||
|
# port = 993
|
||
|
# If SSL is to be used, then set port to 993 or leave empty
|
||
|
ssl = 1
|
||
|
# Further possible values
|
||
|
# email_import_ids_to_delete = []
|
||
|
# process_imported_emails = [zugferd]
|
||
|
# processed_imap_flag = $Label3
|
||
|
# not_processed_imap_flag = $Label4
|
||
|
# record_type = ap_transaction # set in BackgroundJob to get a specific config
|
||
|
|
||
|
[applications]
|
||
|
# Location of OpenOffice.org/LibreOffice writer
|
||
|
openofficeorg_writer = lowriter
|
||
| doc/dokumentation.xml | ||
|---|---|---|
|
</listitem>
|
||
|
</itemizedlist>
|
||
|
|
||
|
<para>Alternativ ist auch eine Konfiguration über die kivi.conf möglich. Ein entsprechendes Beispiel findet sich in der kivi.conv.default</para>
|
||
|
|
||
|
</sect2>
|
||
|
</sect1>
|
||
|
|
||
Auch abrufbar als: Unified diff
Doku verschweigt Möglichkeiten in kivtendo.conf für ImportRecordEmails.pm und den Teil aus der kivitendo.conf.default genommen