public interface EmailManager
Modifier and Type | Field and Description |
---|---|
static int |
ADMIN_NOTIFICATION_TYPE |
static int |
APPROVAL_WORKFLOW_TYPE |
static int |
AUTHENTICATION_TYPE |
static int |
BUTTON_APPROVE |
static int |
BUTTON_OPEN |
static int |
BUTTON_REJECT |
static int |
DEFAULT_TYPE |
static int |
JOB_SERVER_TYPE |
static int |
SINGLE_USER_PROCESS_TYPE |
static int |
TE_EMPL_TYPE |
static int |
TE_OTHER_TYPE |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDomainName() |
int |
getMsgType()
Returns previously set Message Type.
|
boolean |
isEmailConfigured() |
boolean |
isIMConfigured() |
java.util.Map<java.lang.String,java.lang.String[]> |
sendByteArrayAttachment(java.lang.String fromUserId,
java.lang.String toUserIds,
java.lang.String ccUserIds,
java.lang.String subject,
java.lang.String messageTxt,
java.lang.String fileName,
byte[] data)
Sends mail with attachment to costpoint users.
|
java.util.Map<java.lang.String,java.lang.String[]> |
sendFileAttachmentToUser(java.lang.String fromUserId,
java.lang.String toUserIds,
java.lang.String ccUserIds,
java.lang.String subject,
java.lang.String messageTxt,
java.lang.String fileName)
Sends mail with attachment.
|
java.util.Map<java.lang.String,java.lang.String[]> |
sendMail(java.lang.String fromUserId,
java.lang.String toUserIds,
java.lang.String ccUserIds,
java.lang.String subject,
java.lang.String messageTxt)
Sends email message to costpoint user.
|
java.util.Map<java.lang.String,java.lang.String[]> |
sendMail(java.lang.String fromUserId,
java.lang.String toUserIds,
java.lang.String ccUserIds,
java.lang.String subject,
java.lang.String messageTxt,
java.lang.String plainMessageTxt)
Sends notification message to costpoint user.
|
java.util.Map<java.lang.String,java.lang.String[]> |
sendMailWithBcc(java.lang.String fromUserId,
java.lang.String toUserIds,
java.lang.String ccUserIds,
java.lang.String bccUserIds,
java.lang.String subject,
java.lang.String messageTxt,
java.lang.String plainMessageTxt)
Sends notification message to costpoint user.
|
java.util.Map<java.lang.String,java.lang.String[]> |
sendMultipleAttachments(java.lang.String fromUserId,
java.lang.String toUserIds,
java.lang.String ccUserIds,
java.lang.String subject,
java.lang.String messageTxt,
java.util.LinkedHashMap files)
Sends mail with multiple file attachments to costpoint users.
|
void |
setIsTxOn(boolean isTx)
For native notifications we need to do cleanup and delete bad device registrations
So depending if we are inside transaction or not we may not do commit sometimes.
|
void |
setMessageActions(int actnType1,
java.lang.String url1,
int actnType2,
java.lang.String url2)
When sending messages - there is an option to add buttons and corresponding links to message that
will be shown as separate buttons in native notifications.
|
void |
setMsgType(int msgType)
Use this method to set message type before sending message.
|
static final int DEFAULT_TYPE
static final int ADMIN_NOTIFICATION_TYPE
static final int APPROVAL_WORKFLOW_TYPE
static final int JOB_SERVER_TYPE
static final int SINGLE_USER_PROCESS_TYPE
static final int TE_EMPL_TYPE
static final int TE_OTHER_TYPE
static final int AUTHENTICATION_TYPE
static final int BUTTON_OPEN
static final int BUTTON_APPROVE
static final int BUTTON_REJECT
java.util.Map<java.lang.String,java.lang.String[]> sendMailWithBcc(java.lang.String fromUserId, java.lang.String toUserIds, java.lang.String ccUserIds, java.lang.String bccUserIds, java.lang.String subject, java.lang.String messageTxt, java.lang.String plainMessageTxt) throws DEException
fromUserId
- The valid format is 'Jdoe' or 'jdoe@yahoo.com'. If 'fromUserId' is
blank or null, then 'CostpointSystem' will be the 'From' field value that
will be seen by the user who receive this emailtoUserIds
- 1. It can be a valid 'costpoint user id' The email id will be taken
from database
OR
2. It can be a valid internet email in the format 'jdoe@deltek.com'
OR
3. It can be comma or semicolon separated valid costpoint user ids
e.g userid1, userid2, userid3...
OR
4. It can be comma or semicolon separated valid internet email addresses
in the format jdoe11@deltek.com,jdoe22@deltek.com ....
OR
5. It can be mixture of comma or semicolon separated valid internet email
addresses and costpoint user idsccUserIds
- Users to whom this email is to be 'cc'ed. The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blankbccUserIds
- Users to whom this email is to be 'bcc'ed (blind carbon copied). The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blanksubject
- The subject heading of the messagemessageTxt
- The message body of the message. This parameter could contain links, html, etc.. that is fully
supported by email or implainMessageTxt
- The message body of the mail in plain text. This parameter should contain only plain text
and no links as some notifications methods (like native push msgs) do NOT support html.DEException
- If there is any database or email system errorjava.util.Map<java.lang.String,java.lang.String[]> sendMail(java.lang.String fromUserId, java.lang.String toUserIds, java.lang.String ccUserIds, java.lang.String subject, java.lang.String messageTxt, java.lang.String plainMessageTxt) throws DEException
fromUserId
- The valid format is 'Jdoe' or 'jdoe@yahoo.com'. If 'fromUserId' is
blank or null, then 'CostpointSystem' will be the 'From' field value that
will be seen by the user who receive this emailtoUserIds
- 1. It can be a valid 'costpoint user id' The email id will be taken
from database
OR
2. It can be a valid internet email in the format 'jdoe@deltek.com'
OR
3. It can be comma or semicolon separated valid costpoint user ids
e.g userid1, userid2, userid3...
OR
4. It can be comma or semicolon separated valid internet email addresses
in the format jdoe11@deltek.com,jdoe22@deltek.com ....
OR
5. It can be mixture of comma or semicolon separated valid internet email
addresses and costpoint user idsccUserIds
- Users to whom this email is to be 'cc'ed. The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blanksubject
- The subject heading of the messagemessageTxt
- The message body of the message. This parameter could contain links, html, etc.. that is fully
supported by email or implainMessageTxt
- The message body of the mail in plain text. This parameter should contain only plain text
and no links as some notifications methods (like native push msgs) do NOT support html.DEException
- If there is any database or email system errorjava.util.Map<java.lang.String,java.lang.String[]> sendMail(java.lang.String fromUserId, java.lang.String toUserIds, java.lang.String ccUserIds, java.lang.String subject, java.lang.String messageTxt) throws DEException
fromUserId
- The valid format is 'Jdoe' or 'jdoe@yahoo.com'. If 'fromUserId' is
blank or null, then 'CostpointSystem' will be the 'From' field value that
will be seen by the user who receive this emailtoUserIds
- 1. It can be a valid 'costpoint user id' The email id will be taken
from database
OR
2. It can be a valid internet email in the format 'jdoe@deltek.com'
OR
3. It can be comma or semicolon separated valid costpoint user ids
e.g userid1, userid2, userid3...
OR
4. It can be comma or semicolon separated valid internet email addresses
in the format jdoe11@deltek.com,jdoe22@deltek.com ....
OR
5. It can be mixture of comma or semicolon separated valid internet email
addresses and costpoint user idsccUserIds
- Users to whom this email is to be 'cc'ed. The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blanksubject
- The subject heading of the messagemessageTxt
- The message body of the message. Should be plain text, not html and no links.DEException
- If there is any database or email system errorjava.util.Map<java.lang.String,java.lang.String[]> sendByteArrayAttachment(java.lang.String fromUserId, java.lang.String toUserIds, java.lang.String ccUserIds, java.lang.String subject, java.lang.String messageTxt, java.lang.String fileName, byte[] data) throws DEException
fromUserId
- The valid format is 'Jdoe' or 'jdoe@yahoo.com'. If 'fromUserId' is
blank or null, then 'CostpointSystem' will be the 'From' field value that
will be seen by the user who receive this emailtoUserIds
- 1. It can be a valid 'costpoint user id' The email id will be taken
from database
OR
2. It can be a valid internet email in the format 'jdoe@deltek.com'
OR
3. It can be comma or semicolon separated valid costpoint user ids
e.g userid1, userid2, userid3...
OR
4. It can be comma or semicolon separated valid internet email addresses
in the format jdoe11@deltek.com,jdoe22@deltek.com ....
OR
5. It can be mixture of comma or semicolon separated valid internet email
addresses and costpoint user idsccUserIds
- Users to whom this email is to be 'cc'ed. The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blanksubject
- The subject heading of the messagemessageTxt
- The message body of the mailfileName
- The file name to be used for the attachment name. This need not be
a physical file on the sender's machine. But the name should have
proper suffix like .pdf, .doc, .xls etcdata
- The byte array data that is to be sent as an attachmentDEException
java.util.Map<java.lang.String,java.lang.String[]> sendMultipleAttachments(java.lang.String fromUserId, java.lang.String toUserIds, java.lang.String ccUserIds, java.lang.String subject, java.lang.String messageTxt, java.util.LinkedHashMap files) throws DEException
fromUserId
- The valid format is 'Jdoe' or 'jdoe@yahoo.com'. If 'fromUserId' is
blank or null, then 'CostpointSystem' will be the 'From' field value that
will be seen by the user who receive this emailtoUserIds
- 1. It can be a valid 'costpoint user id' The email id will be taken
from database
OR
2. It can be a valid internet email in the format 'jdoe@deltek.com'
OR
3. It can be comma or semicolon separated valid costpoint user ids
e.g userid1, userid2, userid3...
OR
4. It can be comma or semicolon separated valid internet email addresses
in the format jdoe11@deltek.com,jdoe22@deltek.com ....
OR
5. It can be mixture of comma or semicolon separated valid internet email
addresses and costpoint user idsccUserIds
- Users to whom this email is to be 'cc'ed. The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blanksubject
- The subject heading of the messagemessageTxt
- The message body of the mailfiles
- LinkedHashMap where each entry key - value pair is described like this:
Key - filename, Value data as byte[]
The file name to be used for the attachment name. This need not be
a physical file on the sender's machine. But the name should have
proper suffix like .pdf, .doc, .xls etc
Each byte array data that is to be sent as an attachment.DEException
java.util.Map<java.lang.String,java.lang.String[]> sendFileAttachmentToUser(java.lang.String fromUserId, java.lang.String toUserIds, java.lang.String ccUserIds, java.lang.String subject, java.lang.String messageTxt, java.lang.String fileName) throws DEException
fromUserId
- The valid format is 'Jdoe' or 'jdoe@yahoo.com'. If 'fromUserId' is
blank or null, then 'CostpointSystem' will be the 'From' field value that
will be seen by the user who receive this emailtoUserIds
- 1. It can be a valid 'costpoint user id' The email id will be taken
from database
OR
2. It can be a valid internet email in the format 'jdoe@deltek.com'
OR
3. It can be comma or semicolon separated valid costpoint user ids
e.g userid1, userid2, userid3...
OR
4. It can be comma or semicolon separated valid internet email addresses
in the format jdoe11@deltek.com,jdoe22@deltek.com ....
OR
5. It can be mixture of comma or semicolon separated valid internet email
addresses and costpoint user idsccUserIds
- Users to whom this email is to be 'cc'ed. The accepted values
are the same as in 'toUserIds'. This parameter can be set as null or blanksubject
- The subject heading of the messagemessageTxt
- The message body of the mailfileName
- The absolute file name which needs to sent as an attachmentDEException
java.lang.String getDomainName()
boolean isEmailConfigured()
boolean isIMConfigured()
void setIsTxOn(boolean isTx)
isTx
- void setMsgType(int msgType)
msgType
- int getMsgType()
void setMessageActions(int actnType1, java.lang.String url1, int actnType2, java.lang.String url2)
actnType1
- url1
- actnType2
- url2
-