Interface IMailHandler
-
- All Superinterfaces:
IAPIHandler
,Serializable
- All Known Implementing Classes:
MailHandler
public interface IMailHandler extends IAPIHandler
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
sendClientMail(Mandant client, IBaseMailData mailData)
Sends an email as the given clientboolean
sendFeedbackMail(UserContext uc, Mandant client, IFeedbackMailData feedbackMailData)
Send a feedback mail from the given client.boolean
sendInviteMail(UserContext uc, Vorgang vorgang, String mailTo, DefaultReplacerParameters params)
boolean
sendLoginChanged(UserContext uc, Benutzer benuter, String passwort)
Send login changed.boolean
sendOptInMail(UserContext uc, Vorgang vorgang)
Send a feedback mail from the given client.boolean
sendResetPasswordMail(UserContext uc, Benutzer user, String url)
Sends an email to theBenutzer
for resetting their passwordboolean
sendSupportMail(UserContext uc, Mandant client, ISupportInquiryData supportInquiryData)
Send a support mail from the given client.-
Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler
getName
-
-
-
-
Method Detail
-
sendLoginChanged
boolean sendLoginChanged(UserContext uc, Benutzer benuter, String passwort)
Send login changed.- Parameters:
benuter
- the benuterpasswort
- the passwort- Returns:
- true, if successful
-
sendResetPasswordMail
boolean sendResetPasswordMail(UserContext uc, Benutzer user, String url)
Sends an email to theBenutzer
for resetting their password- Parameters:
uc
-UserContext
in which the operation should be performeduser
-Benutzer
which should receive the emailurl
-String
url for resetting the password- Returns:
Boolean
whether the operation was successful or not
-
sendClientMail
boolean sendClientMail(Mandant client, IBaseMailData mailData)
Sends an email as the given client- Parameters:
client
-Mandant
sending the emailmailData
-IBaseMailData
content of the mail- Returns:
Boolean
whether or not the email could be sent successfully- Since:
- 6.0.0
-
sendSupportMail
boolean sendSupportMail(UserContext uc, Mandant client, ISupportInquiryData supportInquiryData)
Send a support mail from the given client. If no client is given tries using the system mail settings- Parameters:
uc
-UserContext
the user context in which the action is to be performed.client
-Mandant
for which to send the mailsupportInquiryData
-SupportInquiryData
containing support inquiry information- Returns:
- Whether or not the email was sent successfully
- Since:
- 6.0.0
-
sendFeedbackMail
boolean sendFeedbackMail(UserContext uc, Mandant client, IFeedbackMailData feedbackMailData)
Send a feedback mail from the given client. If no client is given, attempt to use the system mail settings.- Parameters:
uc
-UserContext
the user context in which the action is to be performed.client
-Mandant
for which to send the mailfeedbackMailData
-IFeedbackMailData
containing feedback information- Returns:
- Whether or not the email was sent successfully
- Since:
- 6.0.0
-
sendOptInMail
boolean sendOptInMail(UserContext uc, Vorgang vorgang)
Send a feedback mail from the given client. If no client is given, attempt to use the system mail settings.- Parameters:
uc
-UserContext
the user context in which the action is to be performed.vorgang
-Vorgang
for which to send the mail- Returns:
- Whether or not the email was sent successfully
- Since:
- 6.0.0
-
sendInviteMail
boolean sendInviteMail(UserContext uc, Vorgang vorgang, String mailTo, DefaultReplacerParameters params)
-
-