Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Service_Amazon_Ses Component Proposal

Proposed Component Name Zend_Service_Amazon_Ses
Developer Notes
Proposers Nicholas Miller
Konr Ness
Zend Liaison TBD
Revision 1.0 - 29 January 2011: Initial Draft. (wiki revision: 21)

Table of Contents

1. Overview

Zend_Service_Amazon_Ses would bring to Zend Framework the API calls available for Amazon's Simple Email Service.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will implement all specified Amazon SES web-based actions (See references -> Amazon Simple Email Services API Documentation).
  • This component will use Amazon's Version 3 Authentication
  • This component will not save any external data.
  • This component will use SimpleXMLElement to read Amazon's response messages.
  • This component will allow subclassing
  • This component will extend Zend_Service_Amazon_Abstract
  • This component will make http requests using Zend_Http_Client
  • This component will validate any supplied http uri with the Zend_Uri_Http::valid() method

4. Dependencies on Other Framework Components

  • Zend_Service_Amazon_Exception
  • Zend_Service_Amazon_Abstract
  • Zend_Http_Client
  • Zend_Uri_Http

5. Theory of Operation

Zend_Service_Amazon_Ses would map the actions outlined Amazon's SES API documentation as class methods (See below use cases). Using the component is performed by instantiating a new Zend_Service_Amazon_Ses object. Being this component extends from Zend_Service_Amazon_Abstract AWS credentials are supplied either as static defaults, or at the time of instantiation through constructor arguments.

6. Milestones / Tasks

  • Milestone 1: Write a working prototype "[DONE]"
  • Milestone 2: Finalize Revisions based on community input
  • Milestone 3: Port code to Zend Framework 2.0
  • Milestone 4: Working prototype checked into the incubator when requirements are met.
  • Milestone 5: Unit tests exist, work, and are checked into SVN.
  • Milestone 6: Initial documentation exists.

7. Class Index

  • Zend_Service_Amazon_Ses
  • Zend_Service_Amazon_Ses_Exception
  • Zend_Service_Amazon_Ses_Email
  • Zend_Mail_Transport_Ses

8. Use Cases

UC-01 Statically Supplying AWS Credentials
UC-02 Supplying AWS Credentials During Instantiation
UC-03 Verify an Email Address
UC-04 Deleting a Verified Email
UC-05 Sending an Email with the SendRawEmail action
UC-06 Sending an Email with the SendEmail Action
UC-07 Using Zend_Mail_Transport_AmazonSes

$ses = new Zend_Service_Amazon_Ses();

$mail = new Zend_Mail();
$mail->setFrom('', 'From Name');
$mail->addTo($to, '');
$mail->send(new Zend_Mail_Transport_AmazonSes($ses));

9. Class Skeletons


Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.