Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 1166b3f9

Von Jan Büren vor 10 Monaten hinzugefügt

  • ID 1166b3f952a745ac1160cab4a7acbaf7d6b4cade
  • Vorgänger f3983c6d
  • Nachfolger 78ec52fa

Erweiterung Parameter für Background-Job

Unterschiede anzeigen:

SL/BackgroundJob/ImportRecordEmails.pm
200 200

  
201 201
=head1 CONFIGURATION
202 202

  
203
The data field in the backgroundjob config contains all configration values:
203
The data field in the backgroundjob config contains all configuration values:
204 204

  
205 205
=over 4
206 206

  
207 207
=item hostname
208 208

  
209
required, hostname of IMAP server
210

  
209 211
=item username
210 212

  
213
required, login for IMAP server
214

  
211 215
=item password
212 216

  
217
required, password for login of IMAP server
218

  
213 219
=item port
214 220

  
221
optional Parameter IMAP port
222

  
215 223
=item folder
216 224

  
217
The folder to sync emails from. Sub folders are separated by a forward slash,
225
required, The IMAP folder to import emails from. Sub folders are separated by a forward slash,
218 226
e.g. 'INBOX/Archive'. Subfolders are not synced. Default is 'INBOX'.
219 227

  
220 228
=item record_type
221 229

  
222
The record type to set for each imported email in the email journal.
230
optional, The record type to set for each imported email in the email journal.
231
Default is catch-all. Valid types are the well-known types of kivitendo records, ie ar_transaction, ap_transaction
232

  
233
=item process_imported_emails
234

  
235
optional, more processing can be automatically done in the job.
236
Valid actions are defined in SL::Helper::EmailProcessing.pm
237

  
238
Take a look at currently supported actions with
239

  
240
 perldoc SL/Helper/EmailProcessing.pm
241

  
223 242

  
224 243
=item processed_imap_flag
225 244

  
226
=item not_processed_imap_flag
245
Optional, requires a valid value in process_imported_emails
227 246

  
247
If process_imported_emails is set and the process is successfully
248
executed this custom IMAP Flag is added to the processed email.
228 249

  
250
=item not_processed_imap_flag
229 251

  
252
Optional, requires a valid value in process_imported_emails
253

  
254
If process_imported_emails is set and the process is NOT
255
successfully executed this custom IMAP Flag is added
256
to the processed email.
257

  
258
=head1 YAML Configuration example with ZUGFeRD Processing
259
    hostname: meinedomain.de
260
    username: eingangsrechnung@meinedomain.de
261
    password: secret
262
    folder: INBOX/vollimport
263
    record_type: ap_transaction
264
    process_imported_emails: zugferd
265
    processed_imap_flag: $Label8
266
    not_processed_imap_flag: $Label1
230 267

  
231 268
=back
232 269

  

Auch abrufbar als: Unified diff