| hierarchy: |
WEB-INF.cftags.component CFOpenMail.demo.imap |
| path: | /home/opencf/public_html/CFOpenMail/demo/imap.cfc |
| properties: | |
| methods: | copyMessages, delete, download, expunge, folderCreate, folderDelete, folderList, folderRename, getConnectedMailStore*, getFolderInfo, getFolderStructure*, getMessage, getMessageCount, GetMessages*, getParts*, GetStore*, Init, listMessages, OpenFolder*, pop*, push*, send, setAnswered, setDraft, setFlag*, setFlagged, setRecent, setSeen, setUser |
| copyMessages |
|---|
public
boolean
copyMessages
(
required
string
folder,
required
string
messageNumber,
required
string
newFolder
)
Copy messages from one folder to another. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber newFolder: string, required, newFolder |
| delete |
public
boolean
delete
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's DELETED flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |
| download |
public
download
(
required
string
folder,
required
numeric
MessageNumber,
required
string
Attach,
boolean
includeData="true"
)
Take a specific attachment from a message and return the details - along with the binary data. Output: enabled Parameters: folder: string, required, folder MessageNumber: numeric, required, MessageNumber Attach: string, required, Attach includeData: boolean, optional, includeData |
| expunge |
public
boolean
expunge
(
required
string
folder
)
Expunge deleted messages from a folder. Output: suppressed Parameters: folder: string, required, folder |
| folderCreate |
public
boolean
folderCreate
(
required
string
folder
)
Create a folder. Output: suppressed Parameters: folder: string, required, folder |
| folderDelete |
public
boolean
folderDelete
(
required
string
folder,
boolean
recurse="false"
)
Delete a folder. Output: suppressed Parameters: folder: string, required, folder recurse: boolean, optional, recurse |
| folderList |
public
query
folderList
(
string
folder="Inbox"
)
Get a list of folders. Output: suppressed Parameters: folder: string, optional, folder |
| folderRename |
public
boolean
folderRename
(
required
string
folder,
required
string
renameTo
)
Rename a folder. Output: suppressed Parameters: folder: string, required, folder renameTo: string, required, renameTo |
| getConnectedMailStore* |
private
getConnectedMailStore
(
)
Returns the existing mail store object that is in memory as long as the connection properties (username, server, port) are the same, or creates a new connected mail store object. Output: suppressed |
| getFolderInfo |
public
Struct
getFolderInfo
(
required
string
folder
)
Get information about a specific folder. Output: suppressed Parameters: folder: string, required, folder |
| getFolderStructure* |
private
query
getFolderStructure
(
required
any
objFolder,
required
string
folder,
required
query
list,
required
numeric
level,
array
stack="[runtime expression]"
)
Recursive method for returning the structure of a folder (including all subfolders). Output: enabled Parameters: objFolder: any, required, objFolder folder: string, required, folder list: query, required, list level: numeric, required, level stack: array, optional, stack |
| getMessage |
public
getMessage
(
string
folder="Inbox",
numeric
MessageNumber="1",
boolean
text="false"
)
Get a specific message from a folder. Output: enabled Parameters: folder: string, optional, folder MessageNumber: numeric, optional, MessageNumber text: boolean, optional, text |
| getMessageCount |
public
numeric
getMessageCount
(
string
folder="Inbox"
)
Returns the number of messages in a folder. Output: suppressed Parameters: folder: string, optional, folder |
| GetMessages* |
private
array
GetMessages
(
required
any
objFolder,
messageNumber=""
)
Retrieves messages from a folder, given a folder object and an optional comma separated list of message numbers. Output: suppressed Parameters: objFolder: any, required, objFolder messageNumber: any, optional, messageNumber |
| getParts* |
private
struct
getParts
(
required
any
objMultipart
)
Get the parts of a message. Output: suppressed Parameters: objMultipart: any, required, objMultipart |
| GetStore* |
private
GetStore
(
)
Gets a connected mail store object (ie, connect to server, authenticate, etc) Output: suppressed |
| Init |
public
boolean
Init
(
required
string
username,
required
string
password,
required
string
imapServer,
numeric
port="143",
numeric
timeout="60"
)
Initialize this component and open a connection. Output: suppressed Parameters: username: string, required, username password: string, required, password imapServer: string, required, imapServer port: numeric, optional, port timeout: numeric, optional, timeout |
| listMessages |
public
query
listMessages
(
string
folder="Inbox",
string
MessageNumber=""
)
Lists messages within a specified folder. Output: suppressed Parameters: folder: string, optional, folder MessageNumber: string, optional, MessageNumber |
| OpenFolder* |
private
OpenFolder
(
required
any
objStore,
required
string
Folder,
boolean
ReadWrite="false",
boolean
Create="false"
)
Opens a folder within a mail store and returns the folder object. Output: suppressed Parameters: objStore: any, required, objStore Folder: string, required, Folder ReadWrite: boolean, optional, ReadWrite Create: boolean, optional, Create |
| pop* |
private
pop
(
required
array
stack
)
Remove the last item from an array. Output: enabled Parameters: stack: array, required, stack |
| push* |
private
push
(
required
array
stack,
required
any
value
)
Add a new item to the end of an array. Output: enabled Parameters: stack: array, required, stack value: any, required, value |
| send |
public
boolean
send
(
required
string
to,
required
string
cc,
required
string
bcc,
required
string
subject,
required
string
body,
string
attachments=""
)
Output: suppressed Parameters: to: string, required, to cc: string, required, cc bcc: string, required, bcc subject: string, required, subject body: string, required, body attachments: string, optional, attachments |
| setAnswered |
public
boolean
setAnswered
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's ANSWERED flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |
| setDraft |
public
boolean
setDraft
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's DRAFT flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |
| setFlag* |
private
setFlag
(
required
string
objFolder,
required
string
messageNumber,
required
string
flag,
required
boolean
value
)
Set an IMAP flag for a specific message or range of messages within the specified folder. Output: suppressed Parameters: objFolder: string, required, objFolder messageNumber: string, required, messageNumber flag: string, required, flag value: boolean, required, value |
| setFlagged |
public
boolean
setFlagged
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's FLAGGED flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |
| setRecent |
public
boolean
setRecent
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's RECENT flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |
| setSeen |
public
boolean
setSeen
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's SEEN flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |
| setUser |
public
boolean
setUser
(
required
string
folder,
required
string
messageNumber,
required
boolean
value
)
Sets the message's USER flag. Output: suppressed Parameters: folder: string, required, folder messageNumber: string, required, messageNumber value: boolean, required, value |