cz.ues.postman.mail

Interface UESMail

@UESService
public interface UESMail

Since:

PST6-06

Method Summary

Methods

Modifier and Type	Method and Description
void	createArtifactFromEmail(UESURI competentRoleUri, UESMailCreateArtifactFromEmail artifactMail) Creates a new artifact from an email.
UESResultList<UESMailRoleAttributes,UESMailGetEmailCapableRoleList>	getEmailCapableRoleList(UESURI territoryUri, UESMailGetEmailCapableRoleList criteria) This command returns a list of all roles capable of creating a new artifact from an email.

Method Detail

createArtifactFromEmail

@UESCommand(stereotype=UNKNOWN)

void createArtifactFromEmail(UESURI competentRoleUri,
UESMailCreateArtifactFromEmail artifactMail)
throws UESMailRTException

Creates a new artifact from an email. The command downloads the email from the mailbox of authenticated user's personal role (by IMAP or POP3 protocol) and then converts it to a new artifact in the system. The mailbox is configured in the system, there is exactly one for a personal role currently. The new artifact representing the email is created in the workspace of specified competent role.

Parameters:

competentRoleUri - Competent role URI. A new artifact representing email is created in the workspace of this role. An access role of the authenticated user has to be casted to the competentRoleUri.

artifactMail - DTO containing email identification in the personal role mail box and attributes of a new artifact representing the email.

Throws:

UESMailRTException

Since:

PST6-06

getEmailCapableRoleList

@UESCommand(stereotype=READ)

UESResultList<UESMailRoleAttributes,UESMailGetEmailCapableRoleList> getEmailCapableRoleList(UESURI territoryUri,
UESMailGetEmailCapableRoleList criteria)
throws UESMailRTException

This command returns a list of all roles capable of creating a new artifact from an email. All the roles are roles of an authenticated user in the given territory. The command does not return all roles, only a sublist. The list of returned roles can be filtered by the name and code of a role and by the flag indicating the preferred role. The list is sorted by names (and codes in case two names are the same) by default, or it can be sorted arbitrarily.

Parameters:

territoryUri - UESURI of the territory from where authenticated user roles are listed.

criteria - DTO containing criteria for listing roles. Available parameters are: name, code and preferred.

Returns:

List of DTOs representing roles.

Throws:

UESMailRTException

Since:

PST6-06

See Also:

UESQuery Documentation.