de.xima.fc.api.system

Class MailAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.system.MailAPI

public class MailAPI
extends ASubAPI

API class for sending of system mails.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor and Description
MailAPI()

Method Summary

Modifier and Type	Method and Description
boolean	sendClientMail(Mandant client, IBaseMailData mailData) Sends an email as the given client
boolean	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	sendLoginChangedMail(UserContext uc, Benutzer user, String password) Method for sending a mail with changed login data.
boolean	sendOptInMail(UserContext uc, Vorgang vorgang) Sends an email as the given client
boolean	sendResetPasswordMail(UserContext uc, Benutzer user, String url) Sends an email to the Benutzer for resetting their password.
boolean	sendSupportMail(UserContext uc, Mandant client, ISupportInquiryData supportInquiryData) Send a support mail from the given client.

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailAPI

public MailAPI()

Method Detail

sendLoginChangedMail

public boolean sendLoginChangedMail(UserContext uc,
                                    Benutzer user,
                                    String password)

Method for sending a mail with changed login data.

Parameters:

uc - UserContext the user context in which the action is to be performed.

user - Benutzer to which the mail should be sent.

password - String the new password of Benutzers.

Returns:

Boolean whether the action was successful or not.

Since:

2.4.3

sendResetPasswordMail

public boolean sendResetPasswordMail(UserContext uc,
                                     Benutzer user,
                                     String url)

Sends an email to the Benutzer for resetting their password.

Parameters:

uc - UserContext in which the operation should be performed.

user - Benutzer which should receive the email.

url - String URL for resetting the password.

Returns:

Boolean whether the operation was successful or not.

sendClientMail

public boolean sendClientMail(Mandant client,
                              IBaseMailData mailData)

Sends an email as the given client

Parameters:

client - Mandant sending the email

mailData - IBaseMailData content of the mail

Returns:

Boolean whether or not the email could be sent successfully

Since:

6.0.0

sendOptInMail

public boolean sendOptInMail(UserContext uc,
                             Vorgang vorgang)

Sends an email as the given client

Parameters:

uc - UserContext the user context in which the action is to be performed.

vorgang - Vorgang sending the email

Returns:

Boolean whether or not the email could be sent successfully

Since:

6.0.0

sendSupportMail

public 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 mail

supportInquiryData - SupportInquiryData containing support inquiry information

Returns:

Whether or not the email was sent successfully

Since:

6.0.0

sendFeedbackMail

public boolean sendFeedbackMail(UserContext uc,
                                Mandant client,
                                IFeedbackMailData feedbackMailData)

Send a feedback mail from the given client. If no client is 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 mail

feedbackMailData - SupportInquiryData containing feedback information

Returns:

Whether or not the email was sent successfully

Since:

6.0.0

sendInviteMail

public boolean sendInviteMail(UserContext uc,
                              Vorgang vorgang,
                              String mailTo,
                              DefaultReplacerParameters params)