Package com.avoka.tm.svc
Class UserEmailer
- java.lang.Object
-
- com.avoka.tm.svc.UserEmailer
-
public class UserEmailer extends Object
Provides a User Email service.
Examples
Please find the user email service examples about sending below.
Send Email
This example shows how to send an email message for lost password. Note the underling implementation generates new random password.
import com.avoka.tm.svc.UserEmailer new UserEmailer() .setLoginName("john.doe") .setSpaceName("maguire") .setType(UserEmailer.EmailType.LOST_PASSWORD) .sendEmail()
This example shows how to send an email message for new user verification.
import com.avoka.tm.svc.UserEmailer new UserEmailer() .setLoginName("john.doe") .setSpaceName("maguire") .setType(UserEmailer.EmailType.VERIFICATION) .sendEmail()
This example shows how to send an email message for welcome. Note the underling implementation generates new random password.
import com.avoka.tm.svc.UserEmailer new UserEmailer() .setLoginName("john.doe") .setSpaceName("maguire") .setType(UserEmailer.EmailType.WELCOME) .sendEmail()
- Since:
- 19.11.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UserEmailer.EmailType
-
Constructor Summary
Constructors Constructor Description UserEmailer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
sendEmail()
Send email.UserEmailer
setLoginName(String loginName)
Set the user login name emailer parameter.UserEmailer
setSpaceName(String spaceName)
Set the space name emailer parameter.UserEmailer
setType(UserEmailer.EmailType type)
Set the email type emailer parameter.
-
-
-
Method Detail
-
setLoginName
public UserEmailer setLoginName(String loginName)
Set the user login name emailer parameter.- Parameters:
loginName
- the user login name emailer parameter (required)- Returns:
- the user email service
-
setSpaceName
public UserEmailer setSpaceName(String spaceName)
Set the space name emailer parameter.- Parameters:
spaceName
- the space name emailer parameter (required)- Returns:
- the user email service
-
setType
public UserEmailer setType(UserEmailer.EmailType type)
Set the email type emailer parameter.- Parameters:
type
- the email type emailer parameter (required)- Returns:
- the user email service
-
sendEmail
public void sendEmail()
Send email.
-
-