| Property |
Description |
| Attachment |
Required
for methods Append (optional)
and RFC822 (optional).
It is semicolon ";" separated list of attachments
to be append with mail message as its attachments.
Example (ASP):
<% Obj.Attachment
= "c:\myfolder\myfile.exe" %>
Example (ColdFusion):
<CFSET Obj.Attachment = "c:\myfolder\myfile.exe">
|
| AttachmentPath |
The
physical path where attachments will be saved.
Example (ASP):
<% Obj.AttachmentPath
= "c:\myfolder\attachments" %>
Example (ColdFusion):
<CFSET Obj.AttachmentPath = "c:\myfolder\attachments">
|
| AttachmentPathError |
Returns
1 if any error occurred for AttachmentPath otherwise
0.
Example (ASP):
<% if Obj.AttachmentPathError = 1
then
Response.Write
Obj.AttachmentPathErrorReason
end if %>
Example (ColdFusion):
<CFIF #Obj.AttachmentPathError# EQ 1>
<CFOUTPUT>#Obj.AttachmentPathErrorReason#</CFOUTPUT>
</CFIF>
|
| AttachmentPathErrorReason |
Reports
any error that occurred for AttachmentPath.
Example (ASP):
<% if Obj.AttachmentPathError = 1
then
Response.Write
Obj.AttachmentPathErrorReason
end if %>
Example (ColdFusion):
<CFIF #Obj.AttachmentPathError# EQ 1>
<CFOUTPUT>#Obj.AttachmentPathErrorReason#</CFOUTPUT>
</CFIF>
|
| AttachmentPathHTTP |
URL
for the AttachmentPath where attachments are saved.
Example (ASP):
<% Obj.AttachmentPathHTTP
= "http://advancedwebmail.com/attachments" %>
Example (ColdFusion):
<CFSET Obj.AttachmentPathHTTP = "http://advancedwebmail.com/attachments">
|
| Body
|
Required
for methods Append (optional)
and RFC822 (optional).
It is body of the message to be append with mail message
as its body.
Example (ASP):
<% Obj.Body = "this
is append message" %>
Example (ColdFusion):
<CFSET Obj.Body = "this
is append message">
|
| CC
|
Required
for methods Append (optional)
and RFC822 (optional).
It is cc address of message to be append with mail message,
it can be single cc address or semicolon ";"
separated list of addresses.
Example (ASP):
<% Obj.CC = "support@aspfusion.net"
%>
Example (ColdFusion):
<CFSET Obj.CC = "support@aspfusion.net">
|
| CharsPerLine |
Required
for methods Append (optional)
and RFC822 (optional).
It is characters per line of the mail message, if it
is not specified then default 76
characters per line is used. Minimum characters per
line allowed are 60.
Example (ASP):
<% Obj.CharsPerLine
= 70 %>
Example (ColdFusion):
<CFSET Obj.CharsPerLine = 70>
|
| CustomHeader |
Required
for methods Append (optional)
and RFC822 (optional).
It can be used for message identification. It may be
the name of the company, ip etc. You can assign it as
CustomHeaderName:HeaderValue e.g. X-Mail-IP:192.168.0.1
to set custom header. If there are multiple custom headers
then all custom headers will be semicolon ";"
separated.
Example (ASP):
<% Obj.CustomHeader
= "X-Mail-IP:192.168.0.1" %>
Example (ColdFusion):
<CFSET Obj.CustomHeader = "X-Mail-IP:192.168.0.1">
|
| DataItems
|
Required
for methods Status, Fetch, Search (optional), Store, UIDFetch, UIDSearch
(optional) and UIDStore.
Methods for which this property is used are
Status this property is used to retrieve data
items from specified mailbox. Valid values are
MESSAGES to retrieve number
of messages in the mailbox
RECENT to retrieve number
of messages with the \RECENT flag set
UIDNEXT to retrieve next UID
value that will be assigned to a new message in the
mailbox
UIDVALIDITY to retrieve unique
identifier validity value of the mailbox
UNSEEN to retrieve number of messages which
do not have the \SEEN flag set
You can also give combination of all these, separated
with space.
Example (ASP):
<% Obj.DataItems
= "messages unseen" %>
Example (ColdFusion):
<CFSET Obj.DataItems = "messages unseen">
Fetch and UIDFetch it is used to set fetch
criteria. Valid values for fetch criteria are
GETHEADER to retrieve mail headers only
GETALL to retrieve complete
mail along with headers and body
Example (ASP):
<% Obj.DataItems
= "getheader" %>
Example (ColdFusion):
<CFSET Obj.DataItems = "getheader">
Search and UIDSearch it is used to set
data to be searched. e.g "subject hello", then search
will return sequence number of those messages, which
contains word "hello" in their subjects. If not specified
then all messages are selected as a result.
Example (ASP):
<% Obj.DataItems
= "subject hello" %>
Example (ColdFusion):
<CFSET Obj.DataItems = "subject hello">
Store and UIDStore it is used to update
data items. Valid values are
FLAGS it replace the flags
for the message
FLAGS.SILENT equivalent to
FLAGS, but without returning a new value
+FLAGS add the argument to
the flags for the message
+FLAGS.SILENT equivalent to +FLAGS, but
without returning a new value
-FLAGS it remove the argument from the flags
for the message
-FLAGS.SILENT equivalent to
-FLAGS, but without returning a new value
Simple flags and flags.silent remove all previous values
of flags and set new values of flags for the mail. If
+ sign is used then previous values of flags are not
removed and also new values are placed. - sign is used
for performing not of + operation.
Example (ASP):
<% Obj.DataItems
= "+flags.silent" %>
Example (ColdFusion):
<CFSET Obj.DataItems = "+flags.silent">
|
| DataItemValues |
Required
for Store and UIDStore. Used to set updated values for
dataitems e.g. \seen, \deleted, \flagged. One can also
give combination of all these separated with space.
Example (ASP):
<% Obj.DataItemValues
= "\seen \flagged" %>
Example (ColdFusion):
<CFSET Obj.DataItemValues = "\seen \flagged">
|
| DeleteFile |
This
property is used to set flag whether to delete the file
from server after downloading through Download or DownloadAs
methods. Valid values are
TRUE if this flag is set as
TRUE then component will delete the file from server
after downloading
FALSE (default) if this flag is set as FALSE
then component will not delete the file from server
after downloading
Example (ASP):
<% Obj.DeleteFile
= true %>
NOTE: Can only be used for ASP |
| DownloadForceFully |
This
property is used to inform AdvFile component whether
to download file forcefully through Download or DownloadAs
methods. Valid values are
TRUE if this flag is set as
TRUE then component will download file forcefully
FALSE (default) if this flag is set as
FALSE then component will not download file forcefully,
browser will decide whether to display or download the
file
Example (ASP):
<% Obj.DownloadForceFully
= true %>
NOTE: Can only be used for ASP.
|
| ErrorReason |
Reports
any error that occurred during the request.
Example (ASP):
<% if Obj.IsError = 1 then
Response.Write
Obj.ErrorReason
else
No Error
Occurred
end if %>
Example (ColdFusion):
<CFIF #Obj.IsError# EQ 1>
<CFOUTPUT>#Obj.ErrorReason#</CFOUTPUT>
<CFELSE>
<CFOUTPUT>No
Error Occurred</CFOUTPUT>
</CFIF>
|
| FlagsLists |
Required
for method Append (optional).
Flags that are required to be set for message e.g. \seen,
\draft, \answered, \flagged and \deleted. You can also
give combination of all these separated with space.
If not specified then no flag is set.
Example (ASP):
<% Obj.FlagsLists
= "\seen \flagged" %>
Example (ColdFusion):
<CFSET Obj.FlagsLists = "\seen \flagged">
|
| From
|
Required
for method Append (optional)
and RFC822 (optional).
It is from address of message to be append with mail
message.
Example (ASP):
<% Obj.From = "from@aspfusion.net"
%>
Example (ColdFusion):
<CFSET Obj.From = "from@aspfusion.net">
|
| IsError
|
Returns
1 if any error occurred during the request otherwise
0.
Example (ASP):
<% if Obj.IsError = 1 then
Response.Write
Obj.ErrorReason
else
No Error
Occurred
end if %>
Example (ColdFusion):
<CFIF #Obj.IsError# EQ 1>
<CFOUTPUT>#Obj.ErrorReason#</CFOUTPUT>
<CFELSE>
<CFOUTPUT>No
Error Occurred</CFOUTPUT>
</CFIF>
|
| MailBoxName |
Required
for methods Append, Create, Delete, Examine, Rename,
Select, Status, Subscribe, UnSubscribe, Check, Close,
Copy, Fetch (optional,
default is Inbox), Search, Store,
UIDCopy, UIDFetch (optional,
default is Inbox),
UIDSearch, UIDStore for performing the corresponding
action.
Example (ASP):
<% Obj.MailBoxName
= "myfolder" %>
Example (ColdFusion):
<CFSET Obj.MailBoxName = "myfolder">
|
| MessageLiteral |
Required
for method Append. Message in RFC822 format, required
to be append in specified mailbox.
Example (ASP):
<% Obj.MessageLiteral
= RFC822FormatMessage %>
Example (ColdFusion):
<CFSET Obj.MessageLiteral = RFC822FormatMessage>
|
| MessageNumberOrUID |
Required
for Copy, Fetch(optional,
default is all message
numbers), Store, UIDCopy, UIDFetch(optional, default is all message UIDs), UIDStore.
Message sequence numbers or UIDs of messages, for performing
action. We can also write it as 3:8 means messages with
sequence number starts from 3 and ends at 8. Also 3,8
(comma separated list) can be given which means messages
with sequence number 3 and 8 only.
Example (ASP):
<% Obj.MessageNumberOrUID
= "2,5,8,12,17" %>
Example (ColdFusion):
<CFSET Obj.MessageNumberOrUID = "2,5,8,12,17">
|
| MessageType |
Required
for methods Append (optional)
and RFC822 (optional).
It is type of message. Valid values are
HTML (default)
TEXT
Example (ASP):
<% Obj.MessageType
= "text" %>
Example (ColdFusion):
<CFSET Obj.MessageType = "text">
|
| NewMailBoxName |
Required
for methods Rename and Copy.
Example (ASP):
<% Obj.NewMailBoxName
= "yourfolder" %>
Example (ColdFusion):
<CFSET Obj.NewMailBoxName = "yourfolder">
|
| OrderBy
|
Required
for Fetch (optional),
UIDFetch (optional)
for sorting of mails. If not specified then no sorting
is performed and mail messages are returned in order
as returned by IMAP4 server. Valid sorting criteria
are
Subject_ASC
Subject_DESC
From_ASC
From_DESC
To_ASC
To_DESC
Date_ASC
Date_DESC
Size_ASC
Size_DESC
Attachment_ASC (without attachment mails
first)
Attachment_DESC (with attachment
mails first)
Example (ASP):
<% Obj.OrderBy =
"size_desc" %>
Example (ColdFusion):
<CFSET Obj.OrderBy = "size_desc">
|
| Password
|
IMAP4
account password, required for authentication.
Example (ASP):
<% Obj.Password
= "mypassword" %>
Example (ColdFusion):
<CFSET Obj.Password = "mypassword">
|
| Port
|
This
property is used to specify IMAP4 server port. If not
specefied then default port 143 is used.
Example (ASP):
<% Obj.Port = 8143
%>
Example (ColdFusion):
<CFSET Obj.Port = 8143>
|
| ReferenceName |
Required
for List (optional),
Lsub (optional).
Name of a mailbox or level of mailbox hierarchy. If
not specified then empty reference name is selected.
Example (ASP):
<% Obj.ReferenceName
= "myfolder" %>
Example (ColdFusion):
<CFSET Obj.ReferenceName = "myfolder">
|
| ServerName |
This
property is used to specify IMAP4 server name or IP
address.
Example (ASP):
<% Obj.ServerName
= "aspfusion.net" %>
Example (ColdFusion):
<CFSET Obj.ServerName = "aspfusion.net">
|
| SortFirst
|
Required
for Fetch (optional)
for sorting mail messages first and then return required
mail messages. This parameter is only valid for GetHeaderOnly
and ignored in case of GetAll. If parameter MessageNumber
contains 1:5 and this parameter is set as TRUE, the
component will fetch all messages first and will sort
on given sorting criteria and will return mail messages
that come in sequence from 1 to 5, and if this parameter
is set as FALSE, the component will fetch messages from
1 to 5 and will sort on given sorting criteria and will
return mail messages. Valid values are
TRUE if this value is set
as TRUE then component will fetch all messages, perform
sorting and then will return required messages
FALSE (default) if this value is set as TRUE
then component will fetch required mesages, perform
sorting and then will return those messages
Example (ASP):
<% Obj.SortFirst
= true %>
Example (ColdFusion):
<CFSET Obj.SortFirst = true>
|
| Subject
|
Required
for methods Append (optional)
and RFC822 (optional).
It is subject of message to be append with mail message.
Example (ASP):
<% Obj.Subject =
"testing mail" %>
Example (ColdFusion):
<CFSET Obj.Subject = "testing
mail">
|
| Timeout
|
This
property is used to set request timeout value. If not
specified then default timeout value 60 is used.
Example (ASP):
<% Obj.Timeout =
120 %>
Example (ColdFusion):
<CFSET Obj.Timeout = 120>
|
| To
|
Required
for methods Append (optional)
and RFC822 (optional).
It is to address of message to be append with mail message,
it can be single to address or semicolon ";" separated
list of addresses.
Example (ASP):
<% Obj.To = "help@aspfusion.net"
%>
Example (ColdFusion):
<CFSET Obj.To = "help@aspfusion.net">
|
| Type
|
This
property is used to set content type for the file to
be downloaded through Download or DownloadAs methods.
Default value is "application/octet-stream".
Example (ASP):
<% Obj.Type = "application/zip"
%>
NOTE: Can only be used for ASP.
|
| UserName
|
IMAP4
account user name, required for authentication.
Example (ASP):
<% Obj.UserName
= "myusername" %>
Example (ColdFusion):
<CFSET Obj.UserName = "myusername">
|
| WildCard
|
Required
for methods List (optional),
Lsub (optional).
Mailbox name with possible wildcards. If not specified
then empty name is selected. The character " *
" is a wildcard, and matches zero or more characters
at this position. The character " % " is similar
to " * " but it does not match a hierarchy delimiter.
Example (ASP):
<% Obj.WildCard
= " * " %>
Example (ColdFusion):
<CFSET Obj.WildCard = "
* ">
|
