Revision b920ed30
Von Max Wessendorf vor 10 Monaten hinzugefügt
| SL/BackgroundJob/ImportRecordEmails.pm | ||
|---|---|---|
| 194 | 194 |
|
| 195 | 195 |
=head1 SYNOPSIS |
| 196 | 196 |
|
| 197 |
This background job imports emails from an imap folder for records. The emails are
|
|
| 197 |
This background job imports emails from an imap folder. The emails are |
|
| 198 | 198 |
imported into the email journal and can be processed with functions from |
| 199 | 199 |
SL::Helper::EmailProcessing. |
| 200 | 200 |
|
| 201 | 201 |
=head1 CONFIGURATION |
| 202 | 202 |
|
| 203 |
In kivitendo.conf the settings for the IMAP server can be specified. The |
|
| 204 |
default config is under [record_emails_imap]. The config for a specific record |
|
| 205 |
type is under [record_emails_imap/record_type/<record_type>]. The config for a |
|
| 206 |
specific record type overwrites the default config. The data fields in the backgroundjob config can |
|
| 207 |
overwrite single or all configration values. |
|
| 203 |
The data field in the backgroundjob config contains all configration values: |
|
| 208 | 204 |
|
| 209 | 205 |
=over 4 |
| 210 | 206 |
|
| 211 |
=item record_type |
|
| 207 |
=item hostname |
|
| 208 |
|
|
| 209 |
=item username |
|
| 210 |
|
|
| 211 |
=item password |
|
| 212 | 212 |
|
| 213 |
The record type to set for each imported email in the email journal. This is used to get |
|
| 214 |
a specific config under [record_emails_imap/record_type/<record_type>]. The |
|
| 215 |
default value is C<catch_all> |
|
| 213 |
=item port |
|
| 216 | 214 |
|
| 217 | 215 |
=item folder |
| 218 | 216 |
|
| 219 | 217 |
The folder to sync emails from. Sub folders are separated by a forward slash, |
| 220 |
e.g. 'INBOX/Archive'. Subfolders are not synced. |
|
| 218 |
e.g. 'INBOX/Archive'. Subfolders are not synced. Default is 'INBOX'. |
|
| 219 |
|
|
| 220 |
=item record_type |
|
| 221 |
|
|
| 222 |
The record type to set for each imported email in the email journal. |
|
| 223 |
|
|
| 224 |
=item processed_imap_flag |
|
| 225 |
|
|
| 226 |
=item not_processed_imap_flag |
|
| 227 |
|
|
| 228 |
|
|
| 229 |
|
|
| 221 | 230 |
|
| 222 | 231 |
=back |
| 223 | 232 |
|
| config/kivitendo.conf.default | ||
|---|---|---|
| 190 | 190 |
# If SSL is used, default port is 993 |
| 191 | 191 |
ssl = 1 |
| 192 | 192 |
|
| 193 |
# Import emails for records with BackgroundJob ImportRecordEmails |
|
| 194 |
# Config can specified per type with [record_emails_imap/record_type/<record_type>] |
|
| 195 |
# More configuration is possible in the data field of the BackgroundJob, for more see |
|
| 196 |
# SL::BackgroundJob::ImportRecordEmails |
|
| 197 |
[record_emails_imap] |
|
| 198 |
hostname = localhost |
|
| 199 |
username = |
|
| 200 |
password = |
|
| 201 |
# Use / for subfolders. Subfolders are not imported. |
|
| 202 |
base_folder = INBOX |
|
| 203 |
# Port only needs to be changed if it is not the default port. |
|
| 204 |
# port = 993 |
|
| 205 |
# If SSL is to be used, then set port to 993 or leave empty |
|
| 206 |
ssl = 1 |
|
| 207 |
# Further possible values |
|
| 208 |
# email_import_ids_to_delete = [] |
|
| 209 |
# process_imported_emails = [zugferd] |
|
| 210 |
# processed_imap_flag = $Label3 |
|
| 211 |
# not_processed_imap_flag = $Label4 |
|
| 212 |
# record_type = ap_transaction # set in BackgroundJob to get a specific config |
|
| 213 |
|
|
| 214 | 193 |
[applications] |
| 215 | 194 |
# Location of OpenOffice.org/LibreOffice writer |
| 216 | 195 |
openofficeorg_writer = lowriter |
| doc/dokumentation.xml | ||
|---|---|---|
| 1715 | 1715 |
</listitem> |
| 1716 | 1716 |
</itemizedlist> |
| 1717 | 1717 |
|
| 1718 |
<para>Alternativ ist auch eine Konfiguration über die kivi.conf möglich. Ein entsprechendes Beispiel findet sich in der kivi.conv.default</para> |
|
| 1719 |
|
|
| 1720 | 1718 |
</sect2> |
| 1721 | 1719 |
</sect1> |
| 1722 | 1720 |
|
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