public final class UserSettingMail
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
UserSettingMail
- User's mail settings.Modifier and Type | Class and Description |
---|---|
static class |
UserSettingMail.Signature
UserSettingMail.Signature - The mail signature. |
Modifier and Type | Field and Description |
---|---|
static int |
INT_ALLOW_HTML_IMAGES
If this bit is set, it is allowed to display images which appear in HTML content of a message.
|
static int |
INT_APPEND_VCARD
If this bit is set, a VCard created from user's contact data is appended to a sent message
|
static int |
INT_DISPLAY_HTML_INLINE_CONTENT
If this bit is set, html content is displayed on message display
|
static int |
INT_FORWARD_AS_ATTACHMENT
If this bit is set, a forwarded message is appended as an message/rfc822 attachment instead of an inline forward
|
static int |
INT_HARD_DELETE_MSGS
If this bit is set, no copy of a deleted message is created in default "trash" folder.
|
static int |
INT_IGNORE_ORIGINAL_TEXT_ON_REPLY
If this bit is set, no message body text is extracted (and displayed) from the message to which the user replies
|
static int |
INT_MSG_PREVIEW
This constant is currently not in use
|
static int |
INT_NO_COPY_INTO_SENT_FOLDER
If this bit is set, no copy of a sent mail is created in default "sent" folder
|
static int |
INT_NOTIFY_APPOINTMENTS
If this bit is set, the user will receive notification messages on appointment events (creation, deletion & change)
|
static int |
INT_NOTIFY_APPOINTMENTS_CONFIRM_OWNER
If this bit is set, the user will receive notification messages on appointment events (accept, decline & tentatively accepted) as the
appointment's owner.
|
static int |
INT_NOTIFY_APPOINTMENTS_CONFIRM_PARTICIPANT
If this bit is set, the user will receive notification messages on appointment events (accept, decline & tentatively accepted) as an
appointment's participant.
|
static int |
INT_NOTIFY_ON_READ_ACK
If this bit is set, the user is notified if a message contains a read acknowledgment
|
static int |
INT_NOTIFY_TASKS
If this bit is set, the user will receive notification messages on task events (creation, deletion & change)
|
static int |
INT_NOTIFY_TASKS_CONFIRM_OWNER
If this bit is set, the user will receive notification messages on task events (accept, decline & tentatively accepted) as the task's
owner.
|
static int |
INT_NOTIFY_TASKS_CONFIRM_PARTICIPANT
If this bit is set, the user will receive notification messages on task events (accept, decline & tentatively accepted) as a task's
participant.
|
static int |
INT_REPLY_ALL_CC
If this bit is set, the reply-all method will put all recipients except the original sender in the Cc list.
|
static int |
INT_SHOW_GRAPHIC_EMOTICONS
If this bit is set, emoticons like :-) are replaced with a little graphic
|
static int |
INT_SPAM_ENABLED
If this bit is set, the spam feature is enabled
|
static int |
INT_TEXT_ONLY_COMPOSE
If this bit is set, only plain text is allowed when composing reply/forward messages.
|
static int |
INT_USE_COLOR_QUOTE
If this bit is set, the quote levels of a plain text message are colorized
|
static int |
MSG_FORMAT_BOTH |
static int |
MSG_FORMAT_HTML_ONLY |
static int |
MSG_FORMAT_TEXT_ONLY |
Constructor and Description |
---|
UserSettingMail(int userId,
int cid)
Initializes a new
UserSettingMail . |
Modifier and Type | Method and Description |
---|---|
UserSettingMail |
clone() |
int |
getAttachOriginalMessage()
Checks whether to attach original message
|
int |
getAutoLinebreak()
Gets the character count after which a line break is added in
text/plain messages |
int |
getBitsValue()
Generates a bit pattern from this settings
|
int |
getCid()
Gets the context ID.
|
java.lang.String |
getConfirmedHam()
Gets the name of the confirmed ham folder.
|
java.lang.String |
getConfirmedSpam()
Gets the name of the confirmed spam folder.
|
java.lang.String[] |
getDisplayMsgHeaders()
Define an array of message headers which shall be displayed for this user in mail's detail view.
|
int |
getMsgFormat()
Indicates the desired message format when preparing a message for transport.
|
java.lang.String |
getReplyToAddr()
The desired address that shall be set as
Reply-To header when sending messages. |
java.lang.String |
getSendAddr()
The default send address.
|
UserSettingMail.Signature[] |
getSignatures()
Gets the user-defined signatures that are either prepended or appended to a message's body.
|
java.lang.String |
getStdDraftsName()
Gets the name of the draft folder.
|
java.lang.String |
getStdSentName()
Gets the name of the sent folder.
|
java.lang.String |
getStdSpamName()
Gets the name of the spam folder.
|
java.lang.String |
getStdTrashName()
Gets the name of the trash folder.
|
long |
getUploadQuota()
Gets the overall upload quota limit when uploading several file attachments.
|
long |
getUploadQuotaPerFile()
Gets the upload quota limit per file when uploading several file attachments.
|
int |
getUserId()
Gets the user ID.
|
boolean |
isAllowHTMLImages()
Indicates if user allows to display images which appear in HTML content of a message.
|
boolean |
isAppendVCard()
Checks if user's VCard shall be attached to a message on transport
|
boolean |
isDisplayHtmlInlineContent()
Checks if user allows to display inline HTML content of a message.
|
boolean |
isDropReplyForwardPrefix()
Gets the dropReplyForwardPrefix.
|
boolean |
isForwardAsAttachment()
Checks if a forwarded message is supposed to be added as an attachment; otherwise it is added inline.
|
boolean |
isHardDeleteMsgs()
Checks if messages are supposed to be deleted permanently or a backup is moved to trash folder.
|
boolean |
isIgnoreOriginalMailTextOnReply()
Checks if original message's content shall be ignored in reply version to the message
|
boolean |
isModifiedDuringSession()
Internal flag to track this mail setting's modified status.
|
boolean |
isMsgPreview()
Currently not used
|
boolean |
isNoCopyIntoStandardSentFolder()
Checks if a sent message shall be copied into sent folder
|
boolean |
isNoSave()
Checks if this instance of
UserSettingMail is allowed to being saved to storage |
boolean |
isNotifyAppointments()
Checks if the user will receive notification messages on appointment events (creation, deletion & change).
|
boolean |
isNotifyAppointmentsConfirmOwner()
Checks if the user will receive notification messages on appointment events (accept, decline & tentatively accepted) as the
appointment's owner.
|
boolean |
isNotifyAppointmentsConfirmParticipant()
Checks if the user will receive notification messages on appointment events (accept, decline & tentatively accepted) as an
appointment's participant.
|
boolean |
isNotifyOnReadAck()
Currently not used
|
boolean |
isNotifyTasks()
Checks if the user will receive notification messages on task events (creation, deletion & change).
|
boolean |
isNotifyTasksConfirmOwner()
Checks if the user will receive notification messages on task events (accept, decline & tentatively accepted) as the task's owner.
|
boolean |
isNotifyTasksConfirmParticipant()
Checks if the user will receive notification messages on task events (accept, decline & tentatively accepted) as a task's
participant.
|
boolean |
isReplyAllCc()
Indicates if the reply-all method will put all recipients except the original sender in the Cc list.
|
boolean |
isShowGraphicEmoticons()
Indicates if user wants to see graphical emoticons rather than corresponding textual representation
|
boolean |
isSpamEnabled()
Checks if user has spam enabled.
|
boolean |
isSpamOptionEnabled()
Checks if user has spam enabled.
|
boolean |
isSuppressHTMLAlternativePart()
Whether to suppress HTML parts in text-only mode for multipart/alternative.
|
boolean |
isTextOnlyCompose()
Currently not used.
|
boolean |
isUseColorQuote()
Indicates if user wants to see reply quotes inside a message's content indented in a color dependent on quote level.
|
void |
parseBits(int onOffOptions)
Parses given bit pattern and applies it to this settings
|
void |
setAllowHTMLImages(boolean allowHTMLImages) |
void |
setAppendVCard(boolean appendVCard) |
void |
setAttachOriginalMessage(boolean attachOriginalMessage) |
void |
setAutoLinebreak(int autoLineBreak) |
void |
setConfirmedHam(java.lang.String confirmedHam) |
void |
setConfirmedSpam(java.lang.String confirmedSpam) |
void |
setDisplayHtmlInlineContent(boolean htmlPreview) |
void |
setDisplayMsgHeaders(java.lang.String[] displayMsgHeaders) |
void |
setDropReplyForwardPrefix(boolean dropReplyForwardPrefix)
Sets the dropReplyForwardPrefix.
|
void |
setForwardAsAttachment(boolean forwardAsAttachment) |
void |
setHardDeleteMsgs(boolean hardDeleteMessages) |
void |
setIgnoreOriginalMailTextOnReply(boolean appendOriginalMailTextToReply) |
void |
setMsgFormat(int msgFormat) |
void |
setMsgPreview(boolean msgPreview) |
void |
setNoCopyIntoStandardSentFolder(boolean noCopyIntoStandardSentFolder) |
void |
setNoSave(boolean noSave)
Sets the
no-save attribute. |
void |
setNotifyAppointments(boolean notifyAppointments) |
void |
setNotifyAppointmentsConfirmOwner(boolean notifyAppointmentsConfirmOwner)
Sets the notifyAppointmentsConfirmOwner
|
void |
setNotifyAppointmentsConfirmParticipant(boolean notifyAppointmentsConfirmParticipant)
Sets the notifyAppointmentsConfirmParticipant
|
void |
setNotifyOnReadAck(boolean notifyOnReadAck) |
void |
setNotifyTasks(boolean notifyTasks) |
void |
setNotifyTasksConfirmOwner(boolean notifyTasksConfirmOwner)
Sets the notifyTasksConfirmOwner
|
void |
setNotifyTasksConfirmParticipant(boolean notifyTasksConfirmParticipant)
Sets the notifyTasksConfirmParticipant
|
void |
setReplyAllCc(boolean replyAllCc)
Sets whether the reply-all method will put all recipients except the original sender in the Cc list.
|
void |
setReplyToAddr(java.lang.String replyToAddr) |
void |
setSendAddr(java.lang.String sendAddr) |
void |
setShowGraphicEmoticons(boolean showGraphicEmoticons) |
void |
setSignatures(UserSettingMail.Signature[] signatures) |
void |
setSpamEnabled(boolean spamEnabled) |
void |
setStdDraftsName(java.lang.String stdDraftsName) |
void |
setStdSentName(java.lang.String stdSentName) |
void |
setStdSpamName(java.lang.String stdSpamName) |
void |
setStdTrashName(java.lang.String stdTrashName) |
void |
setSuppressHTMLAlternativePart(boolean suppressHTMLAlternativePart)
Sets whether to suppress HTML parts in text-only mode for multipart/alternative.
|
void |
setTextOnlyCompose(boolean textOnlyCompose) |
void |
setUploadQuota(long uploadQuota) |
void |
setUploadQuotaPerFile(long uploadQuotaPerFile) |
void |
setUseColorQuote(boolean useColorQuote) |
public static final int INT_DISPLAY_HTML_INLINE_CONTENT
public static final int INT_USE_COLOR_QUOTE
public static final int INT_SHOW_GRAPHIC_EMOTICONS
public static final int INT_HARD_DELETE_MSGS
public static final int INT_FORWARD_AS_ATTACHMENT
public static final int INT_APPEND_VCARD
public static final int INT_NOTIFY_ON_READ_ACK
public static final int INT_MSG_PREVIEW
public static final int INT_NOTIFY_APPOINTMENTS
public static final int INT_NOTIFY_TASKS
public static final int INT_IGNORE_ORIGINAL_TEXT_ON_REPLY
public static final int INT_NO_COPY_INTO_SENT_FOLDER
public static final int INT_SPAM_ENABLED
public static final int INT_TEXT_ONLY_COMPOSE
public static final int INT_ALLOW_HTML_IMAGES
public static final int INT_NOTIFY_APPOINTMENTS_CONFIRM_OWNER
public static final int INT_NOTIFY_APPOINTMENTS_CONFIRM_PARTICIPANT
public static final int INT_NOTIFY_TASKS_CONFIRM_OWNER
public static final int INT_NOTIFY_TASKS_CONFIRM_PARTICIPANT
public static final int INT_REPLY_ALL_CC
public static final int MSG_FORMAT_TEXT_ONLY
public static final int MSG_FORMAT_HTML_ONLY
public static final int MSG_FORMAT_BOTH
public UserSettingMail(int userId, int cid)
UserSettingMail
.userId
- The user IDcid
- The context IDpublic UserSettingMail clone()
clone
in class java.lang.Object
public int getAutoLinebreak()
text/plain
messagespublic boolean isDropReplyForwardPrefix()
public void setDropReplyForwardPrefix(boolean dropReplyForwardPrefix)
dropReplyForwardPrefix
- The dropReplyForwardPrefix to setpublic int getBitsValue()
public java.lang.String getConfirmedHam()
Note: This is only the name, not its fullname.
public java.lang.String getConfirmedSpam()
Note: This is only the name, not its fullname.
public java.lang.String[] getDisplayMsgHeaders()
public int getMsgFormat()
The returned int
value is one of MSG_FORMAT_TEXT_ONLY
, MSG_FORMAT_HTML_ONLY
, and
MSG_FORMAT_BOTH
.
public java.lang.String getReplyToAddr()
Reply-To
header when sending messages.
If returned value is null
or empty, the message's From
header is used as fallback.
Reply-To
addresspublic java.lang.String getSendAddr()
From
header and the Sender
header as well.public UserSettingMail.Signature[] getSignatures()
public java.lang.String getStdDraftsName()
Note: This is only the name, not its fullname.
public java.lang.String getStdSentName()
Note: This is only the name, not its fullname.
public java.lang.String getStdSpamName()
Note: This is only the name, not its fullname.
public java.lang.String getStdTrashName()
Note: This is only the name, not its fullname.
public long getUploadQuota()
public long getUploadQuotaPerFile()
public boolean isAppendVCard()
true
if user's VCard shall be attached to a message on transport; otherwise false
public boolean isDisplayHtmlInlineContent()
true
if user allows to display inline HTML content of a message; otherwise false
public boolean isSuppressHTMLAlternativePart()
true
to suppress HTML parts in text-only mode for multipart/alternative; otherwise false
public boolean isForwardAsAttachment()
true
if a forwarded message is supposed to be added as an attachment; otherwise false
if it is
added inline.public int getAttachOriginalMessage()
1
to attach original message; 0
to not attach or -1
if not set at allpublic boolean isHardDeleteMsgs()
true
if messages are supposed to be deleted permanently; otherwise false
to backup in trash folderpublic boolean isIgnoreOriginalMailTextOnReply()
true
if original message's content shall be ignored; otherwise false
to include.public boolean isModifiedDuringSession()
true
if modified during session (and to force a reload); otherwise false
public boolean isMsgPreview()
public boolean isNoCopyIntoStandardSentFolder()
true
if a sent message shall be copied into sent folder; otherwise false
public boolean isNotifyAppointments()
true
if the user will receive notification messages on appointment events (creation, deletion & change);
otherwise false
public boolean isNotifyAppointmentsConfirmOwner()
true
if the user will receive notification messages on appointment events (accept, decline & tentatively
accepted) as the appointment's owner; otherwise false
.public boolean isNotifyAppointmentsConfirmParticipant()
true
if the user will receive notification messages on appointment events (accept, decline & tentatively
accepted) as an appointment's participant; otherwise false
.public boolean isNotifyTasksConfirmOwner()
true
if the user will receive notification messages on task events (accept, decline & tentatively accepted) as
the task's owner; otherwise false
.public boolean isNotifyTasksConfirmParticipant()
true
if the user will receive notification messages on task events (accept, decline & tentatively accepted) as a
task's participant; otherwise false
.public boolean isNotifyOnReadAck()
public boolean isNotifyTasks()
true
if the user will receive notification messages on task events (creation, deletion & change); otherwise
false
public boolean isShowGraphicEmoticons()
true
if user wants to see graphical emoticons rather than corresponding textual representation; otherwise
false
public boolean isSpamEnabled()
true
if user has spam enabled; otherwise false
public boolean isSpamOptionEnabled()
Note: This method does not check if an appropriate spam handler is defined by user's mail provider. To reliably check full
spam support call isSpamEnabled()
.
true
if user has spam enabled; otherwise false
public boolean isTextOnlyCompose()
public boolean isAllowHTMLImages()
true
if user allows to display images; otherwise false
public boolean isReplyAllCc()
true
if the reply-all method will put all recipients except the original sender in the Cc list; otherwise
false
.public boolean isUseColorQuote()
true
to indent in color; otherwise false
public boolean isNoSave()
UserSettingMail
is allowed to being saved to storagetrue
if this instance of UserSettingMail
is allowed to being saved to storage; otherwise
false
public void parseBits(int onOffOptions)
onOffOptions
- The bit patternpublic void setAppendVCard(boolean appendVCard)
public void setAutoLinebreak(int autoLineBreak)
public void setConfirmedHam(java.lang.String confirmedHam)
public void setConfirmedSpam(java.lang.String confirmedSpam)
public void setDisplayHtmlInlineContent(boolean htmlPreview)
public void setSuppressHTMLAlternativePart(boolean suppressHTMLAlternativePart)
suppressHTMLAlternativePart
- true
to suppress HTML parts in text-only mode for multipart/alternative; otherwise false
public void setDisplayMsgHeaders(java.lang.String[] displayMsgHeaders)
public void setForwardAsAttachment(boolean forwardAsAttachment)
public void setAttachOriginalMessage(boolean attachOriginalMessage)
public void setHardDeleteMsgs(boolean hardDeleteMessages)
public void setIgnoreOriginalMailTextOnReply(boolean appendOriginalMailTextToReply)
public void setMsgFormat(int msgFormat)
public void setMsgPreview(boolean msgPreview)
public void setNoCopyIntoStandardSentFolder(boolean noCopyIntoStandardSentFolder)
public void setNotifyAppointments(boolean notifyAppointments)
public void setNotifyOnReadAck(boolean notifyOnReadAck)
public void setNotifyTasks(boolean notifyTasks)
public void setReplyToAddr(java.lang.String replyToAddr)
public void setSendAddr(java.lang.String sendAddr)
public void setShowGraphicEmoticons(boolean showGraphicEmoticons)
public void setSignatures(UserSettingMail.Signature[] signatures)
public void setSpamEnabled(boolean spamEnabled)
public void setStdDraftsName(java.lang.String stdDraftsName)
public void setStdSentName(java.lang.String stdSentName)
public void setStdSpamName(java.lang.String stdSpamName)
public void setStdTrashName(java.lang.String stdTrashName)
public void setTextOnlyCompose(boolean textOnlyCompose)
public void setAllowHTMLImages(boolean allowHTMLImages)
public void setReplyAllCc(boolean replyAllCc)
replyAllCc
- true
if the reply-all method will put all recipients except the original sender in the Cc list;
otherwise false
.public void setUploadQuota(long uploadQuota)
public void setUploadQuotaPerFile(long uploadQuotaPerFile)
public void setUseColorQuote(boolean useColorQuote)
public void setNotifyAppointmentsConfirmOwner(boolean notifyAppointmentsConfirmOwner)
notifyAppointmentsConfirmOwner
- the notifyAppointmentsConfirmOwner to setpublic void setNotifyAppointmentsConfirmParticipant(boolean notifyAppointmentsConfirmParticipant)
notifyAppointmentsConfirmParticipant
- the notifyAppointmentsConfirmParticipant to setpublic void setNotifyTasksConfirmOwner(boolean notifyTasksConfirmOwner)
notifyTasksConfirmOwner
- the notifyTasksConfirmOwner to setpublic void setNotifyTasksConfirmParticipant(boolean notifyTasksConfirmParticipant)
notifyTasksConfirmParticipant
- the notifyTasksConfirmParticipant to setpublic void setNoSave(boolean noSave)
no-save
attribute. If set to true
this instance of UserSettingMail
cannot be saved to
storage.noSave
- true
to deny saving this instance of UserSettingMail
to storage; otherwise false
public int getUserId()
public int getCid()