Purpose of this plugin:
The goal of this plugin is to make it extremely easy for people to send email to Confluence thereby creating pages, adding attachments, interacting with comment threads, etc.
When possible the plugin allows each page in Confluence (both existing and not yet existing) to have it's own unique email address. Anytime an email is sent to that address the contents of the email will be added to the page.
The idea for this dates back to JotSpot wiki which had this feature implemented wonderfully before Google acquired it.
| Download Plugin send-email-to-page-0.0.2.jar (released Apr 28th, 2010) |
Confluence has some other email capabilities but nothing like this currently exists. 
- Purpose of this plugin:
- Usage Examples:
- Example 1 - Creating a new page:
- Example 2 - Adding an attachment:
- Example 3 - Adding comments to a page:
- Example 4 - No special details are given in email address:
- Installation and Configuration
- Current limitations:
- Email address aliasing and how Google Mail makes unique page addressing possible:
Usage Examples:
Example 1 - Creating a new page:
Preconditions:
- no page named "My New Page" exists in the space spkey
Email Details:
To: my.account+spkey+My+New+Page@gmail.com
Subject: Subject Of My New Page
Body: Body text of my new page
What happens
- A page is created in the space with space key: spkey
- The new page has a title of "My New Page"
- The new page has body text: "Body text of my new page"
Example 2 - Adding an attachment:
Everything same as example 1, but if you add attachments to the email they are added to the
Example 3 - Adding comments to a page:
Preconditions:
- a page named "My New Page" already exists in the space spkey
Email Details:
To: my.account+spkey+My+New+Page@gmail.com
Subject: re: Subject Of My New Page
Body: some comment about this topic
What happens
- A comment is added to the bottom of the comment list for the page "My New Page"
- The comment contains the text "some comment about this topic"
Example 4 - No special details are given in email address:
Preconditions:
- no page named "My New Page" exists in the space spkey
Email Details:
To: my.account@gmail.com
Subject: Subject Of My New Page
Body: Body text of my new page
What happens
- A page is created in the default space which is configured in the SendEmailToPage Admin screen
- The new page has a title of "Subject Of My New Page"
- The new page has body text: "Body text of my new page"
Note:
I'll be adding other options shortly to give more control over what happens when you don't or can't insert metadata into the email address.
Installation and Configuration
(still working on the real docs for this but quickly)
- standard plugin installation from Confluence's built in "Plugin Repository"
- There will be a new link on the Administration screen to "Send Email To Page Admin" in the left nav column
- Simply update your account info
- Send a test email to the account, then on the admin screen click the "Check Mail Now" button, then go see if your page appeared in Confluence. Note that your page will not appear in 'Recently Updated' or search for a couple of minutes until Confluence indexes it.
Current limitations:
Here are a set of current limitations that I hope to cross off rapidly in a quick succession of releases.
- no support yet POP mail accounts
- only tested thusfar against Googles IMAPS server
- currently the target space where email is to be sent must be specified in the email's address or it will default to the default email target space
- email checking is hardcoded to 5 minutes though you can manually kick off an email check. (future fix - this will be configurable on the admin screen)
Email address aliasing and how Google Mail makes unique page addressing possible:
For this feature to work most effectively the IMAP or POP server being used must support 'email aliasing'.
This feature can be called:
- plus email addressing
- address aliasing
(same feature - just different names).
In a nutshell :
An email account 'your.username' can receive messages sent to your.username+any.alias@somedomain.com. For a GMail example, messages sent to jane.doe+notes@somedomain.com are delivered to jane.doe@gmail.com.
The feature is very clearly and succinctly explained on these two pages:
- http://mail.google.com/support/bin/answer.py?hl=en&answer=12096
- http://www.smartertools.com/help/smartermail/v3/Topics/User/Mail/PlusAddressing.aspx
http://www.smartertools.com/help/smartermail/v3/Topics/User/Mail/PlusAddressing.aspx