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.

Copyright (c) SAP 2002

Version:

$Revision: 1.0$

Method Summary

void	addAttachment(IAttachment attachment) Adds an attachment to the mail item.
void	deleteAttachment(IAttachment attachment) Deleted an attachment from the mail item.
java.util.List	getAttachmentList() Returns the attachment list associated with the mail item.
java.lang.String	getBcc() Gets the Bcc list for the Mail Item
java.util.List	getBccList() Gets the Bcc list for the Mail Item as a list of EmailAddresses.
java.lang.String	getCc() Gets the Cc list for the Mail Item.
java.util.List	getCcList() Gets the Cc list for the Mail Item as a list of EmailAddresses.
com.sap.ip.collaboration.gw.api.enum.PriorityType	getPriority() 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(java.lang.String bcc) Sets the Bcc list for the Mail Item.
void	setBccList(java.util.List bcc) Sets the Bcc list for the Mail Item as a list of EmailAddresses.
void	setCc(java.lang.String cc) Sets the Cc list for the Mail Item.
void	setCcList(java.util.List cc) Sets the Cc list for the Mail Item as a list of EmailAddresses.
void	setPriority(com.sap.ip.collaboration.gw.api.enum.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, getItemType, getMimeType, getSubject, getTo, getToList, getTransport, getTransportName, remove, save, send, setApplicationData, setContent, setFrom, setFromAddress, setGroupwareManager, setID, setMimeType, setSubject, setTo, setToList, setTransport

Method Detail

addAttachment

public void addAttachment(IAttachment attachment)
                   throws GroupwareException

Adds an attachment to the mail item.

Parameters:

IAttachment - attachment

Throws:

GroupwareException -

deleteAttachment

public void deleteAttachment(IAttachment attachment)
                      throws GroupwareException

Deleted an attachment from the mail item.

Parameters:

IAttachment - attachment object to be deleted.

Throws:

GroupwareException -

getAttachmentList

public java.util.List getAttachmentList()
                                 throws GroupwareException

Returns the attachment list associated with the mail item.

Returns:

List list of IAttachment

Throws:

GroupwareException -

getBcc

public java.lang.String getBcc()
                        throws GroupwareException

Gets the Bcc list for the Mail Item

Throws:

GroupwareException -

getBccList

public java.util.List getBccList()
                          throws GroupwareException

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

Throws:

GroupwareException -

getCc

public java.lang.String getCc()
                       throws GroupwareException

Gets the Cc list for the Mail Item.

Throws:

GroupwareException -

getCcList

public java.util.List getCcList()
                         throws GroupwareException

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

Throws:

GroupwareException -

getPriority

public com.sap.ip.collaboration.gw.api.enum.PriorityType getPriority()
                                                              throws GroupwareException

Gets the priority for the Mail Item.

Throws:

GroupwareException -

getSaveOnSend

public 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 -

send

public 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 -

send

public 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 -

setBcc

public void setBcc(java.lang.String bcc)
            throws GroupwareException

Sets the Bcc list for the Mail Item.

Throws:

GroupwareException -

setBccList

public void setBccList(java.util.List bcc)
                throws GroupwareException

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

Throws:

GroupwareException -

setCc

public void setCc(java.lang.String cc)
           throws GroupwareException

Sets the Cc list for the Mail Item.

Throws:

GroupwareException -

setCcList

public void setCcList(java.util.List cc)
               throws GroupwareException

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

Throws:

GroupwareException -

setPriority

public void setPriority(com.sap.ip.collaboration.gw.api.enum.PriorityType priority)
                 throws GroupwareException

Sets the priority for the Mail Item.

Throws:

GroupwareException -

setSaveOnSend

public 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 -

Throws:

GroupwareException -