Zend Gdata Email Settings

The title of the page contains typo, it shouldn't have 'Emails' but 'Email. But that doesn't matter.

Zend Framework: Zend Gdata Email Settings Entry Component Proposal

Table of Contents

1. Overview

Zend Gdata Email Settings makes Zend Gdata talk to Google Email Settings API.

2. References

• Email Settings API

3. Component Requirements, Constraints, and Acceptance Criteria

• It will support create and update operations of the API - because there are no retrieve/delete operations (at the time of this proposal).
• It will throw an exception on errors, same way as Gdata does.

4. Dependencies on Other Framework Components

• Zend Gdata Gapps Entry, Extension etc

5. Theory of Operation

Initial idea:

• Email Settings API allows to send various settings to one of a few API URI. Rather than handling each setting in a separate class, have one class Zend_Gdata_Gapps_Extension_Property which encapsulates the property name and its value.
• instantiate Zend_Gdata_Gapps_EmailSettingsEntry
• instantiate one of several of Zend_Gdata_Gapps_Extension_Property and put them into an array
• pass that array to Zend_Gdata_Gapps_EmailSettingsEntry object via setProperties()
• instantiate Zend_Gdata_Gapps and call its submitEmailSettings(..)

6. Milestones / Tasks

• zero proof of concept - Zend_Gdata_Gapps_EmailSettingsEntry, Zend_Gdata_Gapps_Extension_Property and a simple example below. submitEmailSettings() echoes the XML response. No error handling.
• Milestone #1 - once you suggest any changes to the workflow, function return values (if any - since we can't do retrieve operation) and have exceptions thrown/re-thrown on errors.
• Mileston #2 - above, documented, reviewed/cleaned up, check into incubator
• Milestone #3 - Unit tests exist, work, and are checked into SVN.
• Milestone 5: Initial documentation exists.

7. Class Index

• Zend_Gdata_Gapps_EmailSettingsEntry
• Zend_Gdata_Gapps_EmailSettingsFeed
• Zend_Gdata_Gapps_EmailSettingsQuery
• Zend_Gdata_Gapps_Extension_Property

8. Use Cases

Described above.

9. Class Skeletons