AlertAPI
AlertAPI
API that allows you to send email and text message alerts to players!
Latest version: 1.1 - File waiting approval
Your Information Is Safe
Passwords, email addresses and phone numbers are secured via encryption. AlertAPI stores all registered players in an address book and allows for other plugins to send messages if the player is in the address book. Information in the address book is blocked from other plugins, they are only allowed to check if a player is in the address book.
If you are a developer that wants to use AlertAPI for your plugin go to the Developer Portal.
Requirement
- Email address that uses an SMTP server for outgoing emails.
- Example: Gmail, Road Runner, Yahoo, Hotmail
- Suggested: create new email address: [email protected]
NOTE: Only the outgoing email address has to use SMTP for outgoing emails. Players on the server can register with ANY email address.
Commands
- /register <carrier> <phone> - Registers your phone number.
- /register [email] <address> - Registers your email address.
- /unregister - Removes your registration and alerts.
- /alert <player> <message> - Send alert message to this player.
- /alert [all] <message> - Send alert message to all players.
- /carriers - List supported carriers.
- /alertpref [email] - Set email messages as your preferred method.
- /alertpref [sms] - Set text messages as your preferred method.
- /terms - View the terms of AlertAPI.
- /terms [accept] - Accept the terms of AlertAPI.
- /terms [decline] - Decline the terms of AlertAPI and cancel registration.
- /ignore [list] - List players in ignore list.
- /ignore <player> - Add player to ignore list.
- /ignore [del] <player> - Remove player from ignore list.
Permissions
- alertapi.* - Gives player access to all AlertAPI commands and functions.
- alertapi.receive - Allows player to sign up and receive SMS and Email alerts.
- alertapi.send - Allows player to send messages to one player from in game.
- alertapi.send.all - Allows player to send message to all players from in game.
Configuration
config.yml
- outgoing-email-account:
- email: [email protected] The outgoing server email address (all alerts will be sent from this email)
- username: server-email-username The outgoing server email address username (sometimes same as email address)
- password: server-email-password The outgoing server email address password (will be encrypted after first startup)
- password-encrypted: Leave blank, this will be filled in automatically after first startup
- host: smtp.domain.com SMTP outoing email server address
- port: 465 SMTP outgoing port (usually 465 or 25)
- ssl: true Does this ougoing SMTP port use ssl security? (usually port 465 does)
- general:
- allow-email: true allow email message sending
- allow-sms: true allow text message sending
- messages:
- email-display-name: Minecraft Server This is what will show up in the From field of email alerts
- default-email-subject: You have a new alert from your minecraft server! outoing email subject
- default-sms-subject: MC Alert! outgoing text message subject
- message-online-players: false Can online players recieve alert messages
Popular SMTP Gateways:
- Gmail
- host: smtp.gmail.com
- port: 465 or 25
- Yahoo
- host: smtp.mail.yahoo.com
- port: 465
- Hotmail
- host: smtp.live.com
- port: 465 or 25
Supported Carriers
For a full listing of supported carriers, click here.
Plugins Using AlertAPI
- FriendsOnline - Alert players when their friends join
Get your plugin on the list by submitting a ticket.
TERMS OF USE
By downloading this plugin, or using this plugins features, you agree to the following terms; Standard data fees and text messaging rates may apply based on your plan with your mobile phone carrier. The developer of this plugin, or any plugin using AlertAPI may not be held accountable for:
- Charges which may occur when receiving text messages.
- Phone numbers or email addresses becoming public. (Although this is highly unlikely)
- These terms maybe updated at anytime, without notice.
FAQ
Q. How can I update the outgoing email account password? A. Delete the information in password-encrypted in your config.yml and enter your new password in the password field.
Q. Is my data safe? A. Yes. All of your information is encrypted and protected. Any plugin that uses AlertAPI does not have access to your information.
Q. What if I do not have a text messaging plan, or I have limited texts? A. You can register your email address! Just use command: /register email [email protected]
Future Releases
- Add more supported carriers
- Add support for other outgoing email protocols - IMAP and POP3
Metrics
Alert API uses Metrics only to keep track of the number of installs and Bukkit versions. All information collected is anonymous, and no user information is, or ever will be collected.
Opting out of this service can be done by editing plugins/Plugin Metrics/config.yml and changing opt-out to true.
Credits
Author: silvermmonkey A.K.A. mmonkey
Logo: Jensui
Having Issues?
Submit a ticket.
get this error whenever I try and alert a player
29.09 22:36:37 [Server] INFO ... 3 more 29.09 22:36:37 [Server] INFO at org.bukkit.craftbukkit.v1_8_R3.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:53) 29.09 22:36:37 [Server] INFO at org.bukkit.craftbukkit.v1_8_R3.scheduler.CraftTask.run(CraftTask.java:53) 29.09 22:36:37 [Server] INFO at com.gmail.mmonkey.AlertAPI.MessageSender$2.run(MessageSender.java:231) 29.09 22:36:37 [Server] INFO at javax.mail.internet.InternetAddress.<init>(InternetAddress.java:111) 29.09 22:36:37 [Server] INFO at javax.mail.internet.InternetAddress.parse(InternetAddress.java:633) 29.09 22:36:37 [Server] INFO at javax.mail.internet.InternetAddress.parse(InternetAddress.java:673) 29.09 22:36:37 [Server] INFO Caused by: java.lang.NullPointerException 29.09 22:36:37 [Server] INFO at java.lang.Thread.run(Unknown Source) 29.09 22:36:37 [Server] INFO at java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source) 29.09 22:36:37 [Server] INFO at java.util.concurrent.ThreadPoolExecutor.runWorker(Unknown Source) 29.09 22:36:37 [Server] INFO at org.bukkit.craftbukkit.v1_8_R3.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:56) 29.09 22:36:37 [Server] WARN org.apache.commons.lang.UnhandledException: Plugin AlertAPI v1.0 generated an exception while executing task 375 29.09 22:36:37 [Server] WARN Exception in thread "pool-3-thread-13"
@silvermmonkey
While you are working on 1.1 can you try add a option for a header & footer with images?
@Justin330
Justin, just use the Bukkit alias in the commands.yml for now.
This looks great And Ill be using this in more ways then one...
One problem... I have something else that is overriding the /alert command
think we could get one that switches the command to /sendalert Would be great! (although its still great, its just unusable to me unless its switched) Thanks for your work! Ant
@silvermmonkey
Work on it whenever you have time ! I really like this plugin but like I said I can't send messages to everyone . It unregisters me after the command runs , and never sends the message , however , individual messages are easily sent and work properly. Thank you for this awesome plugin ! Looking forward to more improvements.
@zinister12
Sorry it has taken me so long to reply! I have been very busy lately with some freelance work and a new job! I will get to this as soon as I can. But unfortunately I do not have a time frame.
@silvermmonkey
is v1.1 coming out soon ? also when i do /alert all (my message) it makes my player have to register all over again , and if i run it again it says register to use /ignore
Nice work, this plugin is really cool. There are quite a few others that don't work except for this yours.
If you're looking for any suggestions, may I ask that you have some way to register and email users from the console? Also, maybe an option to change the display name of the email sender. Currently it's the username sending the email, but I don't believe it looks too professional.
(An alias for /register would be soooo helpful, you wouldn't even know!)
Keep up the great work, Oz - Seclusive Craft
@zachrywilsn
Yes by using the command /alert all [message] it will send a message to all registered players on your server. They have to be registered with AlertAPI by using command /register. The email address you set up in the config will show up as the sender of the email. So if you do not want your personal email address to be shown as the sender, then set up a new account.
Emails that you send and receive outside of your bukkit server, will not be seen or sent to the registered players.
Does this answer your questions?
Ok not sure if i get this correct, this plug will let you mass email all players who register? an if so do i need a new email so all my mail thats is sent doesnt get sent to them all. just the messages i want to send. let me know please and thanks
@Willbbz
I am planning on adding a bunch of carriers at once. To add a carrier I will need the carrier name and the sms email extension.
It is not a difficult process, I just need to know what carriers people use to know what to add.
Also I have been working on your ticket, and I think that I resolved your issues, please let me know if the files provided fix the problem.
Fantastic API. Looking forward to when additional carriers are added.
Is it difficult to add additional carriers or do you just require altering the country code?
@ThrillMan16
I am waiting for the file to be approved. Should hopefully be soon! The staff has been busy!
Umm there is no download link