docs » UniversalArchive

Boolean indicating whether a notification should be produced when an item is archived. Defaults to "true".

Name of the Notebook to use for archiving in Evernote. Defaults to "Archive"

A short pause to make typing into Evernote more reliable

• In Evernote, archive is done by selectin "Move note" and then simulating typing of the notebook name. A short pause in between makes it more reliable for Evernote to recognize the notebook name correctly.
• This variable controls how much to wait, in seconds.
• Do not change this unless you know what you are doing

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.

Name of the mailbox to use for archiving in Outlook. You must move a message manually to that mailbox at least once so that it appears in the "Message" -> "Move..." submenu. Defaults to "Archive"

Binds hotkeys for UniversalArchive

• mapping - A table containing hotkey modifier/key details for the following items:
  • archive - hotkey for trigger the universalArchive() method, to archive the current item on the current application.
  • <app>_<dest> - if an application handler supports multiple destinations, you can specify hotkeys for specific destinations using this format. For example, to assign a hotkey that files the current note in Evernote to the "MyProject" notebook using Ctrl-Alt-Cmd-M, you would specify Evernote_MyProject = { { "ctrl", "alt", "cmd" }, "m" } as one of the elements of mapping. Keep in mind that the application name must appear exactly as the system sees it (including upper/lowercase), and that if either the application or the destination name contain spaces or other non-alphanumeric characters, you need to use the Lua table notation. For example: ["Evernote_Some Long Notebook Name"] = { keybinding }. At the moment only the Evernote handler supports multiple destinations.

Archive current note in Evernote.

• where - destination notebook. Defaults to the value of UniversalArchive.evernote_archive_notebook.

Archive current message in Mail using the built-in Archive functionality

• none

Archive current message in Outlook using one of two methods:

• none

• If the "Message -> Archive" menu item exists, it is used (this has been added in recent versions of Outlook)
• Otherwise, the message gets manually moved to the folder specified in UniversalArchive.outlook_archive_folder. The folder has to appear in the Message -> Move submenu for this to work. Since this submenu only lists the last few destination folders, you have to move a message by hand the first time (or periodically if you don't archive very often).

Register a handler function for an application.

• appname - string containing the name of the application. If the application already has a handler, it will be replaced with the new one.
• fn - handler function (to remove the handler for an application, use nil). The function receives the following arguments:
  • self - the UniversalArchive object, so the handler can make use of all the object methods and variables.
  • where - optional "destination" for the archive operation. Handlers must provide a default destination when where == nil. Destination doesn't make sense for all applications, so the implementation of this is optional and depending on the handler.

Archive current message in Spark using the built-in Archive functionality

• none

Main entry point for archiving an item.

• None

• If a handler function is defined for the current application, it is called with the UniversalArchive object as its first argument, and the archive destination (if provided) as the second.
• Handlers must have a "default destination" that gets used when no destination is provided. Not all handlers support specifying a destination. New handlers can be registered using the registerApplication() method.