Prowlmail is the official service for getting email messages to be push notifications within Prowl. This document describes how you can use your Prowlmail address.
Getting your address
You can create an API key and copy its associated email address on the API keys page.
Your address will be in the form apikey@api.prowlapp.com
.
Using your address
You can use your address wherever you would normally use an email address. Put it into an email notifications field on a website, or forward your email to it for instant notification.
Option flags
For more advanced uses of Prowlmail, you can configure what Prowl does based on the email format.
Address usernames are defined as follows: apikey[[+priority][-options]]
Priority can be any of the following values: -2
, -1
, 0
, 1
, and 2
.
Option values are as follows, separate multiple values with periods (.):
- redirect—If Prowl understands more information about an email (e.g., from Google Voice) it can redirect to a location automatically.
- nobody—Do not include the body of the email in the notification. This is useful if you just want to be alerted about having mail, and don't want to read it.
- strip—Remove as much information as possible to keep the message as small as possible.
- nohash—Don't append the apikey to the end of the subject.
Examples
The following examples use the invalid API key zzz
as an example.
zzz@api.prowlapp.com
—defaultszzz+-2@api.prowlapp.com
—priority of-2
zzz+2-redirect@api.prowlapp.com
—priority of2
, enable redirectszzz+1-redirect.nobody@api.prowlapp.com
—priority of1
, enable redirects, do not include the bodyzzz-redirect.strip@api.prowlapp.com
—default priority, enable redirects, strip extra
Notification format
Prowl will deliver the notification as follows:
- Application name—the source of the email.
- Event name—the subject of the email.
- Description—the body of the email.
Google Voice
After you acquire your Prowlmail address, you can set up Google Voice notifications using the following steps:
- Make sure Google Voice has "text forwarding" enabled and set to your email address.
- In Gmail, create a new filter.
- You can use any other email service, too.
- The email service just has to preserve the 'From' like Gmail does.
- Set the From to
txt.voice.google.com OR voice-noreply@google.com
- Forward the message to your Prowl email address
Prowl will clean up the incoming message from Google to maximize readability and pushability.
If you want Prowl to automatically redirect to the email reply address for SMSes, and to the voicemail playback for voicemail messages, add +-redirect
to the end of your API key. Your address will look as follows: apikey+-redirect@api.prowlapp.com
.