# Paubox Perl
This is the official Perl wrapper for the [Paubox Transactional Email API](https://www.paubox.com/solutions/email-api). It is currently in alpha development.
The Paubox Transactional Email API allows your application to send secure, HIPAA-compliant email via Paubox and track deliveries and opens. The API wrapper allows you to construct and send messages.
# Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
## Installation
If you have App::cpanminus installed, you can install the module from CPAN like this:
```bash
cpanm Paubox_Email_SDK
```
Otherwise, you can install from the included archive.
```bash
git clone https://github.com/Paubox/paubox-perl-sdk.git
cd paubox-perl-sdk
cpanm Paubox_Email_SDK-1.0.tar.gz
```
### Getting Paubox API Credentials
You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).
Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
### Configuring API Credentials
Include your API credentials in "config.cfg" configuration file.
```bash
echo "API_KEY = YOUR_API_KEY" > config.cfg
echo "API_USERNAME = YOUR_ENDPOINT_NAME" >> config.cfg
echo "config.cfg" >> .gitignore
```
## Usage
To send an email, prepare a Message object and call the sendMessage method of Paubox_Email_SDK.
### Sending messages
```perl
use strict;
use warnings;
use Paubox_Email_SDK;
my $messageObj = new Paubox_Email_SDK::Message(
'from' => 'sender@domain.com',
'to' => ['recipient@example.com'],
'subject' => 'Testing!',
'text_content' => 'Hello World!',
'html_content' => 'Hello World!
'
);
my $service = Paubox_Email_SDK -> new();
my $response = $service -> sendMessage($messageObj);
print $response;
```
### Allowing non-TLS message delivery
If you want to send non-PHI mail that does not need to be HIPAA-compliant, you can allow the message delivery to take place even if a TLS connection is unavailable.
This means the message will not be converted into a secure portal message when a nonTLS connection is encountered. To do this, include 'allowNonTLS' => 1 in the messageObj, as shown below:
```perl
use strict;
use warnings;
use Paubox_Email_SDK;
my $messageObj = new Paubox_Email_SDK::Message(
'allowNonTLS' => 1,
'from' => 'sender@domain.com',
'to' => ['recipient@example.com'],
'subject' => 'Testing!',
'text_content' => 'Hello World!',
'html_content' => 'Hello World!
'
);
```
### Forcing Secure Notifications
Paubox Secure Notifications allow an extra layer of security, especially when coupled with an organization's requirement for message recipients to use 2-factor authentication to read messages (this setting is available to org administrators in the Paubox Admin Panel).
Instead of receiving an email with the message contents, the recipient will receive a notification email that they have a new message in Paubox.
```perl
use strict;
use warnings;
use Paubox_Email_SDK;
my $messageObj = new Paubox_Email_SDK::Message(
'forceSecureNotification' => 'true',
'from' => 'sender@domain.com',
'to' => ['recipient@example.com'],
'subject' => 'Testing!',
'text_content' => 'Hello World!',
'html_content' => 'Hello World!
'
);
```
### Adding Attachments and Additional Headers
```perl
use strict;
use warnings;
use Paubox_Email_SDK;
use JSON;
use MIME::Base64;
use String::Util qw(trim);
my $encodedAttachmentContent = trim (encode_base64("Hello! This is the attachment content!") );
my $attachment = '[{
"fileName": "hello_world.txt",
"contentType": "text/plain",
"content": "'.$encodedAttachmentContent.
'" }]';
my @decoded_json_attachment = @{decode_json($attachment)};
my $messageObj = new Paubox_Email_SDK::Message(
'from' => 'sender@domain.com',
'replyTo' => 'sender@domain.com',
'to' => ['recipient@example.com'],
'bcc' => ['recipient@example.com'],
'subject' => 'Testing!',
'text_content' => 'Hello World!',
'html_content' => 'Hello World!
',
'attachments' => [@decoded_json_attachment]
);
```
### Checking Email Dispositions
The SOURCE_TRACKING_ID of a message is returned in the response of the sendMessage method. To check the status for any email, use its source tracking id and call the getEmailDisposition method of Paubox_Email_SDK:
```perl
use strict;
use warnings;
use Paubox_Email_SDK;
my $service = Paubox_Email_SDK -> new();
my $response = $service -> getEmailDisposition("SOURCE_TRACKING_ID");
print $response;
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox-perl-sdk.
## License
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Copyright
Copyright © 2019, Paubox Inc.