Add-ons
Typical Reply 2.1
by ClearCode Inc.
Provides ability to send/receive typical replies in a team.Provides ability to send/receive typical replies in a team.
About this Add-on
For example, if you are reading a mail like:
Subject:
How about this?
Body:
Hi.
I've wrote a plan. How about this?
http://...
Then you can send a typical reply quickly.
If you click the "Like!" button (or choose "Like!" item from the context menu on the thread pane), a reply like follogin will be sent:
Subject:
[[Like!]]: Re: How about this?
Body:
Like!
> Hi.
> I've wrote a plan. How about this?
> http://...
On the other hand, when the receiver downloads typical reply mails, those replies are shown with special icon for the type.
Moreover the receiver can see all received typical replies via a virtual folder created by this addon automatically.
There are three types of "typical reply" are defined by default: "accept", "reject", and "like".
Of course you can add new types of typical replies as you like.
## How to add a new typical reply type?
For example, assume that you are going to add a new "Awesome!" button.
1. Define the internal type name. Now I use `awesome`.
2. Define name of the reply type. It must be defined as a string preference, like:
pref("extensions.typical-reply@clear-code.com.reply.awesome.label", "Awesome!");
pref("extensions.typical-reply@clear-code.com.reply.awesome.accesskey", "A");
The part `extensions.typical-reply@clear-code.com.reply.` is the common prefix.
The `label` is used for the custom button or the menu item of the "Tipycal Reply" button.
The `accesskey` is used for the menu item in the menu of the "Tipycal Reply" button.
3. Define subject of typical replies from the button.
pref("extensions.typical-reply@clear-code.com.reply.awesome.subjectPrefix", "[[Awesome!]]");
pref("extensions.typical-reply@clear-code.com.reply.awesome.subject", "");
If you set any string for the `subjectPrefix`, it will be inserted to the start of the subject.
It will be used to detect the type of the reply.
If a receiver gets a mail with a subject like "[[Awesome!]]: Re: How about this?", its reply type will be detected as "awesome".
If you use another option `subject`, the subject of the reply will be completely replaced to the value of `subject`.
4. Define body of typical replies from the button.
pref("extensions.typical-reply@clear-code.com.reply.awesome.body", "Awesome!!");
It will be inserted to the body of the reply automatically.
5. Define recipients of the typical reply.
There are some choices:
* `all`: Same to "Reply to All". The reply inherits To, Cc, and Bcc from the original mail.
* `sender`: Same to "Reply to Sender". The reply will be sent to the author of the original mail.
* `blank`: The list of recipients will become blank completely.
* Comma-separated E-mail addresses
For example:
pref("extensions.typical-reply@clear-code.com.reply.awesome.recipients", "all");
6. Define forwarding behavior.
pref("extensions.typical-reply@clear-code.com.reply.awesome.forwardType", "attachment");
Acceptable values are `"attachment"` (always forward as an attachment) or `"inline"` (always forward inline). In these cases you need to specify E-mail addresses via the `recipients` parameter previously described, in other words both `all` and `sender` are ignored.
If you want to send a reply from the button, don't specify any value for this parameter.
7. Define quotation behavior.
pref("extensions.typical-reply@clear-code.com.reply.awesome.quoteType", "yes");
Acceptable values are `"yes"` (always quote body) or `"no"` (never qupte body). Otherwise the button for the type will have two choices: "reply without quote" and "reply with quote".
8. Define the priority.
Possible values are `Highest`, `High`, `Normal`, `Low` and `Lowest`.
pref("extensions.typical-reply@clear-code.com.reply.awesome.priority", "Highest");
9. Define button type.
pref("extensions.typical-reply@clear-code.com.reply.awesome.separate", false);
If you choose `true`, a new toolbar button for the reply type is generated in the header area.
Otherwise menu items for the reply type is generated in the menu item of the "Tipycal Reply" button.
10. Define behavior of the virtual folder.
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchFolder", true);
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchTargets", "all");
If you set `searchFolder` to `true`, this addon automatically generates a virutal folder for the type, in all accounts.
You can customize list of folders which via the preference item `searchTargets`.
* `all`: Finds all typical reply messages from all folders of the account.
* `inbox`: Finxs typical reply messges only from the inbox.
11. Define allowed recipient domains.
pref("extensions.typical-reply@clear-code.com.reply.awesome.allowedDomains", "*");
If you set `allowedDomains` to `*` or a blank string, then typical replies can be sent
for any recipient.
Otherwise - if you write a comma-separated list of domains, then you can send typical replies
only when all recipients are included in the list. For example:
pref("extensions.typical-reply@clear-code.com.reply.awesome.allowedDomains", "example.com, example.jp");
12. Define behaviour of auto-send.
pref("extensions.typical-reply@clear-code.com.reply.awesome.autoSend", "noquote");
If you set `autoSend` to `always`, then typical replies are sent to recipients automatically
without confirmation. If you set it to `noquote`, then typical replies are sent automatically
only when there is no quotation in the body. Otherwise, you have to click the "Send" button
manually.
13. Define images for the type.
You can specify images as an URI.
pref("extensions.typical-reply@clear-code.com.reply.awesome.icon", "data:image/png,...");
pref("extensions.typical-reply@clear-code.com.reply.awesome.bodyImage", "data:image/png,...");
The `icon` is used for the button and menu items of the "Tipycal Reply" button.
If you set any URI fo the `bodyImage`, it will be embedded to the message, as an attachment.
Finally you'll get a configurations for the new button, like following:
```javascript
pref("extensions.typical-reply@clear-code.com.reply.awesome.label", "Awesome!");
pref("extensions.typical-reply@clear-code.com.reply.awesome.accesskey", "L");
pref("extensions.typical-reply@clear-code.com.reply.awesome.subjectPrefix", "[[!Awesome]]");
pref("extensions.typical-reply@clear-code.com.reply.awesome.subject", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.body", "Awesome!");
pref("extensions.typical-reply@clear-code.com.reply.awesome.recipients", "all");
pref("extensions.typical-reply@clear-code.com.reply.awesome.forwardType", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.quoteType", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.priority", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.separate", false);
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchFolder", true);
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchTargets", "all");
pref("extensions.typical-reply@clear-code.com.reply.awesome.allowedDomains", "*");
pref("extensions.typical-reply@clear-code.com.reply.awesome.autoSend", "noquote");
pref("extensions.typical-reply@clear-code.com.reply.awesome.icon", "data:image/png,...(awesome.png)...");
pref("extensions.typical-reply@clear-code.com.reply.awesome.bodyImage", "data:image/png,...(awesome.png)...");
```
The you have to add the internal name of the type you defined, like:
```javascript
pref("extensions.typical-reply@clear-code.com.buttons", "accept,reject,like,awesome");
```
## More examples
### "Report as abuse" button
```javascript
pref("extensions.typical-reply@clear-code.com.reply.abuse.label", "Report as Abuse Mail");
pref("extensions.typical-reply@clear-code.com.reply.abuse.accesskey", "R");
pref("extensions.typical-reply@clear-code.com.reply.abuse.subjectPrefix", "[[Abuse]]");
pref("extensions.typical-reply@clear-code.com.reply.abuse.subject", "");
pref("extensions.typical-reply@clear-code.com.reply.abuse.body", "This is an abuse mail.");
pref("extensions.typical-reply@clear-code.com.reply.abuse.recipients", "report-abuse@example.com");
pref("extensions.typical-reply@clear-code.com.reply.abuse.quoteType", "no");
pref("extensions.typical-reply@clear-code.com.reply.abuse.forwardType", "attachment");
pref("extensions.typical-reply@clear-code.com.reply.abuse.separate", true);
pref("extensions.typical-reply@clear-code.com.reply.abuse.allowedDomains", "*");
```
Subject:
How about this?
Body:
Hi.
I've wrote a plan. How about this?
http://...
Then you can send a typical reply quickly.
If you click the "Like!" button (or choose "Like!" item from the context menu on the thread pane), a reply like follogin will be sent:
Subject:
[[Like!]]: Re: How about this?
Body:
Like!
> Hi.
> I've wrote a plan. How about this?
> http://...
On the other hand, when the receiver downloads typical reply mails, those replies are shown with special icon for the type.
Moreover the receiver can see all received typical replies via a virtual folder created by this addon automatically.
There are three types of "typical reply" are defined by default: "accept", "reject", and "like".
Of course you can add new types of typical replies as you like.
## How to add a new typical reply type?
For example, assume that you are going to add a new "Awesome!" button.
1. Define the internal type name. Now I use `awesome`.
2. Define name of the reply type. It must be defined as a string preference, like:
pref("extensions.typical-reply@clear-code.com.reply.awesome.label", "Awesome!");
pref("extensions.typical-reply@clear-code.com.reply.awesome.accesskey", "A");
The part `extensions.typical-reply@clear-code.com.reply.` is the common prefix.
The `label` is used for the custom button or the menu item of the "Tipycal Reply" button.
The `accesskey` is used for the menu item in the menu of the "Tipycal Reply" button.
3. Define subject of typical replies from the button.
pref("extensions.typical-reply@clear-code.com.reply.awesome.subjectPrefix", "[[Awesome!]]");
pref("extensions.typical-reply@clear-code.com.reply.awesome.subject", "");
If you set any string for the `subjectPrefix`, it will be inserted to the start of the subject.
It will be used to detect the type of the reply.
If a receiver gets a mail with a subject like "[[Awesome!]]: Re: How about this?", its reply type will be detected as "awesome".
If you use another option `subject`, the subject of the reply will be completely replaced to the value of `subject`.
4. Define body of typical replies from the button.
pref("extensions.typical-reply@clear-code.com.reply.awesome.body", "Awesome!!");
It will be inserted to the body of the reply automatically.
5. Define recipients of the typical reply.
There are some choices:
* `all`: Same to "Reply to All". The reply inherits To, Cc, and Bcc from the original mail.
* `sender`: Same to "Reply to Sender". The reply will be sent to the author of the original mail.
* `blank`: The list of recipients will become blank completely.
* Comma-separated E-mail addresses
For example:
pref("extensions.typical-reply@clear-code.com.reply.awesome.recipients", "all");
6. Define forwarding behavior.
pref("extensions.typical-reply@clear-code.com.reply.awesome.forwardType", "attachment");
Acceptable values are `"attachment"` (always forward as an attachment) or `"inline"` (always forward inline). In these cases you need to specify E-mail addresses via the `recipients` parameter previously described, in other words both `all` and `sender` are ignored.
If you want to send a reply from the button, don't specify any value for this parameter.
7. Define quotation behavior.
pref("extensions.typical-reply@clear-code.com.reply.awesome.quoteType", "yes");
Acceptable values are `"yes"` (always quote body) or `"no"` (never qupte body). Otherwise the button for the type will have two choices: "reply without quote" and "reply with quote".
8. Define the priority.
Possible values are `Highest`, `High`, `Normal`, `Low` and `Lowest`.
pref("extensions.typical-reply@clear-code.com.reply.awesome.priority", "Highest");
9. Define button type.
pref("extensions.typical-reply@clear-code.com.reply.awesome.separate", false);
If you choose `true`, a new toolbar button for the reply type is generated in the header area.
Otherwise menu items for the reply type is generated in the menu item of the "Tipycal Reply" button.
10. Define behavior of the virtual folder.
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchFolder", true);
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchTargets", "all");
If you set `searchFolder` to `true`, this addon automatically generates a virutal folder for the type, in all accounts.
You can customize list of folders which via the preference item `searchTargets`.
* `all`: Finds all typical reply messages from all folders of the account.
* `inbox`: Finxs typical reply messges only from the inbox.
11. Define allowed recipient domains.
pref("extensions.typical-reply@clear-code.com.reply.awesome.allowedDomains", "*");
If you set `allowedDomains` to `*` or a blank string, then typical replies can be sent
for any recipient.
Otherwise - if you write a comma-separated list of domains, then you can send typical replies
only when all recipients are included in the list. For example:
pref("extensions.typical-reply@clear-code.com.reply.awesome.allowedDomains", "example.com, example.jp");
12. Define behaviour of auto-send.
pref("extensions.typical-reply@clear-code.com.reply.awesome.autoSend", "noquote");
If you set `autoSend` to `always`, then typical replies are sent to recipients automatically
without confirmation. If you set it to `noquote`, then typical replies are sent automatically
only when there is no quotation in the body. Otherwise, you have to click the "Send" button
manually.
13. Define images for the type.
You can specify images as an URI.
pref("extensions.typical-reply@clear-code.com.reply.awesome.icon", "data:image/png,...");
pref("extensions.typical-reply@clear-code.com.reply.awesome.bodyImage", "data:image/png,...");
The `icon` is used for the button and menu items of the "Tipycal Reply" button.
If you set any URI fo the `bodyImage`, it will be embedded to the message, as an attachment.
Finally you'll get a configurations for the new button, like following:
```javascript
pref("extensions.typical-reply@clear-code.com.reply.awesome.label", "Awesome!");
pref("extensions.typical-reply@clear-code.com.reply.awesome.accesskey", "L");
pref("extensions.typical-reply@clear-code.com.reply.awesome.subjectPrefix", "[[!Awesome]]");
pref("extensions.typical-reply@clear-code.com.reply.awesome.subject", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.body", "Awesome!");
pref("extensions.typical-reply@clear-code.com.reply.awesome.recipients", "all");
pref("extensions.typical-reply@clear-code.com.reply.awesome.forwardType", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.quoteType", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.priority", "");
pref("extensions.typical-reply@clear-code.com.reply.awesome.separate", false);
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchFolder", true);
pref("extensions.typical-reply@clear-code.com.reply.awesome.searchTargets", "all");
pref("extensions.typical-reply@clear-code.com.reply.awesome.allowedDomains", "*");
pref("extensions.typical-reply@clear-code.com.reply.awesome.autoSend", "noquote");
pref("extensions.typical-reply@clear-code.com.reply.awesome.icon", "data:image/png,...(awesome.png)...");
pref("extensions.typical-reply@clear-code.com.reply.awesome.bodyImage", "data:image/png,...(awesome.png)...");
```
The you have to add the internal name of the type you defined, like:
```javascript
pref("extensions.typical-reply@clear-code.com.buttons", "accept,reject,like,awesome");
```
## More examples
### "Report as abuse" button
```javascript
pref("extensions.typical-reply@clear-code.com.reply.abuse.label", "Report as Abuse Mail");
pref("extensions.typical-reply@clear-code.com.reply.abuse.accesskey", "R");
pref("extensions.typical-reply@clear-code.com.reply.abuse.subjectPrefix", "[[Abuse]]");
pref("extensions.typical-reply@clear-code.com.reply.abuse.subject", "");
pref("extensions.typical-reply@clear-code.com.reply.abuse.body", "This is an abuse mail.");
pref("extensions.typical-reply@clear-code.com.reply.abuse.recipients", "report-abuse@example.com");
pref("extensions.typical-reply@clear-code.com.reply.abuse.quoteType", "no");
pref("extensions.typical-reply@clear-code.com.reply.abuse.forwardType", "attachment");
pref("extensions.typical-reply@clear-code.com.reply.abuse.separate", true);
pref("extensions.typical-reply@clear-code.com.reply.abuse.allowedDomains", "*");
```
