360Works CloudMail/Documentation

From 360Works Product Documentation Wiki
(Difference between revisions)
Jump to: navigation, search
 
m (Auto-upload documentation)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
#REDIRECT [[360Works CloudMail Reference Documentation]]
+
=360Works CloudMail User Guide=
 +
360Works CloudMail is a plug-in for sending outbound e-mail messages and monitoring e-mail interactions using Amazon Web Services.</p>
 +
 
 +
This documentation lists the plug-in API reference. For a guide to getting started with CloudMail, go to the <a href="http://docs.360works.com/index.php/CloudMail">CloudMail documentation wiki.</a></p>
 +
 
 +
 
 +
 
 +
=360Works Plugin Setup Guides=
 +
See [[Plugins_101]] for Error reporting, installation, registration, and more.
 +
 
 +
=Function Summary=
 +
<div id="toc">
 +
*[[#CMGetResultInfo|CMGetResultInfo]] ( columnName ) &mdash; Call this function once for each piece of data that you want to retrieve about the activity record.
 +
*[[#CMIsProductionMode|CMIsProductionMode]] &mdash; This function will return '0' if the SES account is in sandbox mode, or '1' if it is in production mode.
 +
*[[#CMLastError|CMLastError]] &mdash; Returns the last Plugin-related error which occurred.
 +
*[[#CMNextResult|CMNextResult]] ( type ) &mdash; Use this function to retrieve e-mail related activity.
 +
*[[#CMSetAmazonCredentials|CMSetAmazonCredentials]] ( accessKey; secretKey ) &mdash; Call this function before you call any other e-mail sending-related functions.
 +
*[[#CMUploadResource|CMUploadResource]] ( resourcePathOrContainer; uploadName ) &mdash; This function allows you to upload resources
 +
such as graphics, PDF files, or other file types that can then be hyperlinked to your e-mail message.
 +
*[[#CMVersion|CMVersion]] &mdash; Returns the plug-in version number.
 +
</div>
 +
=Function Detail=
 +
<div id="CMGetResultInfo"></div>
 +
==CMGetResultInfo ( columnName ) ==
 +
Call this function once for each piece of data that you want to retrieve about the activity record.
 +
The columnName parameter depends on what type of activity this is. Here is a list of valid column names for each type of activity:
 +
<ul>
 +
<li>delivery: "campaign", "source", "destination", "timestamp", "messageId", "processingTimeMillis", "smtpResponse", "reportingMTA"</li>
 +
<li>bounce: "campaign", "source", "destination", "timestamp", "messageId", "feedbackId", "bounceType", "bounceSubType"</li>
 +
<li>complaint: "campaign", "source", "destination", "timestamp", "messageId", "feedbackId", "complaintFeedbackType", "userAgent"</li>
 +
<li>unsubscribe: "campaign", "email", "timestamp", "messageId", "reason"</li>
 +
<li>view: "campaign", "email", "timestamp", "messageId", "ipAddress", "browserInfo"</li>
 +
<li>click: "campaign", "email", "timestamp", "messageId", "ipAddress", "browserInfo", "url"</li>
 +
</ul>
 +
 
 +
<div class="parameters"><strong>Parameters:</strong>
 +
<dl><dt><code>columName</code> <dd>
 +
</dl></div>
 +
 
 +
 
 +
<div id="CMIsProductionMode"></div>
 +
==CMIsProductionMode==
 +
This function will return '0' if the SES account is in sandbox mode, or '1' if it is in production mode.
 +
An account that is in sandbox mode has low sending limits and can only be used to send to pre-verified e-mail addresses.
 +
 
 +
 
 +
 
 +
<div id="CMLastError"></div>
 +
==CMLastError==
 +
Returns the last Plugin-related error which occurred.
 +
This should be called any time that a plugin function returns "ERROR" to get a user-readable description of the error.
 +
 
 +
<div class="see"><strong>Returns:</strong> Error text, or <code>""</code> if there was no error.
 +
</div>
 +
 
 +
<div id="CMNextResult"></div>
 +
==CMNextResult ( type ) ==
 +
Use this function to retrieve e-mail related activity. Call this function with the type of activity you're interested in, and it will either return a '0' indicating that there is no activity of that type,
 +
or a '1' indicating that there is activity of that type. If a '1' is returned, then use the [[#CMGetResultInfo|CMGetResultInfo]] function to retrieve the details for that activity, and then continue calling this
 +
function until it returns a '0', indicating that there are no more activity records of this type at this time.
 +
 
 +
Email activity can be retrieved up to 14 days after the activity occurs, and after that, it will be lost.
 +
 
 +
<div class="parameters"><strong>Parameters:</strong>
 +
<dl><dt><code>type</code> <dd>The type of activity to retrieve. This can be 'unsubscribe', 'view', 'click', 'delivery', 'complaint', or 'bounce'
 +
</dl></div>
 +
 
 +
 
 +
<div id="CMSetAmazonCredentials"></div>
 +
==CMSetAmazonCredentials ( accessKey; secretKey ) ==
 +
Call this function before you call any other e-mail sending-related functions. This will validate that your AWS credentials are correct, and will then
 +
start an EC2 t2.micro instance running (if it is not already running).
 +
 
 +
<div class="parameters"><strong>Parameters:</strong>
 +
<dl></dl></div>
 +
<div class="see"><strong>Returns:</strong> A status message showing the IP address of the CloudMail server at EC2.
 +
</div>
 +
 
 +
<div id="CMUploadResource"></div>
 +
==CMUploadResource ( resourcePathOrContainer; uploadName ) ==
 +
This function allows you to upload resources
 +
such as graphics, PDF files, or other file types that can then be hyperlinked to your e-mail message.
 +
Be aware that anybody can download any resource if they know the name of the file, so if you are using this for
 +
confidential information, include random characters as part of the uploadName, so that it cannot be guessed.
 +
This will overwrite an existing resource if it has the same uploadName. You can include slashes in the uploadName to create a directory structure.
 +
 
 +
<div class="parameters"><strong>Parameters:</strong>
 +
<dl><dt><code>resource</code> <dd>
 +
</dl></div>
 +
<div class="see"><strong>Returns:</strong> URL to resource
 +
</div>
 +
 
 +
<div id="CMVersion"></div>
 +
==CMVersion==
 +
Returns the plug-in version number. You can check to see whether the plug-in is installed or not by checking to see if this function returns a '?' (which means it is not installed).

Latest revision as of 04:06, 7 June 2017

Contents

[edit] 360Works CloudMail User Guide

360Works CloudMail is a plug-in for sending outbound e-mail messages and monitoring e-mail interactions using Amazon Web Services.</p>

This documentation lists the plug-in API reference. For a guide to getting started with CloudMail, go to the <a href="http://docs.360works.com/index.php/CloudMail">CloudMail documentation wiki.</a></p>


[edit] 360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

[edit] Function Summary

  • CMGetResultInfo ( columnName ) — Call this function once for each piece of data that you want to retrieve about the activity record.
  • CMIsProductionMode — This function will return '0' if the SES account is in sandbox mode, or '1' if it is in production mode.
  • CMLastError — Returns the last Plugin-related error which occurred.
  • CMNextResult ( type ) — Use this function to retrieve e-mail related activity.
  • CMSetAmazonCredentials ( accessKey; secretKey ) — Call this function before you call any other e-mail sending-related functions.
  • CMUploadResource ( resourcePathOrContainer; uploadName ) — This function allows you to upload resources
such as graphics, PDF files, or other file types that can then be hyperlinked to your e-mail message.
  • CMVersion — Returns the plug-in version number.

[edit] Function Detail

[edit] CMGetResultInfo ( columnName )

Call this function once for each piece of data that you want to retrieve about the activity record. The columnName parameter depends on what type of activity this is. Here is a list of valid column names for each type of activity:

  • delivery: "campaign", "source", "destination", "timestamp", "messageId", "processingTimeMillis", "smtpResponse", "reportingMTA"
  • bounce: "campaign", "source", "destination", "timestamp", "messageId", "feedbackId", "bounceType", "bounceSubType"
  • complaint: "campaign", "source", "destination", "timestamp", "messageId", "feedbackId", "complaintFeedbackType", "userAgent"
  • unsubscribe: "campaign", "email", "timestamp", "messageId", "reason"
  • view: "campaign", "email", "timestamp", "messageId", "ipAddress", "browserInfo"
  • click: "campaign", "email", "timestamp", "messageId", "ipAddress", "browserInfo", "url"
Parameters:

columName


[edit] CMIsProductionMode

This function will return '0' if the SES account is in sandbox mode, or '1' if it is in production mode. An account that is in sandbox mode has low sending limits and can only be used to send to pre-verified e-mail addresses.


[edit] CMLastError

Returns the last Plugin-related error which occurred. This should be called any time that a plugin function returns "ERROR" to get a user-readable description of the error.

Returns: Error text, or "" if there was no error.

[edit] CMNextResult ( type )

Use this function to retrieve e-mail related activity. Call this function with the type of activity you're interested in, and it will either return a '0' indicating that there is no activity of that type, or a '1' indicating that there is activity of that type. If a '1' is returned, then use the CMGetResultInfo function to retrieve the details for that activity, and then continue calling this function until it returns a '0', indicating that there are no more activity records of this type at this time.

Email activity can be retrieved up to 14 days after the activity occurs, and after that, it will be lost.

Parameters:

type
The type of activity to retrieve. This can be 'unsubscribe', 'view', 'click', 'delivery', 'complaint', or 'bounce'


[edit] CMSetAmazonCredentials ( accessKey; secretKey )

Call this function before you call any other e-mail sending-related functions. This will validate that your AWS credentials are correct, and will then start an EC2 t2.micro instance running (if it is not already running).

Parameters:
Returns: A status message showing the IP address of the CloudMail server at EC2.

[edit] CMUploadResource ( resourcePathOrContainer; uploadName )

This function allows you to upload resources such as graphics, PDF files, or other file types that can then be hyperlinked to your e-mail message. Be aware that anybody can download any resource if they know the name of the file, so if you are using this for confidential information, include random characters as part of the uploadName, so that it cannot be guessed. This will overwrite an existing resource if it has the same uploadName. You can include slashes in the uploadName to create a directory structure.

Parameters:

resource

Returns: URL to resource

[edit] CMVersion

Returns the plug-in version number. You can check to see whether the plug-in is installed or not by checking to see if this function returns a '?' (which means it is not installed).

Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox