io.github.nucleuspowered.nucleus.api.module.mail

Interface NucleusMailService

public interface NucleusMailService

A service that handles sending and retrieving mail.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusMailService.MailFilter This NucleusMailService.MailFilter is simply to prevent compiler warnings with varargs, and is functionally the same as a Predicate

Method Summary

Modifier and Type	Method and Description
boolean	clearUserMail(org.spongepowered.api.entity.living.player.User player) Clears the player's mail.
default NucleusMailService.MailFilter	createDateFilter(java.time.Instant after, java.time.Instant before) Create a filter that restricts the mail to a certain time period.
default NucleusMailService.MailFilter	createMessageFilter(boolean caseSensitive, java.util.Collection<java.lang.String> message) Create a filter that restricts the messages returned to the provided substring.
default NucleusMailService.MailFilter	createMessageFilter(boolean caseSensitive, java.lang.String... message) Create a filter that restricts the messages returned to the provided substring.
default NucleusMailService.MailFilter	createSenderFilter(boolean includeConsole, java.util.Collection<java.util.UUID> player) Create a filter that restricts the mail to the senders provided.
default NucleusMailService.MailFilter	createSenderFilter(boolean includeConsole, java.util.UUID... player) Create a filter that restricts the mail to the senders provided.
java.util.List<MailMessage>	getMail(org.spongepowered.api.entity.living.player.User player, NucleusMailService.MailFilter... filters) Gets mail for a specific player, optionally including a list of filters.
boolean	removeMail(org.spongepowered.api.entity.living.player.User player, MailMessage mailData) Removes a specific mail for a specific player.
void	sendMail(org.spongepowered.api.entity.living.player.User playerFrom, org.spongepowered.api.entity.living.player.User playerTo, java.lang.String message) Sends mail to a subject, addressed from another subject.
void	sendMailFromConsole(org.spongepowered.api.entity.living.player.User playerTo, java.lang.String message) Sends mail to a player, addressed from the console.

Method Detail

getMail

java.util.List<MailMessage> getMail(org.spongepowered.api.entity.living.player.User player,
                                    NucleusMailService.MailFilter... filters)

Gets mail for a specific player, optionally including a list of filters.

Parameters:

player - The User of the player to get the mail of.

filters - The NucleusMailService.MailFilters

Returns:

A list of mail.

removeMail

boolean removeMail(org.spongepowered.api.entity.living.player.User player,
                   MailMessage mailData)

Removes a specific mail for a specific player.

Parameters:

player - The User to remove the mail from.

mailData - The MailMessage to remove from the player.

Returns:

true if the mail was removed, false if the player didn't have the mail.

sendMail

void sendMail(org.spongepowered.api.entity.living.player.User playerFrom,
              org.spongepowered.api.entity.living.player.User playerTo,
              java.lang.String message)

Sends mail to a subject, addressed from another subject.

Parameters:

playerFrom - The User of the player to send the message from.

playerTo - The User of the player to send the message to.

message - The message.

sendMailFromConsole

void sendMailFromConsole(org.spongepowered.api.entity.living.player.User playerTo,
                         java.lang.String message)

Sends mail to a player, addressed from the console.

Parameters:

playerTo - The User of the player to send the message to.

message - The message.

clearUserMail

boolean clearUserMail(org.spongepowered.api.entity.living.player.User player)

Clears the player's mail.

Parameters:

player - The UUID of the player.

Returns:

If there was any mail cleared

createSenderFilter

default NucleusMailService.MailFilter createSenderFilter(boolean includeConsole,
                                                         java.util.UUID... player)

Create a filter that restricts the mail to the senders provided.

Multiple player filters can be provided - this will return messages authored by all specified players.

Parameters:

includeConsole - If true, include the console/plugins in any returned mail.

player - The UUIDs of the players.

Returns:

The NucleusMailService.MailFilter

createSenderFilter

default NucleusMailService.MailFilter createSenderFilter(boolean includeConsole,
                                                         java.util.Collection<java.util.UUID> player)

Create a filter that restricts the mail to the senders provided.

Multiple player filters can be provided - this will return messages authored by all specified players.

Parameters:

includeConsole - If true, include the console/plugins in any returned mail.

player - The UUIDs of the players.

Returns:

The NucleusMailService.MailFilter

createDateFilter

default NucleusMailService.MailFilter createDateFilter(@Nullable
                                                       java.time.Instant after,
                                                       @Nullable
                                                       java.time.Instant before)

Create a filter that restricts the mail to a certain time period. One parameter may be null, but not both. The times on the instants will be ignored.

Only one of these filters can be used at a time.

Parameters:

after - The Instant which indicates the earliest date to return.

before - The Instant which indicates the latest date to return.

Returns:

The NucleusMailService.MailFilter

createMessageFilter

default NucleusMailService.MailFilter createMessageFilter(boolean caseSensitive,
                                                          java.lang.String... message)

Create a filter that restricts the messages returned to the provided substring.

If multiple strings are set, all need to match.

Parameters:

caseSensitive - Whether this filter is case sensitive.

message - The message.

Returns:

The NucleusMailService.MailFilter

createMessageFilter

default NucleusMailService.MailFilter createMessageFilter(boolean caseSensitive,
                                                          java.util.Collection<java.lang.String> message)

Create a filter that restricts the messages returned to the provided substring.

If multiple strings are set, all need to match.

Parameters:

caseSensitive - Whether this filter is case sensitive.

message - The message.

Returns:

The NucleusMailService.MailFilter