com.sap.ip.collaboration.gw.api.framework.groupware

Interface IMailItem

All Superinterfaces:

IGroupwareItem

public interface IMailItem
extends IGroupwareItem

This interface represents a mail item used for the send mail operation and extends from the IGroupwareItem interface.

Method Summary

void	addAttachment(IAttachment attachment) Adds an attachment to the mail item.
void	deleteAttachment(IAttachment attachment) Deleted an attachment from the mail item.
List	getAttachmentList() Returns the attachment list associated with the mail item.
String	getBcc() Gets the Bcc list for the Mail Item
List	getBccList() Gets the Bcc list for the Mail Item as a list of EmailAddresses.
String	getCc() Gets the Cc list for the Mail Item.
List	getCcList() Gets the Cc list for the Mail Item as a list of EmailAddresses.
PriorityType	getPriorityEnum() Gets the priority for the Mail Item.
boolean	getSaveOnSend() Gets a boolean flag indicating whether the mail item should be saved in the 'Sent Items' folder or not.
void	send() Sends the groupware item without any credentials (Used when the SMTP server does not authenticate the user sending the mail.)
void	send(IGroupwareCredentials smtp, IGroupwareCredentials groupware) Sends the mail item when the credentials for the SMTP server are different from from the groupware server.
void	setBcc(String bcc) Sets the Bcc list for the Mail Item.
void	setBccList(List bcc) Sets the Bcc list for the Mail Item as a list of EmailAddresses.
void	setCc(String cc) Sets the Cc list for the Mail Item.
void	setCcList(List cc) Sets the Cc list for the Mail Item as a list of EmailAddresses.
void	setPriority(PriorityType priority) Sets the priority for the Mail Item.
void	setSaveOnSend(boolean flag) Sets a boolean flag indicating whether the mail item should be saved in the 'Sent Items' folder or not.

Methods inherited from interface com.sap.ip.collaboration.gw.api.framework.groupware.IGroupwareItem

getApplicationData, getContent, getFrom, getFromAddress, getGroupwareManager, getID, getItemTypeEnum, getMimeType, getSubject, getTo, getToList, getTransport, getTransportName, remove, remove, remove, remove, save, save, send, send, setApplicationData, setContent, setFrom, setFromAddress, setGroupwareManager, setID, setMimeType, setSubject, setTo, setToList, setTransport

Method Detail

setCc

void setCc(String cc)
           throws GroupwareException

Sets the Cc list for the Mail Item.

Throws:

GroupwareException - When error occurs

getCc

String getCc()
             throws GroupwareException

Gets the Cc list for the Mail Item.

Throws:

GroupwareException - When error occurs

setCcList

void setCcList(List cc)
               throws GroupwareException

Sets the Cc list for the Mail Item as a list of EmailAddresses.

Throws:

GroupwareException - When error occurs

getCcList

List getCcList()
               throws GroupwareException

Gets the Cc list for the Mail Item as a list of EmailAddresses.

Throws:

GroupwareException - When error occurs

setBcc

void setBcc(String bcc)
            throws GroupwareException

Sets the Bcc list for the Mail Item.

Throws:

GroupwareException - When error occurs

getBcc

String getBcc()
              throws GroupwareException

Gets the Bcc list for the Mail Item

Throws:

GroupwareException - When error occurs

setBccList

void setBccList(List bcc)
                throws GroupwareException

Sets the Bcc list for the Mail Item as a list of EmailAddresses.

Throws:

GroupwareException - When error occurs

getBccList

List getBccList()
                throws GroupwareException

Gets the Bcc list for the Mail Item as a list of EmailAddresses.

Throws:

GroupwareException - When error occurs

setPriority

void setPriority(PriorityType priority)
                 throws GroupwareException

Sets the priority for the Mail Item.

Throws:

GroupwareException - When error occurs

Since:

NetWeaver 7.1

getPriorityEnum

PriorityType getPriorityEnum()
                             throws GroupwareException

Gets the priority for the Mail Item.

Throws:

GroupwareException - When error occurs

Since:

NetWeaver 7.1

setSaveOnSend

void setSaveOnSend(boolean flag)
                   throws GroupwareException

Sets a boolean flag indicating whether the mail item should be saved in the 'Sent Items' folder or not.

Parameters:

flag - to indicate whether the mail item to be saved in sent to folder or not

Throws:

GroupwareException - When error occurs

getSaveOnSend

boolean getSaveOnSend()
                      throws GroupwareException

Gets a boolean flag indicating whether the mail item should be saved in the 'Sent Items' folder or not.

Throws:

GroupwareException - When error occurs

send

void send()
          throws GroupwareException

Sends the groupware item without any credentials (Used when the SMTP server does not authenticate the user sending the mail.)

Throws:

GroupwareException - When error occurs

send

void send(IGroupwareCredentials smtp,
          IGroupwareCredentials groupware)
          throws GroupwareException

Sends the mail item when the credentials for the SMTP server are different from from the groupware server.

Parameters:

credentials - SMTP crdentials

credentials - groupware credentials

Throws:

GroupwareException - When error occurs

getAttachmentList

List getAttachmentList()
                       throws GroupwareException

Returns the attachment list associated with the mail item.

Returns:

List list of IAttachment

Throws:

GroupwareException - When error occurs

addAttachment

void addAttachment(IAttachment attachment)
                   throws GroupwareException

Adds an attachment to the mail item.

Parameters:

IAttachment - Object

Throws:

GroupwareException - When error occurs

deleteAttachment

void deleteAttachment(IAttachment attachment)
                      throws GroupwareException

Deleted an attachment from the mail item.

Parameters:

IAttachment - attachment object to be deleted.

Throws:

GroupwareException - When error occurs

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/gw	api	EP-KM-COL