Liking cljdoc? Tell your friends :D

clojure-mail.folder


build-search-termsclj

(build-search-terms query)
(build-search-terms query terms-so-far and-join)

This creates a search condition. Input is a sequence of message part conditions or flags or header conditions. Possible message part condititon is: (:from|:cc|:bcc|:to|:subject|:body) value or date condition. Date condition is: (:received-before|:received-after|:received-on|:sent-before|:sent-after|:sent-on) date. Header condition is: :header (header-name-string header-value, ...) Supported flags are: :answered?, :deleted?, :draft?, :recent?, :flagged? :seen?. Minus sign at the beginning of flag tests for negated flag value (ex. :-answered? not answered messages).

Terms on the same level is connected with and-ed, if value is a sequence, then those values are or-ed.

Examples: (:body "foo" :body "bar") - body should match both values. (:body ["foo" "bar"]) - body should match one of the values. (:body "foo" :from "john@exmaple.com") - body should match foo and email is sent by john.

This creates a search condition. Input is a sequence of message part conditions or flags or header conditions.
Possible message part condititon is: (:from|:cc|:bcc|:to|:subject|:body) value or date condition.
Date condition is: (:received-before|:received-after|:received-on|:sent-before|:sent-after|:sent-on) date. 
Header condition is: :header (header-name-string header-value, ...)
Supported flags are: :answered?, :deleted?, :draft?, :recent?, :flagged? :seen?. Minus sign at the beginning of flag tests for negated flag value (ex. :-answered? not answered messages).

Terms on the same level is connected with and-ed, if value is a sequence, then those values are or-ed. 
 
Examples: 
 (:body "foo" :body "bar") - body should match both values.
 (:body ["foo" "bar"]) - body should match one of the values.
 (:body "foo" :from "john@exmaple.com") - body should match foo and email is sent by john.
raw docstring

current-folderclj


date-formatsclj


fetch-messagesclj

(fetch-messages f ms & {:keys [fetch-profile] :or {fetch-profile :message}})

Pre-fetch message attributes for a given fetch profile. Messages are retrieved as light weight objects and individual fields such as headers or body are populated lazily. When bulk fetching messages you can pre-fetch these items based on a com.sun.mail.imap.FetchProfileItem f - the folder from which to fetch the messages ms - the messages to fetch :fetch-profile - optional fetch profile, defaults to entire message. fetch profiles are:

:message
:headers
:flags
:envelope
:content-info
:size
Pre-fetch message attributes for a given fetch profile.
Messages are retrieved as light weight objects and individual fields such as headers or body are populated lazily.
When bulk fetching messages you can pre-fetch these items based on a com.sun.mail.imap.FetchProfileItem
f - the folder from which to fetch the messages
ms - the messages to fetch
:fetch-profile - optional fetch profile, defaults to entire message. fetch profiles are:

    :message
    :headers
    :flags
    :envelope
    :content-info
    :size
    
raw docstring

full-nameclj

(full-name f)

get-folderclj

(get-folder store folder-name)

Returns an IMAPFolder instance

Returns an IMAPFolder instance
raw docstring

get-messageclj

(get-message f id)

get-message-by-uidclj

(get-message-by-uid f id)

get-messagesclj

(get-messages folder)
(get-messages folder start end)

Gets all messages from folder f or get the Message objects for message numbers ranging from start through end, both start and end inclusive. Note that message numbers start at 1, not 0.

Gets all messages from folder f or get the Message objects for message numbers ranging from start through end,
both start and end inclusive. Note that message numbers start at 1, not 0.
raw docstring

listclj

(list f)

List all folders under folder f

List all folders under folder f
raw docstring

message-countclj

(message-count f)

Get total number of messages in folder f

Get total number of messages in folder f
raw docstring

new-message-countclj

(new-message-count f)

Get number of new messages in folder f

Get number of new messages in folder f
raw docstring

(search f & query)

to-dateclj

(to-date ds)

Parses a date string to date

Parses a date string to date
raw docstring

to-date-comparisonclj

(to-date-comparison dt)

Returns the correct comparison term for search

Returns the correct comparison term for search
raw docstring

to-flagclj

(to-flag fl)

Converts a string to message flag

Converts a string to message flag
raw docstring

to-recipient-typeclj

(to-recipient-type rt)

Converts keyword to recipient type

Converts keyword to recipient type
raw docstring

unread-message-countclj

(unread-message-count f)

Get number of unread messages in folder f

Get number of unread messages in folder f
raw docstring

with-foldercljmacro

(with-folder folder store & body)

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close