public class MessageService extends Object
送信や一時保存時、メールIDがNull,または空文字、空白の場合、新規のメールとして取り扱います。 新規のメールの場合、IDは自動的に採番されます。 メールIDが入力されていた場合、下書きからの送信とみなし、DBの下書き情報と照合します。下書きが存在しない場合、エラーになります。
メール本文の容量は以下の情報のバイト数合計です。
コンストラクタと説明 |
---|
MessageService()
コンストラクター。
|
修飾子とタイプ | メソッドと説明 |
---|---|
int |
count(String folderCd,
MessageListOptions options)
特定のフォルダ配下のメッセージ数を取得します。
|
int |
countExportMessages(MessageExportListOptions option)
エクスポート用に条件を指定した際に対象になるメールの件数を返します。
|
int |
countSearchResult(String folderCd,
String keyword,
MessageSearchOptions options)
特定のフォルダのメールを検索し、対象となる件数を返します。
|
int |
countStatus(String mailId)
|
int |
countUnreads()
ゴミ箱以外にある未読メールの件数を返します。
|
int |
fetch()
メールの受信処理を行います。
|
Message |
get(String mailId)
メッセージを取得します。
|
Message |
getDetail(String mailId,
Integer mailSubId)
メッセージを取得します。
|
List<MessageListItem> |
list(String folderCd,
MessageListOptions options,
int offset,
int length)
指定のフォルダ直下のメールの一覧を返します。
|
List<Message> |
listExportMessages(MessageExportListOptions option,
int offset,
int length)
エクスポートのためにメールの詳細情報を一覧にして返します。
|
List<StatusListItem> |
listStatus(String mailId,
StatusListOption option,
int offset,
int length)
メールの閲覧状況を取得します。
|
List<UnreadListItem> |
listUnreads(UnreadListOption option,
int offset,
int length)
ゴミ箱以外にある未読メールの一覧を返します。
|
void |
markAsRead(MessageIdentifier... mailIds)
指定のメールを既読にします。
|
void |
markAsReadAtAllFolders(String... mailIds)
ログインユーザが保持する指定のmailIdを持つメールをすべて既読状態にします。
|
void |
markAsUnread(MessageIdentifier... mailIds)
指定のメールを未読にします。
|
void |
markAsUnreadAtAllFolders(String... mailIds)
ログインユーザが保持する指定のmailIdを持つメールをすべて未読状態にします。
|
void |
moveTo(String to,
MessageIdentifier... mailIds)
複数のメールを指定のフォルダに移動します。
|
Message |
prepareNew()
新規作成時用のメッセージオブジェクトを作成して返します。
|
Message |
prepareToCopy(String mailId)
メールを流用用に変換したものを返します。
|
Message |
prepareToEdit(String mailId)
一時保存しているメールを編集用に開きます。
|
Message |
prepareToForward(String mailId)
メールを転送用に変換したものを返します。
|
Message |
prepareToReply(String mailId)
メールを返信用に変換したものを返します。
|
Message |
prepareToReplyAll(String mailId)
メールを全員に返信用に変換したものを返します。
|
void |
pullBack(String mailId)
送信したメールの取り消し処理を行います。
|
void |
remove(MessageIdentifier... mailIds)
通常のフォルダに格納されている場合、ゴミ箱に移動します。
|
void |
removeFromFolder(String folderCd,
MessageIdentifier... mailIds)
指定のフォルダからメッセージを削除します。
|
String |
save(Message message)
メールを下書き保存します。
|
List<MessageListItem> |
search(String folderCd,
String keyword,
MessageSearchOptions options,
int offset,
int length)
特定のフォルダのメールを検索します。
|
String |
send(Message message)
メールを送信します。
|
@JSFunction public int count(String folderCd, MessageListOptions options) throws GroupMailException
folderCd
- フォルダコードoptions
- 検索オプションGroupMailException
- 指定のフォルダが存在しない場合@JSFunction public int countExportMessages(MessageExportListOptions option) throws GroupMailValidationException
option
- 検索オプションGroupMailValidationException
- 検索条件に問題がある場合@JSFunction public int countSearchResult(String folderCd, String keyword, MessageSearchOptions options) throws GroupMailException
folderCd
- フォルダコードkeyword
- 検索キーワード。指定しない場合nulloptions
- 検索オプションGroupMailException
- 指定のフォルダが存在しない場合@JSFunction public int countStatus(String mailId)
listStatus(java.lang.String, jp.co.ucm.im.groupmail.api.models.StatusListOption, int, int)
の対象となる受信者の件数を返します。mailId
- メールID@JSFunction public int countUnreads()
@JSFunction public int fetch()
@JSFunction public Message get(String mailId)
getDetail(java.lang.String, java.lang.Integer)
を使用します。mailId
- メッセージID@JSFunction public Message getDetail(String mailId, Integer mailSubId)
get(java.lang.String)
を使用します。mailSubId
はnullを受け付けるようになりました。 mailSubId
を指定した場合、特定のフォルダに格納されたメールの状態を既読状態にします。未指定の場合、ログインユーザの持つメッセージIDがmessageId
に一致するメッセージはすべて既読状態になります。mailId
- メッセージIDmailSubId
- メールサブID@JSFunction public List<MessageListItem> list(String folderCd, MessageListOptions options, int offset, int length) throws GroupMailException
folderCd
- フォルダコードoptions
- 検索オプションoffset
- 取得開始件数length
- 取得件数GroupMailException
- 対象のフォルダ参照に失敗した場合@JSFunction public List<Message> listExportMessages(MessageExportListOptions option, int offset, int length) throws GroupMailValidationException
option
- 検索オプションoffset
- 取得開始位置length
- 取得件数GroupMailValidationException
- 検索条件に問題がある場合@JSFunction public List<StatusListItem> listStatus(String mailId, StatusListOption option, int offset, int length)
mailId
- メールIDoption
- 表示オプションoffset
- 取得開始位置length
- 取得件数@JSFunction public List<UnreadListItem> listUnreads(UnreadListOption option, int offset, int length)
option
- ソートオプションoffset
- 取得開始位置length
- 取得件数@JSFunction public void markAsRead(MessageIdentifier... mailIds)
mailIds
- 既読にするメールのIDすべてのフォルダにわたって既読にしたい場合
,
未読にしたい場合
,
すべてのフォルダにわたって未読にしたい場合
public void markAsReadAtAllFolders(String... mailIds)
mailIds
- メールIDの配列既読にしたい場合
,
未読にしたい場合
,
すべてのフォルダにわたって未読にしたい場合
public void markAsUnread(MessageIdentifier... mailIds)
mailIds
- 未読にするメールのID既読にしたい場合
,
すべてのフォルダにわたって既読にしたい場合
,
すべてのフォルダにわたって未読にしたい場合
public void markAsUnreadAtAllFolders(String... mailIds)
mailIds
- メールIDの配列既読にしたい場合
,
すべてのフォルダにわたって既読にしたい場合
,
未読にしたい場合
@JSFunction public void moveTo(String to, MessageIdentifier... mailIds) throws GroupMailException
to
- 移動先のフォルダコードmailIds
- メールID,メールサブIDの配列GroupMailException
- 移動先のフォルダが存在しない場合@JSFunction public Message prepareNew()
public Message prepareToCopy(String mailId)
mailId
- メールIDpublic Message prepareToEdit(String mailId)
mailId
- メールID@JSFunction public Message prepareToForward(String mailId)
MessageReference.FORWARD
として設定されます。送信や保存の際に転送マークをつける場合にはこの情報が必要になります。mailId
- メールID@JSFunction public Message prepareToReply(String mailId)
send(jp.co.ucm.im.groupmail.api.models.Message)
で送信すると返信用に処理されますMessageReference.REPLY
として設定されます。送信や保存の際に返信マークをつける場合にははこの情報が必要になります。mailId
- メールID@JSFunction public Message prepareToReplyAll(String mailId)
send(jp.co.ucm.im.groupmail.api.models.Message)
で送信すると返信用に処理されますMessageReference.REPLY
として設定されます。送信や保存の際に返信マークをつける場合にははこの情報が必要になります。mailId
- メールIDpublic void pullBack(String mailId) throws GroupMailException
mailId
- メールIDGroupMailException
- 取り消しに失敗した場合@JSFunction public void remove(MessageIdentifier... mailIds)
mailIds
- メールID、メールサブIDの配列@JSFunction public void removeFromFolder(String folderCd, MessageIdentifier... mailIds)
folderCd
- フォルダコードmailIds
- メールID、メールサブIDの配列@JSFunction public String save(Message message) throws GroupMailException
message
の送信者コード、送信者名、送信日時はコンテキストや実際の処理時間により上書きします。message
- メッセージGroupMailException
- 保存に失敗した場合@JSFunction public List<MessageListItem> search(String folderCd, String keyword, MessageSearchOptions options, int offset, int length) throws GroupMailException
folderCd
- フォルダコードkeyword
- 検索キーワード。指定しない場合nulloptions
- 検索オプションoffset
- 取得開始位置length
- 取得件数GroupMailException
- 対象のフォルダが参照できない場合@JSFunction public String send(Message message) throws GroupMailException
message
の送信者コード、送信者名、送信日時はコンテキストや実際の処理時間により上書きします。message
- 送信するメッセージGroupMailException
- 送信処理に問題が発生した場合Copyright © 2022 UCM Co., Ltd.. All rights reserved.