###
# imap autoarchive sample config file
#
# 1.0beta

#
# There are two sections to an imap autoarchive configuration file.  the first
# section is where you tell imap autoarchive how to connect to your imap.
# the second section is where you define the rules to execute once connected.
#

###
### IMAP SERVER CONFIGUTATION
###

# this directive tells imap autoarchive the hostname or ip address of the 
# imap server to connect to.  REQUIRED
set server=localhost

# this directive tells imap autoarchive what user name to use when connecting
# to the imap server.  REQUIRED
set user=cyberd00d

# this directive tells imap autoarchive what password to use when connecting
# to the imap server.  REQUIRED
set password=krad666

# this directive tells imap autoarchive what path to prepend to all folder
# names.  if it is not supplied, / is assumed.  OPTIONAL
set root=mail



###
### RULE DEFINITION
###
# there are two main types of rules: copy/move rules and delete rules.  they
# take the following forms:
#
# copy/move rules:
# 
#   folder SRC-FOLDER move|copy messages older|newer than
#     N years|months|days|hours|minutes|seconds to DEST-FOLDER [with expunge]
#
# delete rules:
# 
#   folder SRC-FOLDER delete messages older|newer than 
#     N years|months|days|hours|minutes|seconds [with expunge]
#
#
# this should all be fairly self-explanatory.  the optional with expunge
# keyword determines whether or not messages that have been moved or deleted
# actually removed from the folder or if they are simply marked as deleted
# but not actually removed.


### Example Rules

# move INBOX messages older than 45 days to archive/Inbox (and fully delete
# the moved messages from INBOX

folder INBOX move messages older than 45 days to archive/Inbox with expunge

# delete messages older than one week from the folder 
# mailinglists/FreeBSD-current

folder mailinglists/FreeBSD-current delete messages older than 7 days with expunge

# mark messages in folder mailinglists/partylist as deleted if older than 14
# days, but do not actually remove from the folder

folder mailinglists/partylist delete messages older than 14 days