clojure-mail.core
*store*clj
all-messagesclj
(all-messages folder-name)(all-messages store folder-name)Given a store and folder returns all messages reversed so the newest messages come first
Given a store and folder returns all messages reversed so the newest messages come first
as-propertiesclj
(as-properties m)close-storeclj
(close-store s)Close an open IMAP store connection
Close an open IMAP store connection
connected?clj
(connected? s)Returns true if a connection is established
Returns true if a connection is established
dumpclj
(dump msgs)Handy function that dumps out a batch of emails to disk
Handy function that dumps out a batch of emails to disk
file->messageclj
(file->message path-to-message)read a downloaded mail message in the same format as you would find on the mail server. This can be used to read saved messages from text files and for parsing fixtures in tests etc
read a downloaded mail message in the same format as you would find on the mail server. This can be used to read saved messages from text files and for parsing fixtures in tests etc
folder-permissionsclj
foldersclj
(folders store)(folders store f)Returns a seq of all IMAP folders inlcuding sub folders
Returns a seq of all IMAP folders inlcuding sub folders
gen-storeclj
(gen-store email password)Generates an email store which allows us access to our inbox
Generates an email store which allows us access to our inbox
get-default-folderclj
(get-default-folder s)get-folderclj
(get-folder s name)Return the Folder object corresponding to the given name.
Return the Folder object corresponding to the given name.
gmailclj
gmail-folder-namesclj
inboxclj
(inbox)(inbox store)Get n messages from your inbox
Get n messages from your inbox
mark-all-readclj
(mark-all-read folder-name)(mark-all-read store folder-name)Mark all messages in folder as read
Mark all messages in folder as read
message-countclj
(message-count folder-name)(message-count store folder-name)Returns the number of messages in a folder
Returns the number of messages in a folder
open-folderclj
(open-folder folder-name perm-level)(open-folder store folder-name perm-level)Open a folder. Requires that a folder-name be a valid gmail folder i.e :inbox :sent :spam etc
Open a folder. Requires that a folder-name be a valid gmail folder i.e :inbox :sent :spam etc
save-message-to-fileclj
(save-message-to-file message)search-inboxclj
(search-inbox store term)Search your inbox for a specific term Returns a vector of IMAPMessage objects
Search your inbox for a specific term Returns a vector of IMAPMessage objects
storeclj
(store protocol server email pass)A store models a message store and its access protocol, for storing and retrieving messages
A store models a message store and its access protocol, for storing and retrieving messages
unread-messagesclj
(unread-messages folder-name)(unread-messages store folder-name)Find unread messages
Find unread messages
user-flagsclj
(user-flags message)with-storecljmacro
(with-store s & body)Takes a store which has been connected, and binds to to store within the scope of the form.
Usage:
user> (with-store (gmail-store "username@gmail.com" "password") (read-messages :inbox 5)) ;=>
Takes a store which has been connected, and binds to to *store* within the
scope of the form.
**Usage:**
user> (with-store (gmail-store "username@gmail.com" "password")
(read-messages :inbox 5))
;=> cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close