MailItem (Lutece 7.0.0-SNAPSHOT API)

java.lang.Object
- fr.paris.lutece.portal.service.mail.MailItem

All Implemented Interfaces:

Serializable
```
public class MailItem
extends Object
implements Serializable
```
MailIem

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FORMAT_CALENDAR`
`static int`	`FORMAT_HTML`
`static int`	`FORMAT_MULTIPART_HTML`
`static int`	`FORMAT_MULTIPART_TEXT`
`static int`	`FORMAT_TEXT`

Constructor Summary

Constructors
Constructor and Description

MailItem()

Constructors
Constructor and Description
`MailItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCalendarMessage()` Returns the calendar message
`boolean`	`getCreateEvent()` Check if the calendar event of this mail item should be created or removed
`List<FileAttachment>`	`getFilesAttachement()` Returns a collection of files attachement
`int`	`getFormat()` Returns the Format
`String`	`getMessage()` Returns the Message
`String`	`getRecipientsBcc()` Returns the Recipient
`String`	`getRecipientsCc()` Returns the Recipient
`String`	`getRecipientsTo()` Returns the Recipient
`String`	`getSenderEmail()` Returns the SenderEmail
`String`	`getSenderName()` Returns the SenderName
`String`	`getSubject()` Returns the Subject
`List<UrlAttachment>`	`getUrlsAttachement()` return the list of urls attachement
`boolean`	`isUniqueRecipientTo()`
`void`	`setCalendarMessage(String strCalendarMessage)` Sets the calendar message
`void`	`setCreateEvent(boolean bCreateEvent)` Create or remove the event of this mail item
`void`	`setFilesAttachement(List<FileAttachment> fileAttachements)` Set a collection of files attachement
`void`	`setFormat(int nFormat)` Sets the Format
`void`	`setMessage(String strMessage)` Sets the Message
`void`	`setRecipientsBcc(String strRecipient)` Sets the Recipient
`void`	`setRecipientsCc(String strRecipient)` Sets the Recipient
`void`	`setRecipientsTo(String strRecipient)` Sets the Recipient
`void`	`setSenderEmail(String strSenderEmail)` Sets the SenderEmail
`void`	`setSenderName(String strSenderName)` Sets the SenderName
`void`	`setSubject(String strSubject)` Sets the Subject
`void`	`setUniqueRecipientTo(boolean bUniqueRecipient)` set true if the mail must be send unitarily for each recipient
`void`	`setUrlsAttachement(List<UrlAttachment> urlsAttachement)` set the list of urls attachement

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FORMAT_HTML
```
public static final int FORMAT_HTML
```
    See Also:
    
    Constant Field Values
  - FORMAT_TEXT
```
public static final int FORMAT_TEXT
```
    See Also:
    
    Constant Field Values
  - FORMAT_MULTIPART_HTML
```
public static final int FORMAT_MULTIPART_HTML
```
    See Also:
    
    Constant Field Values
  - FORMAT_MULTIPART_TEXT
```
public static final int FORMAT_MULTIPART_TEXT
```
    See Also:
    
    Constant Field Values
  - FORMAT_CALENDAR
```
public static final int FORMAT_CALENDAR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MailItem
```
public MailItem()
```
- Method Detail
  - getRecipientsTo
```
public String getRecipientsTo()
```
    Returns the Recipient
    
    Returns:
    
    The Recipient
  - setRecipientsTo
```
public void setRecipientsTo(String strRecipient)
```
    Sets the Recipient
    
    Parameters:
    
    strRecipient - The Recipient
  - getRecipientsCc
```
public String getRecipientsCc()
```
    Returns the Recipient
    
    Returns:
    
    The Recipient
  - setRecipientsCc
```
public void setRecipientsCc(String strRecipient)
```
    Sets the Recipient
    
    Parameters:
    
    strRecipient - The Recipient
  - getRecipientsBcc
```
public String getRecipientsBcc()
```
    Returns the Recipient
    
    Returns:
    
    The Recipient
  - setRecipientsBcc
```
public void setRecipientsBcc(String strRecipient)
```
    Sets the Recipient
    
    Parameters:
    
    strRecipient - The Recipient
  - getSenderName
```
public String getSenderName()
```
    Returns the SenderName
    
    Returns:
    
    The SenderName
  - setSenderName
```
public void setSenderName(String strSenderName)
```
    Sets the SenderName
    
    Parameters:
    
    strSenderName - The SenderName
  - getSenderEmail
```
public String getSenderEmail()
```
    Returns the SenderEmail
    
    Returns:
    
    The SenderEmail
  - setSenderEmail
```
public void setSenderEmail(String strSenderEmail)
```
    Sets the SenderEmail
    
    Parameters:
    
    strSenderEmail - The SenderEmail
  - getSubject
```
public String getSubject()
```
    Returns the Subject
    
    Returns:
    
    The Subject
  - setSubject
```
public void setSubject(String strSubject)
```
    Sets the Subject
    
    Parameters:
    
    strSubject - The Subject
  - getMessage
```
public String getMessage()
```
    Returns the Message
    
    Returns:
    
    The Message
  - setMessage
```
public void setMessage(String strMessage)
```
    Sets the Message
    
    Parameters:
    
    strMessage - The Message
  - getCalendarMessage
```
public String getCalendarMessage()
```
    Returns the calendar message
    
    Returns:
    
    The calendar message
  - setCalendarMessage
```
public void setCalendarMessage(String strCalendarMessage)
```
    Sets the calendar message
    
    Parameters:
    
    strCalendarMessage - The calendar message
  - getCreateEvent
```
public boolean getCreateEvent()
```
    Check if the calendar event of this mail item should be created or removed
    
    Returns:
    
    True if the event should be created, false if it should be removed
  - setCreateEvent
```
public void setCreateEvent(boolean bCreateEvent)
```
    Create or remove the event of this mail item
    
    Parameters:
    
    bCreateEvent - True to create the event, false otherwise
  - getFormat
```
public int getFormat()
```
    Returns the Format
    
    Returns:
    
    The Format
  - setFormat
```
public void setFormat(int nFormat)
```
    Sets the Format
    
    Parameters:
    
    nFormat - The Format
  - getFilesAttachement
```
public List<FileAttachment> getFilesAttachement()
```
    Returns a collection of files attachement
    
    Returns:
    
    The Attachements Map
  - setFilesAttachement
```
public void setFilesAttachement(List<FileAttachment> fileAttachements)
```
    Set a collection of files attachement
    
    Parameters:
    
    fileAttachements - The collection of files attachement
  - getUrlsAttachement
```
public List<UrlAttachment> getUrlsAttachement()
```
    return the list of urls attachement
    
    Returns:
    
    the list of urls attachement
  - setUrlsAttachement
```
public void setUrlsAttachement(List<UrlAttachment> urlsAttachement)
```
    set the list of urls attachement
    
    Parameters:
    
    urlsAttachement - the list of urls attachement
  - setUniqueRecipientTo
```
public void setUniqueRecipientTo(boolean bUniqueRecipient)
```
    set true if the mail must be send unitarily for each recipient
    
    Parameters:
    
    bUniqueRecipient - true if the mail must be send unitarily for each recipient
  - isUniqueRecipientTo
```
public boolean isUniqueRecipientTo()
```
    Returns:
    
    if the mail must be send unitarily for each recipient

Class MailItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORMAT_HTML

FORMAT_TEXT

FORMAT_MULTIPART_HTML

FORMAT_MULTIPART_TEXT

FORMAT_CALENDAR

Constructor Detail

MailItem

Method Detail

getRecipientsTo

setRecipientsTo

getRecipientsCc

setRecipientsCc

getRecipientsBcc

setRecipientsBcc

getSenderName

setSenderName

getSenderEmail

setSenderEmail

getSubject

setSubject

getMessage

setMessage

getCalendarMessage

setCalendarMessage

getCreateEvent

setCreateEvent

getFormat

setFormat

getFilesAttachement

setFilesAttachement

getUrlsAttachement

setUrlsAttachement

setUniqueRecipientTo

isUniqueRecipientTo