{"id":567,"date":"2016-03-11T19:25:06","date_gmt":"2016-03-11T19:25:06","guid":{"rendered":"http:\/\/wp-p3d2tsa2xh.pairsite.com\/?p=567"},"modified":"2020-02-27T09:30:48","modified_gmt":"2020-02-27T14:30:48","slug":"archivemail","status":"publish","type":"ht_kb","link":"https:\/\/www.pair.com\/support\/kb\/archivemail\/","title":{"rendered":"How to Use archivemail"},"content":{"rendered":"

Shared<\/p><\/a><\/span><\/p>\n

Introduction<\/h3>\n

The archivemail utility is used to archive and compress email, and can be used by all Shared Hosting account types.<\/p>\n

In its default form, archivemail will move messages older than a specified number of days to a compressed archive file to download from your server. You can also use archivemail to simply delete messages.<\/p>\n

Syntax<\/h3>\n

The syntax for the archivemail command is:<\/p>\n

archivemail [options] {mailbox}<\/pre>\n
Options<\/h3>\n
There are many options for archivemail. To see them all, just run the archivemail by itself with no arguments.<\/p>\n
Some of the most common options are below.<\/p>\n
The following two options let you specify the date before which to archive messages. You can use one option or the other, but not both:<\/p>\n
-d NUMBER<\/pre>\n
For example:<\/p>\n
-d 365 {mailbox} will archive messages older than 365 days (one year).<\/p>\n
or<\/p>\n
-D DATE<\/pre>\n
For example:<\/p>\n
-D 2005-03-11 will archive messages that predate March 3rd, 2005.<\/p>\n
Note the acceptable formats for dates. You may use ISO format (YEAR-MM-DD) or Internet format: DD Mon YYYY<\/p>\n
-n<\/pre>\n
-n will do a \"dry run\" of the archivemail command, showing what would have happened if you had done the command \"for real\". This can be useful when learning the command or when using the command just to get info about your mailbox.<\/p>\n
Using the -n command before using archivemail\u00a0in a delete capacity\u00a0can also help you avoid doing something disastrous.<\/p>\n
-u<\/pre>\n
This will skip unread messages.<\/p>\n
--delete<\/pre>\n    \t\t
\r\n    \t\t\tWarning<\/span>    \t\t\t    \t\t\t\t
\r\n    \t\t\t\t\tThis can have disastrous effects. Please be absolutely certain you know what you are doing before using archivemail to delete mail. Deletion is permanent. We are unable to restore permanently deleted files.    \t\t\t\t<\/p>\r\n    \t\t\t    \t\t\t\r\n    \t\t<\/div>\r\n    \t\t\n
This option will cause archivemail to operate in a deleting, rather than archiving, capacity. Messages will be permanently deleted and will not be eligible for restoration.<\/p>\n
Mailbox\u00a0Format<\/h3>\n
The last part of the archivemail is the {mailbox} component.<\/p>\n
You'll need some information specific to your mailbox:<\/p>\n