|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMailMessage
Classes that implement this interface are messaging in the messaging schema.
Field Summary | |
---|---|
static ItemClass |
CLASS
The ItemClass that represents a groupware mail message. |
static Key |
DELIVERY_DATE
Represents the delivery date of a message. |
static Key |
DISPLAY_BCC
Represents the displayable 'bcc' addresses of the message (in a provider specific format). |
static Key |
DISPLAY_CC
Represents the displayable 'cc' addresses of the message (in a provider specific format). |
static Key |
DISPLAY_FROM
Represents the displayable 'from' addresses of the message (in a provider specific format). |
static Key |
DISPLAY_TO
Represents the displayable 'to' addresses of the message (in a provider specific format). |
static Key |
ENCRYPTED
Represents the encrypted status of a message. |
static int |
KEYID_DELIVERY_DATE
The int ID for the DELIVERY_DATE key. |
static int |
KEYID_DISPLAY_BCC
The int ID for the DISPLAY_BCC key. |
static int |
KEYID_DISPLAY_CC
The int ID for the DISPLAY_CC key. |
static int |
KEYID_DISPLAY_FROM
The int ID for the DISPLAY_FROM key. |
static int |
KEYID_DISPLAY_TO
The int ID for the DISPLAY_TO key. |
static int |
KEYID_ENCRYPTED
The int ID for the ENCRYPTED key. |
static int |
KEYID_READ_RECEIPT_REQUESTED
The int ID for the READ_RECEIPT_REQUESTED key. |
static int |
KEYID_SENDER_ADDRESS
The int ID for the SENDER_ADDRESS key. |
static int |
KEYID_SENDER_NAME
The int ID for the SENDER_NAME key. |
static int |
KEYID_SENT_DATE
The int ID for the SENT_DATE key. |
static int |
KEYID_SIGNED
The int ID for the SIGNED key. |
static int |
KEYID_UNREAD
The int ID for the UNREAD key. |
static Key |
READ_RECEIPT_REQUESTED
Represents the read receipt requested status of a message. |
static Key |
SENDER_ADDRESS
Represents the sender address of a message. |
static Key |
SENDER_NAME
Represents the sender name of a message. |
static Key |
SENT_DATE
Represents the sent date of a message. |
static Key |
SIGNED
Represents the signed status of a message. |
static Key |
UNREAD
Represents the unread status of a message. |
Fields inherited from interface com.compoze.collab.messaging.IMessage |
---|
KEYID_RECIPIENTS, RECIPIENTS |
Fields inherited from interface com.compoze.collab.messaging.IMessagingItem |
---|
BODY, BODY_HTML, KEYID_BODY, KEYID_BODY_HTML |
Fields inherited from interface com.compoze.collab.IItem |
---|
ID, ITEM_CLASS, KEYID_ID, KEYID_ITEM_CLASS, KEYID_PARENT_ID, MINIMUM_ITEM_KEYS, PARENT_ID |
Fields inherited from interface com.compoze.collab.groupware.IGroupwareItem |
---|
CATEGORIES, DATE_CREATED, DATE_LAST_MODIFIED, IMPORTANCE, KEYID_CATEGORIES, KEYID_DATE_CREATED, KEYID_DATE_LAST_MODIFIED, KEYID_IMPORTANCE, KEYID_SIZE, KEYID_SUBJECT, SIZE, SUBJECT |
Fields inherited from interface com.compoze.collab.messaging.IMessagingItem |
---|
BODY, BODY_HTML, KEYID_BODY, KEYID_BODY_HTML |
Fields inherited from interface com.compoze.collab.IItem |
---|
ID, ITEM_CLASS, KEYID_ID, KEYID_ITEM_CLASS, KEYID_PARENT_ID, MINIMUM_ITEM_KEYS, PARENT_ID |
Method Summary | |
---|---|
IEmbeddedAttachment |
addEmbeddedAttachment(String sID,
String sName,
int iPosition)
Adds an embedded message to this mail message. |
IMailRecipient |
addRecipient(RecipientType type,
String sAddress)
Adds a recipient to the message. |
IMailRecipient |
addRecipient(RecipientType type,
String sAddress,
String sName)
Adds a recipient to the message. |
IMailMessage |
forward(IContainer container)
Creates a message that is suitable for forwarding and brings back the minimum properties on the new message. |
IMailMessage |
forward(IContainer container,
FetchProfile fp)
Creates a message that is suitable for forwarding. |
String |
getBccAddresses()
Gets the 'bcc' addresses in a displayable format specific to the provider. |
IMailRecipient[] |
getBccRecipients()
Gets recipient that are BCC recipients. |
String |
getCcAddresses()
Gets the 'cc' addresses in a displayable format specific to the provider. |
IMailRecipient[] |
getCcRecipients()
Gets recipient that are CC recipients. |
Date |
getDateDelivered()
Gets the date the message was delivered. |
Date |
getDateSent()
Gets the date the message was sent. |
String |
getFromAddresses()
Gets the 'from' addresses in a displayable format specific to the provider. |
IMailRecipient[] |
getRecipientsByType(RecipientType type)
Gets the recipients by recipient type. |
Sender |
getSender()
Gets the sender for this mail message. |
String |
getToAddresses()
Gets the 'to' addresses in a displayable format specific to the provider. |
IMailRecipient[] |
getToRecipients()
Gets recipient that are TO recipients. |
boolean |
isEncrypted()
Determines if the message encrypted flag is set. |
boolean |
isReadReceiptRequested()
Determines if a read receipt is requested. |
boolean |
isSigned()
Determines if the message signed flag is set. |
boolean |
isUnread()
Gets the unread status. |
void |
removeRecipient(IMailRecipient recipient)
Removes a recipient from the message. |
void |
removeRecipient(String sAddress)
Removes a recipient from the message. |
void |
removeRecipient(String sAddress,
RecipientType type)
Removes a recipient from the message. |
IMailMessage |
reply(IContainer container,
boolean bAll)
Creates a message that is suitable to be sent to the recipients already on a message. |
IMailMessage |
reply(IContainer container,
FetchProfile fp,
boolean bAll)
Creates a message that is suitable to be sent to the recipients already on a message and brings back the minimum properties on the new message. |
void |
send(boolean bDelete)
Sends the message, optionally deleting it after submit. |
void |
send(IContainer copyTo)
Sends the message, optionally saving it to a folder. |
void |
setEncrypted(boolean bEncrypted)
Sets the encrypted flag on the message. |
void |
setReadReceiptRequested(boolean bReadReceiptRequested)
Sets the read receipt requested flag of the message. |
void |
setSigned(boolean bSigned)
Sets the signed flag on the message. |
void |
setUnread(boolean bUnread)
Sets the unread flag. |
Methods inherited from interface com.compoze.collab.messaging.IMessage |
---|
addRecipient, getRecipients, send, setRecipients |
Methods inherited from interface com.compoze.collab.messaging.IMessagingItem |
---|
getBody, setBody |
Methods inherited from interface com.compoze.collab.IItem |
---|
commit, containsKey, containsKey, copyProperties, copyTo, delete, fetchProperties, getAttribute, getEnum, getID, getInputStream, getItemClass, getOutputStream, getParent, getParent, getParentID, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getReader, getRootContainer, getSession, getWriter, isMissing, moveTo, removeAttribute, removeProperty, setAttribute, setProperties, setProperty, setProperty, setProperty |
Methods inherited from interface com.compoze.collab.groupware.IGroupwareItem |
---|
getBodyHtml, getBodyHtml, getCategories, getDateCreated, getDateLastModified, getImportance, getNormalizedSubject, getSize, getSubject, getSubject, getSubjectPrefix, setBodyHtml, setCategories, setImportance, setSubject |
Methods inherited from interface com.compoze.collab.messaging.IMessagingItem |
---|
getBody, setBody |
Methods inherited from interface com.compoze.collab.IItem |
---|
commit, containsKey, containsKey, copyProperties, copyTo, delete, fetchProperties, getAttribute, getEnum, getID, getInputStream, getItemClass, getOutputStream, getParent, getParent, getParentID, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getReader, getRootContainer, getSession, getWriter, isMissing, moveTo, removeAttribute, removeProperty, setAttribute, setProperties, setProperty, setProperty, setProperty |
Field Detail |
---|
static final int KEYID_DELIVERY_DATE
int
ID for the DELIVERY_DATE
key.
static final int KEYID_ENCRYPTED
int
ID for the ENCRYPTED
key.
static final int KEYID_READ_RECEIPT_REQUESTED
int
ID for the READ_RECEIPT_REQUESTED
key.
static final int KEYID_SENDER_NAME
int
ID for the SENDER_NAME
key.
static final int KEYID_SENDER_ADDRESS
int
ID for the SENDER_ADDRESS
key.
static final int KEYID_SENT_DATE
int
ID for the SENT_DATE
key.
static final int KEYID_SIGNED
int
ID for the SIGNED
key.
static final int KEYID_UNREAD
int
ID for the UNREAD
key.
static final int KEYID_DISPLAY_TO
int
ID for the DISPLAY_TO
key.
static final int KEYID_DISPLAY_CC
int
ID for the DISPLAY_CC
key.
static final int KEYID_DISPLAY_BCC
int
ID for the DISPLAY_BCC
key.
static final int KEYID_DISPLAY_FROM
int
ID for the DISPLAY_FROM
key.
static final Key DELIVERY_DATE
static final Key ENCRYPTED
static final Key READ_RECEIPT_REQUESTED
static final Key SENDER_NAME
static final Key SENDER_ADDRESS
static final Key SENT_DATE
static final Key SIGNED
static final Key UNREAD
static final Key DISPLAY_TO
static final Key DISPLAY_CC
static final Key DISPLAY_BCC
static final Key DISPLAY_FROM
static final ItemClass CLASS
Method Detail |
---|
IEmbeddedAttachment addEmbeddedAttachment(String sID, String sName, int iPosition) throws CollaborationException
sID
- the id of the message to embedsName
- the display name of the embedded attachmentiPosition
- the position of the embedded attachment
CollaborationException
- if there was an error creating the
embedded attachmentIMailRecipient addRecipient(RecipientType type, String sAddress, String sName) throws CollaborationException
type
- the RecipientType
to add (must not be null
)sAddress
- the user address (must not be null
)sName
- the user name (may be null
)
CollaborationException
IMessage.RECIPIENTS
IMailRecipient addRecipient(RecipientType type, String sAddress) throws CollaborationException
type
- the RecipientType
to add (must not be null
)sAddress
- the user address (must not be null
)
CollaborationException
IMessage.RECIPIENTS
void removeRecipient(String sAddress) throws CollaborationException
removeRecipient
in interface IMessage
sAddress
- the address to remove (not null
)
CollaborationException
IMessage.RECIPIENTS
void removeRecipient(String sAddress, RecipientType type) throws CollaborationException
sAddress
- the address to remove (not null
)type
- the type of recipient to remove (not
null
).
CollaborationException
IMessage.RECIPIENTS
void removeRecipient(IMailRecipient recipient) throws CollaborationException
recipient
- the recipient to remove (not null
)
CollaborationException
IMessage.RECIPIENTS
IMailRecipient[] getToRecipients() throws CollaborationException
null
)
CollaborationException
IMessage.RECIPIENTS
IMailRecipient[] getCcRecipients() throws CollaborationException
null
)
CollaborationException
IMessage.RECIPIENTS
IMailRecipient[] getBccRecipients() throws CollaborationException
null
)
CollaborationException
IMessage.RECIPIENTS
IMailRecipient[] getRecipientsByType(RecipientType type) throws CollaborationException
type
- the type of recipient to find
null
)
CollaborationException
IMessage.RECIPIENTS
IMailMessage forward(IContainer container) throws CollaborationException
container
- the container to place the new message in
(not null
)
null
)
CollaborationException
- if the provider could not
create a message suitable for forwardingIMailMessage forward(IContainer container, FetchProfile fp) throws CollaborationException
container
- the container to place the forwarded message in
(not null
)fp
- the properties to fetch on the message (not
null
)
null
)
CollaborationException
- if the provider could not
create a message suitable for forwardingIMailMessage reply(IContainer container, boolean bAll) throws CollaborationException
container
- the container to place the forwarded messagebAll
- set to true
to reply
to all recipients on the message; false
to reply to only the sender
null
)
CollaborationException
- if the provider could not
create a message suitable for replyingIMailMessage reply(IContainer container, FetchProfile fp, boolean bAll) throws CollaborationException
container
- the container to place the new message in
(not null
)fp
- the properties to fetch on the new message (not
null
)bAll
- set to true
to reply
to all recipients on the message; false
to reply to only the sender
null
)
CollaborationException
- if the provider could not
create a message suitable for replyingDate getDateDelivered() throws CollaborationException
CollaborationException
DELIVERY_DATE
boolean isEncrypted() throws CollaborationException
true
, the message should be encrypted when
it is sent
CollaborationException
ENCRYPTED
void setEncrypted(boolean bEncrypted) throws CollaborationException
bEncrypted
- if true
, the message should
be encrypted when it is sent
CollaborationException
ENCRYPTED
boolean isReadReceiptRequested() throws CollaborationException
true
, a read receipt is requested from the
receiving client
CollaborationException
READ_RECEIPT_REQUESTED
void setReadReceiptRequested(boolean bReadReceiptRequested) throws CollaborationException
bReadReceiptRequested
- if true
, set the
read receipt requested flag of the message
CollaborationException
READ_RECEIPT_REQUESTED
Date getDateSent() throws CollaborationException
CollaborationException
SENT_DATE
boolean isSigned() throws CollaborationException
true
, the message should be signed when
it is sent
CollaborationException
SIGNED
void setSigned(boolean bSigned) throws CollaborationException
bSigned
- if true
, the message should
be signed when it is sent
CollaborationException
SIGNED
void setUnread(boolean bUnread) throws CollaborationException
bUnread
- true
if this message
should be unread, false
otherwise.
CollaborationException
UNREAD
boolean isUnread() throws CollaborationException
true
if this message
is be unread, false
otherwise.
CollaborationException
UNREAD
String getToAddresses() throws CollaborationException
null
)
CollaborationException
DISPLAY_TO
String getCcAddresses() throws CollaborationException
null
)
CollaborationException
DISPLAY_CC
String getBccAddresses() throws CollaborationException
null
)
CollaborationException
DISPLAY_BCC
String getFromAddresses() throws CollaborationException
null
)
CollaborationException
DISPLAY_FROM
Sender getSender() throws CollaborationException
CollaborationException
- if there was an error getting the sender informationSENDER_NAME
,
SENDER_ADDRESS
void send(IContainer copyTo) throws CollaborationException
copyTo
- the container to move the message (use null
to leave the message)
CollaborationException
- if there was an error commiting the itemvoid send(boolean bDelete) throws CollaborationException
bDelete
- true
to delete the message,
false
to leave it.
CollaborationException
- if there was an error commiting the item
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |