afs_imap_load - AFS - Reference Guides

AFS Filters Description

Product
AFS
Platform
7.12
Category
Reference Guides
Language
English

The IMAP connector enables crawling of a remote IMAP server.

The filter is declared with the afs_imap_load type. It is in the antidot-paf-misc package. It is a generator filter.

The IMAP Load filter specifications are described in the following table:

Parameter name

Mandatory

Type

Default

Description

server_name

Yes

string

N/A

IMAP server name

ssl

No

boolean

false

Use an SSL encrypted connection to the mail server.

server_port

No

integer

N/A

IMAP server port. If port is omitted, the standard IMAP port is used: 993 for IMAP4-over-SSL and 143 for IMAP4.

credentials

Yes

map

N/A

{username:password} used to connect to the IMAP server

folder_flags_blacklist

No

list

\Trash, \All, \Junk, \Drafts

IMAP folders can be tagged by the server with some flags. Common flags are \Trash (trash folders), \Sent (sent messages), \All (virtual folder containing all messages), \Junk (spam messages) or \Drafts (message not yet sent). This option enables the user to filter out the crawled folders.

nb_days

No

integer

90

Only retrieve messages nb_days old. 0 means all messages will be retrieved..

max_nb_messages

No

integer

0

Maximum number of messages to fetch per user. 0 for unlimited.

max_nb_attachments

No

integer

10

Maximum number of attachments to fetch. 0 for unlimited.

output_layer

No

layer

CONTENTS

Layer filled for each output document.

whitelist

No

map

N/A

{login: folders} mapping to explicitely declare which IMAP folders to crawl. folders is a comma separated list of IMAP absolute folder names.

blacklist

No

map

N/A

{login: folders} mapping to ignore some IMAP folders during the crawl. folders is a comma separated list of IMAP absolute folder names.

senders_blacklist

No

list

[]

Ignore all messages from some senders ("From" field of an email).

global_blacklist

No

list

N/A

List of IMAP folders to ignore for all users.

acl_users_mapping

No

map

N/A

When the PaF runs in secured mode, rights management is enabled. Then, each crawled message will only be visible by the IMAP username afs:user. This option enables the mapping of each IMAP username to another afs:user.

Attention: This filter must be the first filter in a pipe. This filter will never process input documents.