Skip to end of metadata
Go to start of metadata

Plik konfiguracyjny zawiera ustawienia modułu Plus E-faktura i składa się z następujących sekcji odpowiedzialnych za poszczególne fragmenty funkcjonalności. Niezbędne jest zachowanie obecności wszystkich pól, identycznych nazw każdej z sekcji oraz identycznych nazw wszystkich pól w każdej sekcji, o ile specyfikacja nie definiuje nieobowiązkowych pól.


Szablon pliku konfiguracyjnego modułu Plus E-Faktura można pobrać tutaj.

Sekcja MailboxesParams

[MailboxesParams]
Emails=
EmailsLogins=
EmailsPasswords=
IncomingEmailsPorts=
OutgoingEmailsPorts=
EmailsServers=
Authentications=
SSLs=
StartTLSs=
NTLMs=
RecentModes=
IMAPsPartialFetch=
SharedAccounts=
MailboxesFolders=
Protocols=
IncomingEmailsServers=
OutgoingEmailsServers=
OAuth=

 

gdzie:

  • Emails – są to adresy monitorowanych skrzynek mailowych, można umieścić ich więcej rozdzielając poszczególne adresy średnikiem ";"

  • EmailsLogins – są to nazwy opisujące poszczególne adresy mailowe (login bądź pełen adres, bądź inna definicja użytkownika), może występować ich więcej, wtedy rozdzielone są średnikiem ";”

  • EmailsPasswords – pole odpowiadające za hasła do wymienionych skrzynek mailowych, gdy występuje większa ilość skrzynek, poszczególne hasła rozdzielamy średnikiem ";"

  • IncomingEmailsPorts – są to numery portów dla poczty przychodzącej, kolejne numery portów są rozdzielone średnikiem ";"

  • OutgoingEmailsPorts – są to numery portów dla poczty wychodzącej, kolejne numery portów są rozdzielone średnikiem ";"

  • EmailsServers – określa nazwy serwerów poczty przychodzącej i wychodzącej, na których są umieszczone skrzynki pocztowe, kolejne nazwy serwerów są rozdzielone średnikiem ";"

  • Authentications – czy przeprowadzać uwierzytelnianie, może przyjmować wartości TRUE lub FALSE, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";"

  • SSLs – określa, czy logowanie do skrzynki mailowej ma się odbywać za pomocą połączenia SSL (automatycznie dodawany jest certyfikat, jeżeli jest to wymagane przez skrzynkę mailową), kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";"

  • StartTLSs – określa, czy logowanie do skrzynki mailowej ma się odbywać za pomocą szyfrowania TLS, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";"

  • NTLMs – określa, czy autentykacja użytkownika skrzynki mailowej ma się odbywać za pomocą NTLM, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";"

  • RecentModes – określa, czy wykorzystać recent mode podczas łączenia ze skrzynką mailową, skutkuje do dodaniem przedrostka recent: przed loginem użytkownika, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";"

  • IMAPsPartialFetch - określa, czy wykorzystać partial fetch podczas łączenia ze skrzynką mailową za pomocą protokołu IMAP, domyślnie funkcja ta jest wykorzystywana, wyłączenie jej może skutkować spowolnieniem pobierania wiadomości ze skrzynki mailowej, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";"

  • SharedAccounts - określa, czy łączenie odbywa się do konta udostępnionego (shared mailbox)

  • MailboxesFolders – określa nazwę folderu wiadomości odebranych, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";", wartość domyślna: INBOX

  • Protocols – określa nazwę protokołu, jaki jest używany do odczytu poczty z danej monitorowanej skrzynki, kolejne wartości dla różnych skrzynek należy oddzielić średnikiem ";", a dozwolone wrtości to POP3 lub IMAP, jeżeli własność Protocols nie występuje do każdej ze skrzynek jest wykorzystywany protokół POP3

  • IncomingEmailsServers – określa nazwy serwerów poczty przychodzącej, kolejne nazwy serwerów są rozdzielone średnikiem ";", możliwe jest pozostawienie pustej wartości, wtedy pod uwagę brane są serwery podane w EmailsServers

  • OutgoingEmailsServers – określa nazwy serwerów poczty wychodzącej, kolejne nazwy serwerów są rozdzielone średnikiem ";", możliwe jest pozostawienie pustej wartości, wtedy pod uwagę brane są serwery podane w EmailsServers

  • OAuth – określa czy wartość podana w EmailsPasswords to hasło do skrzynki pocztowej, czy id połączenia ze skrzynką za pomocą OAuth2 (id możemy znaleźć w nowej zakładce konfiguracji skrzynki pocztowej). Przyjmuje wartości TRUE lub FALSE, wartość TRUE oznacza, że EmailPasswords przechowuje id połączenia za pomocą OAuth2. Dla większej ilości haseł wartości rozdzielamy średnikiem ";"

Ważne, żeby odpowiednie parametry dla danej skrzynki pocztowej znajdowały się we właściwym miejscu ciągu znakowego rozdzielonego średnikami w odniesieniu do swojego adresu mailowego.

Sekcja PlusEFakturaConfiguration

[PlusEFakturaConfiguration]
AddAttachmentsToArchive=
AddAttachmentsToFileSystem=
AddMailsToArchive=
AddMailAsPdfToArchive=
IndexesMappingException=
DirPathForTempFile=
DeleteTemporaryFile=
DeleteMessagesAfterRead=
CopyMessagesTo=
CheckOnlyUnseenMessages=
DeleteUnprocessedMessages=
CopyUnprocessedMessagesTo=
ForwardUnprocessedMessagesTo=
ForwardEmail=
CheckSupplier=
ForwardUnsupportedMessagesTo=
DeleteUnsupportedMessages=
CopyUnsupportedMessagesTo=
AdministrationUserLogin=
ClassNameWithPackage=
NonInvoiceAttachmentProcessorClass=
ActivateLicenseNotification=
UseSequenceAsMessageIdGenerator=
SwapEmailsForTemplateRetrieval=
DebugOutput=
DetectForwarding=
EncodePasswords=

 

gdzie:

  • AddAttachmentsToArchive – pole definiujące, czy wiadomość e-mail ma być analizowana pod kątem zawartości załączników, które następnie mogą być dodawane do archiwum systemu, jeżeli załączniki wiadomości mają być analizowane, należy ustawić wartość TRUE

  • AddAttachmentsToFileSystem – pole definiujące, czy wiadomość e-mail ma być analizowana pod kątem zawartości załączników, które następnie mogą być zapisane na dysku w systemie plików, jeżeli załączniki wiadomości mają być analizowane, należy ustawić wartość TRUE

  • AddMailsToArchive – pole definiujące, czy wiadomość e-mail w postaci pliku o rozszerzeniu eml, ma być dodawana do archiwum do podanej klasy dokumentów, jeżeli wiadomość e-mail ma być dodawana, to należy ustawić wartość TRUE

  • AddMailAsPdfToArchive - pole definiujące, czy wiadomość e-mail ma zostać przekonwertowana do pliku pdf i dodana do archiwum do podanej klasy dokumentów, jeżeli wiadomość e-mail ma być przekonwertowana i dodawana, to należy ustawić wartość TRUE

  • IndexesMappingException – pole definiujące zachowanie modułu w przypadku, gdy wystąpi błąd dodawania indeksu do archiwum dla załą- cznika (np. indeks o typie datowym będzie inicjowany wartością tekstową) lub nie uda się odnaleźć wartości indeksu po zastosowaniu szablonu faktury, możliwe są dwie akcje, akcja CONTINUE sprawia, że takie indeksy są pomijana (nie są mapowane w archiwum), załącznik jest dodawany do archiwum z pozostałymi indeksami, akcja STOP powoduje przerwanie dodawania załącznika do archiwum lub jego usunięcie, jeśli wystąpił błąd w dodawaniu indeksów do archiwum, nie jest też dodawana do archiwum wiadomość w postaci pliku eml (wartość domyślna: CONTINUE)

  • DirPathForTempFile – ścieżka do zapisu plików tymczasowych, które mają zostać zapisane do archiwum. Moduł Plus E-faktura domyślnie wykonuje funkcję System.getenv( "TMP" ), która zwraca ścieżkę do folderu tymczasowego TMP w systemie Windows. W innych systemach operacyjnych wartość może zostać nieznaleziona. Zaleca się więc ręczne definiowanie wartości tego pola.

  • DeleteTemporaryFile – pole definiujące, czy należy usuwać stworzone pliki tymaczasowe przy zapisie dokumentu do archiwum, TRUE – jeśli usuwać

  • DeleteMessagesAfterRead – informacja określająca, czy wiadomości z monitorowanej skrzynki mailowej mają być usunięte po przeczytaniu i wykonaniu na nich akcji, TRUE – jeśli usuwać

  • CopyMessagesTo – nazwa folderu, do którego mają zostać przeniesione poprawnie przetworzone wiadomości email, folder zostanie automatycznie utworzony, jeśli nie istnieje na monitorowanej skrzynce mailowej, pole to ma znaczenie jedynie, gdy w polu Protocols w sekcji MailboxesParams dla danej skrzynki mailowej wykorzystywany jest protokół IMAP

  • CheckOnlyUnseenMessage – pole informujące, czy należy pobierać tylko wiadomości nieprzeczytane ze skrzynki monitorowanej, TRUE – jeśli zwracać tylko nieprzeczytane wiadomości

  • DeleteUnprocessedMessages – pole informujące, czy usuwać nieprzetworzone wiadomości email (wiadomości bez załączników, wiadomości z załącznikami o nieakceptowanym rozszerzeniu, wiadomości odrzucone w funkcji definiowanej przez interfejs PlusEFaktura, wiadomości, dla których wystąpił błąd podczas dodawania załącznika do systemu - załączniki są analizowane tylko, gdy AddAttachmentsToArchive=TRUE lub AddAttachmentsToFileSystem=TRUE), TRUE – jeśli usuwać nieprzetworzone wiadomości email

  • CopyUnprocessedMessagesTo – nazwa folderu, do którego mają zostać przeniesione nieprzetworzone wiadomości email (wiadomości bez załączników, wiadomości z załącznikami o nieakceptowanym rozszerzeniu, wiadomości odrzucone w funkcji definiowanej przez interfejs PlusEFaktura, wiadomości, dla których wystąpił błąd podczas dodawania załącznika do systemu - załączniki są analizowane tylko, gdy AddAttachmentsToArchive=TRUE lub AddAttachmentsToFileSystem=TRUE), folder zostanie automatycznie utworzony, jeśli nie istnieje na monitorowanej skrzynce mailowej, pole to ma znaczenie jedynie, gdy w polu Protocols w sekcji MailboxesParams dla danej skrzynki mailowej wykorzystywany jest protokół IMAP

  • ForwardUnprocessedMessagesTo – pole określające adresy email, na które mają zostać przesłane nieprzetworzone wiadomości email. Możliwe jest podanie kilku adresów email poprzez rozdzielenie ich znakiem średnika “;”

  • ForwardEmail – pole informujące, czy przesyłać wiadomości na inne skrzynki email po ich poprawnym przeanalizowaniu, pole to nie ma wpływu na forwardowanie nieprzetworzonych wiadomości (ForwardUnprocessedMessagesTo) i wiadomości odrzuconych podczas filtracji (ForwardUnsupportedMessagesTo), TRUE – jeśli przesyłać

  • CheckSupplier – pole informujące czy przeprowadzać filtrację wiadomości email na podstawie adresu nadawcy wiadomości. Akceptowane adresy email znajdują się w wewnętrznej bazie danych w tabeli pm_plusefaktura_templates. Jeżeli adres email nadawcy wiadomości znajduje się w tej tabeli, wiadomość jest poddawana analizie pod kątem zawartości załączników. Pole powinno przyjąć wartość TRUE, jeśli filtracja ma być realizowana

  • ForwardUnsupportedMessagesTo – pole określające adresy email, na które mają zostać przesłane wiadomości odrzucone w procesie filtracji. Możliwe jest podanie kilku adresów email poprzez rozdzielenie ich znakiem średnika “;”. Opcja ta ma znaczenie jedynie wtedy, gdy pole CheckSupplier jest ustawione na TRUE.

  • DeleteUnsupportedMessages – pole informujące, czy usuwać wiadomości odrzucone w procesie filtracji. Pole powinno przyjąć wartość TRUE, jeśli takie wiadomości mają być usuwane. Opcja ta ma znaczenie jedynie wtedy, gdy pole CheckSupplier jest ustawione na TRUE.

  • CopyUnsupportedMessagesTo – nazwa folderu, do którego mają zostać przeniesione wiadomości odrzucone w procesie filtracji, folder zostanie automatycznie utworzony, jeśli nie istnieje na monitorowanej skrzynce mailowej, pole to ma znaczenie jedynie, gdy w polu Protocols w sekcji MailboxesParams dla danej skrzynki mailowej wykorzystywany jest protokół IMAP

  • AdministrationUserLogin – pole określające login użytkownika, który wykonuje wszystkie operacje administracyjne, takie jak dodawanie plików do archiwum (powinien więc posiadać on prawa do klas dokumentów). Użytkownik musi istnieć w systemie.

  • ClassNameWithPackage – nazwa klasy wraz z pakietem, w której zostanie wykorzystany interfejs PlusEFaktura do zaimplementowania dodatkowych metod dla akcji dodania załączników wiadomości email do archiwum

  • NonInvoiceAttachmentProcessorClass - nazwa klasy wraz z pakietem, w której zostanie wykorzystany interfejs NonInvoiceAttachmentProcessor do zaimplementowania dodatkowych metod dla akcji dodania pliku nie będącego fakturą (zidenfytikowanego jako załącznik do faktury)

  • ActivateLicenseNotification – pole określające, czy ma być wysyłane powiadomienie w związku ze zbliżającym się wygaścięciem licencji, Pole powinno przyjąć wartość TRUE jeśli powiadomienie ma zostać wysłane

  • UseSequenceAsMessageIdGenerator – czy używać sekwencji liczbowej jako id wiadomości (jeśli nie, jest to id wiadomości ze skrzynki mailowej generowane przez nią), może przyjmować wartości TRUE lub FALSE, wartość domyślna: FALSE

  • SwapEmailsForTemplateRetrieval – czy podczas pobierania szablonu faktury dla dostawcy używać adresu Do z wiadomości e-mail dostawcy, może przyjmować wartości TRUE lub FALSE, wartość domyślna: FALSE

  • DebugOutput – ścieżka do pliku z logami odnośnie połączenia ze skrzynką mailową, jeżeli nie jest podana, tryb debug nie jest aktywowany

  • DetectForwarding – analizuje, czy wiadomość była przesyłana przez mechanizm forwardowania, zmienia wtedy adres dostawcy wykorzystując adres skrzynki pośredniej, wartość domyślna: FALSE

  • EncodePasswords – pole informujące, czy hasła do monitorowanych skrzynek pocztowych z pola EmailsPasswords w sekcji MailboxesParams powinny zostać zaszyfrowane podczas pierwszego uruchomienia, może przyjmować wartości TRUE lub FALSE, wartość domyślna: FALSE

Sekcja AddAttachmentsToArchiveAction

[AddAttachmentsToArchiveAction]
AcceptableExts=
IgnoredExts=
DocClassName=
AddFileAsNewVer=
DifferentDocClasses=
iTextOnlyForEmails=
EmailToIndex=
ToToIndex=
CCToIndex=
DateToIndex=
SubjectToIndex=
ContentToIndex=
AttachmentNameToIndex=
ExtensionToIndex=
MessageIdToIndex=
MailboxToIndex=
MailboxFolderToIndex=

 

gdzie:

  • AcceptableExts – jest to definicja rozszerzeń plików, które są akceptowane podczas zapisu dokumentów do archiwum, kolejne akceptowane rozszerzenia są oddzielone średnikiem ";"

  • IgnoredExts – jest to definicja rozszerzeń plików, które są ignorowane podczas zapisu dokumentów do archiwum, kolejne ignorowane rozszerzenia są oddzielone średnikiem ";", takie załączniki nie wpływają na status wiadomości

  • DocClassName – pole określające nazwę klasy dokumentów, w której będą archiwizowane załączniki z wiadomości e-mail. Klasa dokumentów musi istnieć w systemie.

  • AddFileAsNewVer – pole definiujące, czy dodawany dokument ma zostać zapisany w archiwum jako nowa wersja (dotyczy tylko sytuacji, gdy wszystkie indeksy dla dwóch różnych dokumentów mają przypisane te same wartości)

  • DifferentDocClasses – pole określające, czy załączniki o różnych rozszerzeniach mają być dodawane do różnych klas dokumentów (jeżeli tak, wartość pola jest ustawiana na TRUE). Sposób definiowania różnych klas dokumentów opisano w sekcji DifferentDocClasses (zobacz 4.6).

  • iTextOnlyForEmails – pole określające listę adresów e-mail dostawców, dla których zawartość załączników będzie analizowana wyłącznie za pomocą biblioteki iText, kolejne adresy e-email dostawców są oddzielone średnikiem ";"

  • EmailToIndex – nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będzie adres e-mail nadawcy wiadomości

  • ToToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będą adresy e-mail umieszczone w polu DO (TO), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • CCToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będą adresy e-mail umieszczone w polu DW (CC), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • DateToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie data odebrania wiadomości

  • SubjectToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie treść tematu wiadomości

  • ContentToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie treść wiadomości

  • AttachmentNameToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana nazwa załącznika dodawanego do archiwum

  • ExtensionToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowane będzie rozszerzenie załącznika dodawanego do archiwum

  • MessageIdToIndex – nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowane będzie unikalny identyfikator maila (utworzony z adresu email monitorowanej skrzynki i unikalnego identyfikatora wiadomości nadawanego automatycznie przez monitorowaną skrzynkę pocztową). Indeks ten pozwoli odnaleźć wiadomość eml zarchiwizowaną w systemie w innej klasie dokumentów.

  • MailboxToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będzie adres monitorowanej skrzynki mailowej

  • MailboxFolderToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie nazwa folderu skrzynki mailowej, z której zostały pobrane wiadomości

Sekcja AddAttachmentsToFileSystemAction

[AddAttachmentsToFileSystemAction]
AcceptableExts=
IgnoredExts=
Location=

 

gdzie:

  • AcceptableExts – jest to definicja rozszerzeń plików, które są akceptowane podczas zapisu dokumentów w systemie plików, kolejne akceptowane rozszerzenia są oddzielone średnikiem ";"

  • IgnoredExts – jest to definicja rozszerzeń plików, które są ignorowane podczas zapisu dokumentów w systemie plików, kolejne ignorowane rozszerzenia są oddzielone średnikiem ";", takie załączniki nie wpływają na status wiadomości

  • Location – pole określające ścieżkę do katalogu na dysku w systemie plików, w którym zostaną zapisane dokumenty. Katalog wraz z nadrzędnymi katalogami zostanie utworzony, jeśli nie istnieje.

Sekcja AddNonInvoiceAttachmentsToArchiveAction

[AddNonInvoiceAttachmentsToArchiveAction]
EmailToIndex=
ToToIndex=
CCToIndex=
DateToIndex=
SubjectToIndex=
ContentToIndex=
AttachmentNameToIndex=
ExtensionToIndex=
MessageIdToIndex=
MailboxToIndex=
MailboxFolderToIndex=

 

gdzie:

  • EmailToIndex – nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowany będzie adres e-mail nadawcy wiadomości

  • ToToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowany będą adresy e-mail umieszczone w polu DO (TO), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • CCToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowany będą adresy e-mail umieszczone w polu DW (CC), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • DateToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowana będzie data odebrania wiadomości

  • SubjectToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowana będzie treść tematu wiadomości

  • ContentToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowana będzie treść wiadomości

  • AttachmentNameToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowana nazwa załącznika dodawanego do archiwum

  • ExtensionToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowane będzie rozszerzenie załącznika dodawanego do archiwum

  • MessageIdToIndex – nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowane będzie unikalny identyfikator maila (utworzony z adresu email monitorowanej skrzynki i unikalnego identyfikatora wiadomości nadawanego automatycznie przez monitorowaną skrzynkę pocztową). Indeks ten pozwoli odnaleźć wiadomość eml zarchiwizowaną w systemie w innej klasie dokumentów.

  • MailboxToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowany będzie adres monitorowanej skrzynki mailowej

  • MailboxFolderToIndex - nazwa indeksu w klasie dokumentów dla załącznika nie będącego fakturą, na który mapowana będzie nazwa folderu skrzynki mailowej, z której zostały pobrane wiadomości

Sekcja AddMailsToArchiveAction

[AddMailsToArchiveAction]
DocClassName=
AddFileAsNewVer=
EmailToIndex=
ToToIndex=
CCToIndex=
DateToIndex=
SubjectToIndex=
ContentToIndex=
AttachmentNameToIndex=
ExtensionToIndex=
MessageIdToIndex=
MailboxToIndex=
MailboxFolderToIndex=

 

gdzie:

  • DocClassName – pole określające nazwę klasy dokumentów, w której będą archiwizowane wiadomości e-mail. Klasa dokumentów musi istnieć w systemie.

  • AddFileAsNewVer – pole definiujące, czy dodawany dokument ma zostać zapisany w archiwum jako nowa wersja (dotyczy tylko sytuacji, gdy wszystkie indeksy dla dwóch różnych dokumentów mają przypisane te same wartości)

  • EmailToIndex – nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będzie adres e-mail nadawcy wiadomości

  • ToToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będą adresy e-mail umieszczone w polu DO (TO), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • CCToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będą adresy e-mail umieszczone w polu DW (CC), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • DateToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie data odebrania wiadomości

  • SubjectToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie treść tematu wiadomości

  • ContentToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie treść wiadomości

  • AttachmentNameToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana nazwa załącznika dodawanego do archiwum

  • ExtensionToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowane będzie rozszerzenie załącznika dodawanego do archiwum

  • MessageIdToIndex – nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowane będzie unikalny identyfikator maila (utworzony z adresu email monitorowanej skrzynki i unikalnego identyfikatora wiadomości nadawanego automatycznie przez monitorowaną skrzynkę pocztową). Indeks ten pozwoli odnaleźć załączniki danej wiadomości email zarchiwizowane w systemie w innych klasach dokumentów.

  • MailboxToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będzie adres monitorowanej skrzynki mailowej

  • MailboxFolderToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie nazwa folderu skrzynki mailowej, z której zostały pobrane wiadomości

Sekcja AddMailAsPdfToArchiveAction

[AddMailAsPdfToArchiveAction]
DocClassName=
TemplatePath=
UseContentControl=
EmailToIndex=
ToToIndex=
CCToIndex=
DateToIndex=
SubjectToIndex=
ContentToIndex=
MessageIdToIndex=
MailboxToIndex=
MailboxFolderToIndex=

 

gdzie

  • DocClassName - pole określające nazwę klasy dokumentów, w której będą archiwizowane wiadomości e-mail przekonwertowane do pdf. Klasa dokumentów musi istnieć w systemie.

  • TemplatePath – ścieżka do szablonu Word w formacie docx, informuje w jakiej postaci ma zostać przekonwertowana wiadomość e-mail do pliku pdf. Gdy szablon nie jest podany lub nie istnieje w podanej lokalizacji, moduł korzysta z domyślnego szablonu. Podczas generowania szablonu należy pamiętać o ograniczeniach, jakie nakłada transformacja do pliku pdf. Nie radzi sobie ona z rozmieszczeniem obrazu (floating images) – jeżeli są umieszczone np. po prawej, to są transformowane do lewej, podobnie ma się sytuacja z tekstem przesuniętym na środek za pomocą spacji. Możliwe jest wykorzystanie kilku technik pozwalających zachować zamierzone formatowanie: umieszczanie tekstu lub obrazu w polach tekstowych o określonym formatowaniu (TextBox) lub umieszczanie ich w tabelach z ukrytym obramowaniem. W szablonie Word można wykorzystywać następujące tagi odnoszące się do parametrów danej wiadomości:

    • ${attachments} – spis załączników wymienionych po średniku

    • ${attachmentsList} – spis załączników od nowej linii

    • ${bcc} – adresy e-mail odbiorców umieszczone w polu Kopia ukryta wymienione po średniku

    • ${cc} – adresy e-mail odbiorców umieszczone w polu Kopia wymienione po średniku

    • ${simpleContents} – treść e-maila w formie tekstu bez obrazków

    • ${contents} – treść e-maila, wstawiane są obrazki

    • ${from} – adres e-mail nadawcy wiadomości

    • ${receivedDate} – data odebrania wiadomości w formacie 2015-01-31 15:27, parametr ten nie jest uzupełniany, gdy wiadomości e-mail są pobierane ze skrzynki pocztowej za pomocą protokołu POP3

    • ${recipients} - adresy e-mail wszystkich odbiorców wymienione po średniku

    • ${sentDate} – data wysłania wiadomości w formacie 2015-01-31 15:27

    • ${subject} – temat wiadomości e-mail

    • ${to} - adresy e-mail odbiorców umieszczone w polu Do wymienione po średniku

  • EmailToIndex – nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będzie adres e-mail nadawcy wiadomości

  • ToToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będą adresy e-mail umieszczone w polu DO (TO), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • CCToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będą adresy e-mail umieszczone w polu DW (CC), w przypadku kilku adresów e-mail będą one rozdzielone przecinkiem ze spacją

  • DateToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie data odebrania wiadomości

  • SubjectToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie treść tematu wiadomości

  • ContentToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie treść wiadomości

  • MessageIdToIndex – nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowane będzie unikalny identyfikator maila (utworzony z adresu email monitorowanej skrzynki i unikalnego identyfikatora wiadomości nadawanego automatycznie przez monitorowaną skrzynkę pocztową). Indeks ten pozwoli odnaleźć załączniki danej wiadomości email zarchiwizowane w systemie w innych klasach dokumentów.

  • MailboxToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowany będzie adres monitorowanej skrzynki mailowej

  • MailboxFolderToIndex - nazwa indeksu w klasie dokumentów określonej w polu DocClassName, na który mapowana będzie nazwa folderu skrzynki mailowej, z której zostały pobrane wiadomości

Przed wdrożeniem zaleca się sprawdzenie, czy wszystkie dane są prawidłowo wstawiane. Jeżeli jakiś klucz nie jest zamieniany na wartość, to zaleca się ponowną edycję szablonu (ponowne wpisanie klucza), gdyż Word niekiedy dodaje własne znaczniki, co utrudnia wstawianie danych. Zaleca się przygotowywanie szablonów jednostronicowych, co zapobiega dodawaniu niewidocznego bookmark'a do strony głównej.

Sekcja ForwardEmailAction

[ForwardEmailAction]
Addresses=

 

gdzie:

  • Addresses – pole określające adresy email, na które ma być przesyłana wiadomość przeanalizowana pod kątem występowania załączników. Można podać kilka adresów email rozdzielając je średnikiem ";". Pole to ma znaczenie, jeżeli pole ForwardEmail w sekcji PlusEFakturaConfiguration (zobacz 4.2) jest ustawione na wartość TRUE

Sekcja DifferentDocClasses

[DifferentDocClasses]
<NAZWA ROZSZERZENIA>=

 

gdzie:

  • <NAZWA ROZSZERZENIA> – pole powinno przyjąć jako nazwę rozszerzenie pliku, dla którego definiuje się oddzielną klasę (np. RTF, XML, JPG). Rozszerzenie musi być pisane wielkimi literami. Wartość pola określa nazwę klasy dokumentów, w której będzie archiwizowany załącznik o określonym rozszerzeniu (o ile jest akceptowany przez moduł). Klasa dokumentów musi istnieć w systemie. Zaleca się, żeby w klasie zdefiniowane były indeksy określone w sekcji AddAttachmentsToArchiveAction (zobacz 4.3), jeżeli ma występować mapowanie wartości. Nie ma potrzeby określania klasy dokumentów dla załączników o rozszerzeniu PDF (pola PDF), gdyż jest ono domyślne i określone w sekcji AddAttachmentsToArchiveAction (zobacz 4.3).

 

Sekcja DifferentDocClasses ani żadne z jej pól nie jest obowiązkowe. Powinna wystąpić, jeżeli w sekcji AddAttachmentsToArchiveAction (zobacz 4.3) w polu DifferentDocClasses podano wartość TRUE (jeżeli brak sekcji DifferentDocClasses, to dla wsMailboxToIndexzystkich załączników zostanie użyta klasa dokumentów zdefiniowana w polu DocClassName w sekcji AddAttachmentsToArchiveAction (zobacz 4.3)). Jeżeli dla jakiegoś akceptowanego rozszerzenia nie zdefiniowano pola, to zostanie dla niego użyta klasa dokumentów zdefiniowana w polu DocClassName w sekcji AddAttachmentsToArchiveAction (zobacz 4.3)).

Sekcja LicenseNotification

[LicenseNotification]
InvoicesToFinishLicense=
Email=
EmailPassword=
OutgoingEmailPort=
EmailServer=
SendNotificationTo=
Authentication=
SSL=
StartTLS=
OAuth=

 

gdzie:

  • InvoicesToFinishLicense – określa ilość faktur, jakie mogą zostać dodane z wykorzystaniem obecnej licencji przed jej wygaśnięciem, po osiągnięciu tego progu wysyłane jest powiadomienie, jeżeli jest aktywowane (pole ActivateLicenseNotification w sekcji PlusEFakturaConfiguration (zobacz 4.2)), pole musi przyjmować wartość dodatnią. Wartość nie musi być ustawiona, wtedy domyślną wartością jest 100.

  • Email – adres e-mail, z którego ma zostać wysłane powiadomienie o wygasającej licencji

  • EmailPassword – hasło do podanej skrzynki pocztowej

  • OutgoingEmailPort – numer portu poczty wychodzącej

  • EmailServer – nazwa serwera pocztowego, z którego wysyłane jest powiadomienie o wygasającej licencji

  • SendNotificationTo – adresy e-mail, na które mają być wysyłane powiadomienia o wygasającej licencji, kolejne adresy e-mail należy oddzielić znakiem średnika

  • Authentication - czy przeprowadzać autentykację, może przyjmować wartości TRUE lub FALSE

  • SSL – określa, czy wysyłanie wiadomości ma się odbywać za pomocą połączenia SSL, może przyjmować wartości TRUE lub FALSE

  • StartTLS – określa, czy wysyłanie wiadomości ma się odbywać za pomocą szyfrowania TLS, może przyjmować wartości TRUE lub FALSE

  • OAuth – określa czy wartość podana w EmailPassword to hasło do skrzynki pocztowej, czy id połączenia ze skrzynką za pomocą OAuth2 (id możemy znaleźć w nowej zakładce konfiguracji skrzynki pocztowej). Przyjmuje wartości TRUE lub FALSE, wartość TRUE oznacza, że EmailPasswords przechowuje id połączenia za pomocą OAuth2

Sekcja ForwardConfiguration

[ForwardConfiguration]
Email=
Password=
EmailServer=
OutgoingPort=
Authentication=
StartTLS=
SSL=
DebugOutput=
OAuth=


gdzie:

  • Email – adres e-mail, z którego ma zostać przesłana wiadomość

  • Password – hasło do podanej skrzynki pocztowej

  • EmailServer – nazwa serwera pocztowego, z którego wykonywane jest przesyłanie wiadomości

  • OutgoingPort – numer portu poczty wychodzącej

  • Authentication - czy przeprowadzać autentykację, może przyjmować wartości TRUE lub FALSE

  • StartTLS – określa, czy wysyłanie wiadomości ma się odbywać za pomocą szyfrowania TLS, może przyjmować wartości TRUE lub FALSE

  • SSL – określa, czy wysyłanie wiadomości ma się odbywać za pomocą połączenia SSL, może przyjmować wartości TRUE lub FALSE

  • DebugOutput – ścieżka do pliku z logami odnośnie połączenia ze skrzynką mailową, jeżeli nie jest podana, tryb debug nie jest aktywowany

  • OAuth – określa czy wartość podana w Password to hasło do skrzynki pocztowej, czy id połączenia ze skrzynką za pomocą OAuth2 (id możemy znaleźć w nowej zakładce konfiguracji skrzynki pocztowej). Przyjmuje wartości TRUE lub FALSE, wartość TRUE oznacza, że EmailPasswords przechowuje id połączenia za pomocą OAuth2

  • No labels
Write a comment…