Mailbox (Imap or POP)

All Plugins / Access / Imap

Identity Card

StatusCore
Plugin LabelMailbox (Imap or POP)
Short DescriptionThis plugin will browse the content of a mailbox (imap or pop) and allow to grab emails attachments and copy them to another repository. Requires the PHP IMAP extension.
Plugin Identifieraccess.imap
AuthorCharles du Jeu
Urldocs/references/plugins/access/imap
Dependenciesaccess.fs

Documentation

Disclaimer: If you installed Pydio by the linux repository ( apt / yum ), you must install the "pydio-plugin-access.imap" package and the "Maill_mimeDecode" package from pear

This access drivers use php imap functions to browse a mailbox and retrieve the emails and attachments contained in it. Warning, the php_imap extension must be installed and loaded. And for your info, it's not because it's "imap" that i's limited to imap mailbox, POP3 is also supported.

Here are some test samples for connecting well-known mailboxes :

  • Yahoo IMAP :
    • Host : imap.mail.yahoo.com
    • Port : 993
    • Ssl : true
    • Type : imap
  • Hotmail via POP3 :
    • Host : pop3.live.com
    • Port : 995
    • Ssl : true
    • Type : pop3
  • Gmail via Imap :
    • Host : imap.gmail.com
    • Port : 993
    • Ssl : true
    • Type : imap
These are only some examples, you have to check your mail provider to get the right configuration.

Instance parameters

LabelDescriptionTypeDefault
Mail Server
Host *
HOST
Server hostString
Port *
PORT
Server portString
Ssl *
SSL
Secure?String
Type *
BOX_TYPE
Imap or Pop Server?Select (imap, pop3)imap
Mailbox Definition
User *
USER
User accountString
Password *
PASS
User PasswordPassword
Default Mailbox
MAILBOX
Mailbox to connect by defaultString
Repository Options
Default Rights
DEFAULT_RIGHTS
This right pattern (empty, r, or rw) will be applied at user creation for this workspace.Select (r, rw, w)
Pagination Threshold
PAGINATION_THRESHOLD
When a folder will contain more items than this number, display will switch to pagination mode, for better performances.Integer20
#Items per page
PAGINATION_NUMBER
Once in pagination mode, number of items to display per page.Integer20
Repository Commons
Description
USER_DESCRIPTION
A user-defined description of the content of this workspaceTextarea
Alias
AJXP_SLUG
Alias for replacing the generated unique id of the workspaceString
Group Path
AJXP_GROUP_PATH_PARAMETER
Set this repository group owner : only users of this group will see itString
Disable WebDAV
AJXP_WEBDAV_DISABLED
Explicitly disable WebDAV access for this repository.Booleanfalse
Template Options
Allow to user *
TPL_USER_CAN_CREATE
Allow non-admin users to create a workspace from this template.Booleanfalse
Allow to group admins *
TPL_GRP_ADMINS_CAN_CREATE
Allow group administrators to create a repository from this template.Booleanfalse
Default Label *
TPL_DEFAULT_LABEL
Prefilled label for the new workspace, you can use the AJXP_USER keyworkd in it.String
Small Icon
TPL_ICON_SMALL
16X16 Icon for representing the templateString
Big Icon
TPL_ICON_BIG
Big Icon for representing the templateString