UOperatingSystemMailManager Class Reference

Handles the management of operating system emails. More...

#include "OperatingSystemMailManager.h"

Inheritance diagram for UOperatingSystemMailManager:

Collaboration diagram for UOperatingSystemMailManager:

Protected Member Functions
void	K2_OnEmailRegistered (const FOperatingSystemEmail &EmailAccount)
	Event handler that is called when an email account is registered.
void	K2_OnEmailSent (const FOperatingSystemUser &FromUser, const FOperatingSystemUser &ToUser, const FOperatingSystemMailSetting &MailData)
	Event handler for when an email is sent.
void	K2_OnEmailFailedToDeliver (const FOperatingSystemUser &FromUser, const FOperatingSystemUser &ToUser, const FOperatingSystemMailSetting &MailData)
	Notifies when an email fails to deliver.

Static Protected Member Functions
static OPERATINGSYSTEMSIMULATOR_API void	Save ()

Detailed Description

Handles the management of operating system emails.

It provides functionality to create and register new mail accounts, send emails between users, and perform various operations on emails such as deleting, archiving, marking as read

Member Function Documentation

K2_OnEmailFailedToDeliver()

void UOperatingSystemMailManager::K2_OnEmailFailedToDeliver ( const FOperatingSystemUser & FromUser, const FOperatingSystemUser & ToUser, const FOperatingSystemMailSetting & MailData )

protected

Notifies when an email fails to deliver.

This method is an event that is triggered when an email fails to deliver. It provides information about the sender, recipient, and the email settings.

Parameters

FromUser	The user who sent the email.
ToUser	The user who was supposed to receive the email.
MailData	The email data that failed to deliver.

K2_OnEmailRegistered()

void UOperatingSystemMailManager::K2_OnEmailRegistered ( const FOperatingSystemEmail & EmailAccount )

protected

Event handler that is called when an email account is registered.

Parameters

EmailAccount

The email account that was registered. EmailAccount.Username: The username of the email account. EmailAccount.Password: The password of the email account.

Note

This method is a BlueprintImplementableEvent, which means that it can be implemented in Blueprints to provide custom functionality. When implementing this method in Blueprints, make sure to handle the email account registration logic accordingly.

See also

FOperatingSystemEmail

K2_OnEmailSent()

void UOperatingSystemMailManager::K2_OnEmailSent ( const FOperatingSystemUser & FromUser, const FOperatingSystemUser & ToUser, const FOperatingSystemMailSetting & MailData )

protected

Event handler for when an email is sent.

This event is triggered when an email is sent from one user to another.

Parameters

FromUser	The user who sent the email.
ToUser	The user who received the email.
MailData	The data of the email that was sent.

Save()

void UOperatingSystemMailManager::Save ( )

staticprotected

Saves the mail singleton to a save slot. This function retrieves the plugin settings and obtains the mail save slot name. It then saves the mail singleton to the specified save slot using the SaveGameToSlot() function provided by UGameplayStatics. After successful saving, a log message is written indicating that the mail singleton has been saved.

Usage Example:

UOperatingSystemMailManager::Save();

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• Source/OperatingSystemSimulator/Public/Data/OperatingSystemMailManager.h
• Source/OperatingSystemSimulator/Private/Data/OperatingSystemMailManager.cpp