Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
joshourisman
joshourisman / gdata python
Repository URL to install this package:
|
Version:
2.1.0.jo1 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module gdata.apps.emailsettings.client</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.apps.html"><font color="#ffffff">apps</font></a>.<a href="gdata.apps.emailsettings.html"><font color="#ffffff">emailsettings</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/apps/emailsettings/client.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/apps/emailsettings/client.py</a></font></td></tr></table>
<p><tt><a href="#EmailSettingsClient">EmailSettingsClient</a> simplifies Email Settings API calls.<br>
<br>
<a href="#EmailSettingsClient">EmailSettingsClient</a> extends gdata.client.<a href="gdata.client.html#GDClient">GDClient</a> to ease interaction with<br>
the Google Apps Email Settings API. These interactions include the ability<br>
to create labels, filters, aliases, and update web-clip, forwarding, POP,<br>
IMAP, vacation-responder, signature, language, and general settings, and<br>
retrieve labels, send-as, forwarding, pop, imap, vacation and signature<br>
settings.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gdata.html">gdata</a><br>
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="gdata.client.html#GDClient">gdata.client.GDClient</a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.apps.emailsettings.client.html#EmailSettingsClient">EmailSettingsClient</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="EmailSettingsClient">class <strong>EmailSettingsClient</strong></a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Client extension for the Google Email Settings API service.<br>
<br>
Attributes:<br>
host: string The hostname for the Email Settings API service.<br>
api_version: string The version of the Email Settings API.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.emailsettings.client.html#EmailSettingsClient">EmailSettingsClient</a></dd>
<dd><a href="gdata.client.html#GDClient">gdata.client.GDClient</a></dd>
<dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="EmailSettingsClient-AddEmailDelegate"><strong>AddEmailDelegate</strong></a> = <a href="#EmailSettingsClient-add_email_delegate">add_email_delegate</a>(self, username, address, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-CreateFilter"><strong>CreateFilter</strong></a> = <a href="#EmailSettingsClient-create_filter">create_filter</a>(self, username, from_address<font color="#909090">=None</font>, to_address<font color="#909090">=None</font>, subject<font color="#909090">=None</font>, has_the_word<font color="#909090">=None</font>, does_not_have_the_word<font color="#909090">=None</font>, has_attachments<font color="#909090">=None</font>, label<font color="#909090">=None</font>, mark_as_read<font color="#909090">=None</font>, archive<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-CreateLabel"><strong>CreateLabel</strong></a> = <a href="#EmailSettingsClient-create_label">create_label</a>(self, username, name, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-CreateSendAs"><strong>CreateSendAs</strong></a> = <a href="#EmailSettingsClient-create_send_as">create_send_as</a>(self, username, name, address, reply_to<font color="#909090">=None</font>, make_default<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-DeleteEmailDelegate"><strong>DeleteEmailDelegate</strong></a> = <a href="#EmailSettingsClient-delete_email_delegate">delete_email_delegate</a>(self, username, address, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-DeleteLabel"><strong>DeleteLabel</strong></a> = <a href="#EmailSettingsClient-delete_label">delete_label</a>(self, username, label, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-MakeEmailSettingsUri"><strong>MakeEmailSettingsUri</strong></a> = <a href="#EmailSettingsClient-make_email_settings_uri">make_email_settings_uri</a>(self, username, setting_id)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveEmailDelegates"><strong>RetrieveEmailDelegates</strong></a> = <a href="#EmailSettingsClient-retrieve_email_delegates">retrieve_email_delegates</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveForwarding"><strong>RetrieveForwarding</strong></a> = <a href="#EmailSettingsClient-retrieve_forwarding">retrieve_forwarding</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveImap"><strong>RetrieveImap</strong></a> = <a href="#EmailSettingsClient-retrieve_imap">retrieve_imap</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveLabels"><strong>RetrieveLabels</strong></a> = <a href="#EmailSettingsClient-retrieve_labels">retrieve_labels</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrievePop"><strong>RetrievePop</strong></a> = <a href="#EmailSettingsClient-retrieve_pop">retrieve_pop</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveSendAs"><strong>RetrieveSendAs</strong></a> = <a href="#EmailSettingsClient-retrieve_send_as">retrieve_send_as</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveSignature"><strong>RetrieveSignature</strong></a> = <a href="#EmailSettingsClient-retrieve_signature">retrieve_signature</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RetrieveVacation"><strong>RetrieveVacation</strong></a> = <a href="#EmailSettingsClient-retrieve_vacation">retrieve_vacation</a>(self, username, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateForwarding"><strong>UpdateForwarding</strong></a> = <a href="#EmailSettingsClient-update_forwarding">update_forwarding</a>(self, username, enable, forward_to<font color="#909090">=None</font>, action<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateGeneralSettings"><strong>UpdateGeneralSettings</strong></a> = <a href="#EmailSettingsClient-update_general_settings">update_general_settings</a>(self, username, page_size<font color="#909090">=None</font>, shortcuts<font color="#909090">=None</font>, arrows<font color="#909090">=None</font>, snippets<font color="#909090">=None</font>, use_unicode<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateImap"><strong>UpdateImap</strong></a> = <a href="#EmailSettingsClient-update_imap">update_imap</a>(self, username, enable, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateLanguage"><strong>UpdateLanguage</strong></a> = <a href="#EmailSettingsClient-update_language">update_language</a>(self, username, language, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdatePop"><strong>UpdatePop</strong></a> = <a href="#EmailSettingsClient-update_pop">update_pop</a>(self, username, enable, enable_for<font color="#909090">=None</font>, action<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateSignature"><strong>UpdateSignature</strong></a> = <a href="#EmailSettingsClient-update_signature">update_signature</a>(self, username, signature, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateVacation"><strong>UpdateVacation</strong></a> = <a href="#EmailSettingsClient-update_vacation">update_vacation</a>(self, username, enable, subject<font color="#909090">=None</font>, message<font color="#909090">=None</font>, start_date<font color="#909090">=None</font>, end_date<font color="#909090">=None</font>, contacts_only<font color="#909090">=None</font>, domain_only<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-UpdateWebclip"><strong>UpdateWebclip</strong></a> = <a href="#EmailSettingsClient-update_webclip">update_webclip</a>(self, username, enable, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-__init__"><strong>__init__</strong></a>(self, domain, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Constructs a new client for the Email Settings API.<br>
<br>
Args:<br>
domain: string The Google Apps domain with Email Settings.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the email settings.<br>
kwargs: The other parameters to pass to the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a><br>
constructor.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-add_email_delegate"><strong>add_email_delegate</strong></a>(self, username, address, **kwargs)</dt><dd><tt>Add an email delegate to the mail account<br>
<br>
Args:<br>
username: string The name of the user<br>
address: string The email address of the delegated account</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-create_filter"><strong>create_filter</strong></a>(self, username, from_address<font color="#909090">=None</font>, to_address<font color="#909090">=None</font>, subject<font color="#909090">=None</font>, has_the_word<font color="#909090">=None</font>, does_not_have_the_word<font color="#909090">=None</font>, has_attachments<font color="#909090">=None</font>, label<font color="#909090">=None</font>, mark_as_read<font color="#909090">=None</font>, archive<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a filter with the given properties.<br>
<br>
Args:<br>
username: string The name of the user.<br>
from_address: string The source email address for the filter.<br>
to_address: string (optional) The destination email address for<br>
the filter.<br>
subject: string (optional) The value the email must have in its<br>
subject to be filtered.<br>
has_the_word: string (optional) The value the email must have<br>
in its subject or body to be filtered.<br>
does_not_have_the_word: string (optional) The value the email<br>
cannot have in its subject or body to be filtered.<br>
has_attachments: string (optional) A boolean string representing<br>
whether the email must have an attachment to be filtered.<br>
label: string (optional) The name of the label to apply to<br>
messages matching the filter criteria.<br>
mark_as_read: Boolean (optional) Whether or not to mark<br>
messages matching the filter criteria as read.<br>
archive: Boolean (optional) Whether or not to move messages<br>
matching to Archived state.<br>
kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#EmailSettingsClient-post">post</a>().<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsFilter of the new resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-create_label"><strong>create_label</strong></a>(self, username, name, **kwargs)</dt><dd><tt>Creates a label with the given properties.<br>
<br>
Args:<br>
username: string The name of the user.<br>
name: string The name of the label.<br>
kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#EmailSettingsClient-post">post</a>().<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsLabel of the new resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-create_send_as"><strong>create_send_as</strong></a>(self, username, name, address, reply_to<font color="#909090">=None</font>, make_default<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a send-as alias with the given properties.<br>
<br>
Args:<br>
username: string The name of the user.<br>
name: string The name that will appear in the "From" field.<br>
address: string The email address that appears as the<br>
origination address for emails sent by this user.<br>
reply_to: string (optional) The address to be used as the reply-to<br>
address in email sent using the alias.<br>
make_default: Boolean (optional) Whether or not this alias should<br>
become the default alias for this user.<br>
kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#EmailSettingsClient-post">post</a>().<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsSendAsAlias of the<br>
new resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-delete_email_delegate"><strong>delete_email_delegate</strong></a>(self, username, address, **kwargs)</dt><dd><tt>Delete an email delegate from the specified account<br>
<br>
Args:<br>
username: string The name of the user<br>
address: string The email address of the delegated account</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-delete_label"><strong>delete_label</strong></a>(self, username, label, **kwargs)</dt><dd><tt>Delete a label from the specified account.<br>
<br>
Args:<br>
username: string Name of the user<br>
label: string Name of the label to be deleted<br>
<br>
Returns:<br>
An atom.http_core.HttpResponse() with the result of the request</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-make_email_settings_uri"><strong>make_email_settings_uri</strong></a>(self, username, setting_id)</dt><dd><tt>Creates the URI for the Email Settings API call.<br>
<br>
Using this client's Google Apps domain, create the URI to setup<br>
email settings for the given user in that domain. If params are provided,<br>
append them as GET params.<br>
<br>
Args:<br>
username: string The name of the user affected by this setting.<br>
setting_id: string The key of the setting to be configured.<br>
<br>
Returns:<br>
A string giving the URI for Email Settings API calls for this client's<br>
Google Apps domain.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_email_delegates"><strong>retrieve_email_delegates</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieve a feed of the email delegates for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the email delegates for<br>
<br>
Returns:<br>
A gdata.data.GDFeed of the user's email delegates</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_forwarding"><strong>retrieve_forwarding</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves forwarding settings for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the forwarding settings for<br>
<br>
Returns:<br>
A gdata.data.GDEntry of the user's email forwarding settings</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_imap"><strong>retrieve_imap</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves imap settings for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the imap settings for<br>
<br>
Returns:<br>
A gdata.data.GDEntry of the user's IMAP settings</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_labels"><strong>retrieve_labels</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves email labels for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the labels for<br>
<br>
Returns:<br>
A gdata.data.GDFeed of the user's email labels</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_pop"><strong>retrieve_pop</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves POP settings for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the POP settings for<br>
<br>
Returns:<br>
A gdata.data.GDEntry of the user's POP settings</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_send_as"><strong>retrieve_send_as</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves send-as aliases for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the send-as for<br>
<br>
Returns:<br>
A gdata.data.GDFeed of the user's send-as alias settings</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_signature"><strong>retrieve_signature</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves signature settings for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the signature settings for<br>
<br>
Returns:<br>
A gdata.data.GDEntry of the user's signature settings</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-retrieve_vacation"><strong>retrieve_vacation</strong></a>(self, username, **kwargs)</dt><dd><tt>Retrieves vacation settings for the specified username<br>
<br>
Args:<br>
username: string The name of the user to get the vacation settings for<br>
<br>
Returns:<br>
A gdata.data.GDEntry of the user's vacation auto-responder settings</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_forwarding"><strong>update_forwarding</strong></a>(self, username, enable, forward_to<font color="#909090">=None</font>, action<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Update Google Mail Forwarding settings.<br>
<br>
Args:<br>
username: string The name of the user.<br>
enable: Boolean Whether to enable incoming email forwarding.<br>
forward_to: (optional) string The address email will be forwarded to.<br>
action: string (optional) The action to perform after forwarding<br>
an email (ACTION_KEEP, ACTION_ARCHIVE, ACTION_DELETE).<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsForwarding of the<br>
updated resource</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_general_settings"><strong>update_general_settings</strong></a>(self, username, page_size<font color="#909090">=None</font>, shortcuts<font color="#909090">=None</font>, arrows<font color="#909090">=None</font>, snippets<font color="#909090">=None</font>, use_unicode<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Update Google Mail general settings.<br>
<br>
Args:<br>
username: string The name of the user.<br>
page_size: int (optional) The number of conversations to be shown per<br>
page.<br>
shortcuts: Boolean (optional) Whether to enable keyboard shortcuts.<br>
arrows: Boolean (optional) Whether to display arrow-shaped personal<br>
indicators next to email sent specifically to the user.<br>
snippets: Boolean (optional) Whether to display snippets of the messages<br>
in the inbox and when searching.<br>
use_unicode: Boolean (optional) Whether to use UTF-8 (unicode) encoding<br>
for all outgoing messages.<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsGeneral of the<br>
updated resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_imap"><strong>update_imap</strong></a>(self, username, enable, **kwargs)</dt><dd><tt>Update Google Mail IMAP settings.<br>
<br>
Args:<br>
username: string The name of the user.<br>
enable: Boolean Whether to enable IMAP access.language<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsImap of the updated resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_language"><strong>update_language</strong></a>(self, username, language, **kwargs)</dt><dd><tt>Update Google Mail language settings.<br>
<br>
Args:<br>
username: string The name of the user.<br>
language: string The language tag for Google Mail's display language.<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsLanguage of the<br>
updated resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_pop"><strong>update_pop</strong></a>(self, username, enable, enable_for<font color="#909090">=None</font>, action<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Update Google Mail POP settings.<br>
<br>
Args:<br>
username: string The name of the user.<br>
enable: Boolean Whether to enable incoming POP3 access.<br>
enable_for: string (optional) Whether to enable POP3 for all mail<br>
(POP_ENABLE_FOR_ALL_MAIL), or mail from now on<br>
(POP_ENABLE_FOR_MAIL_FROM_NOW_ON).<br>
action: string (optional) What Google Mail should do with its copy<br>
of the email after it is retrieved using POP (ACTION_KEEP,<br>
ACTION_ARCHIVE, ACTION_DELETE).<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsPop of the updated resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_signature"><strong>update_signature</strong></a>(self, username, signature, **kwargs)</dt><dd><tt>Update Google Mail signature.<br>
<br>
Args:<br>
username: string The name of the user.<br>
signature: string The signature to be appended to outgoing messages.<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsSignature of the<br>
updated resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_vacation"><strong>update_vacation</strong></a>(self, username, enable, subject<font color="#909090">=None</font>, message<font color="#909090">=None</font>, start_date<font color="#909090">=None</font>, end_date<font color="#909090">=None</font>, contacts_only<font color="#909090">=None</font>, domain_only<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Update Google Mail vacation-responder settings.<br>
<br>
Args:<br>
username: string The name of the user.<br>
enable: Boolean Whether to enable the vacation responder.<br>
subject: string (optional) The subject line of the vacation responder<br>
autoresponse.<br>
message: string (optional) The message body of the vacation responder<br>
autoresponse.<br>
startDate: string (optional) The start date of the vacation responder<br>
autoresponse.<br>
endDate: string (optional) The end date of the vacation responder<br>
autoresponse.<br>
contacts_only: Boolean (optional) Whether to only send autoresponses<br>
to known contacts.<br>
domain_only: Boolean (optional) Whether to only send autoresponses<br>
to users in the primary domain.<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsVacationResponder of the<br>
updated resource.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update_webclip"><strong>update_webclip</strong></a>(self, username, enable, **kwargs)</dt><dd><tt>Enable/Disable Google Mail web clip.<br>
<br>
Args:<br>
username: string The name of the user.<br>
enable: Boolean Whether to enable showing Web clips.<br>
kwargs: The other parameters to pass to the update method.<br>
<br>
Returns:<br>
gdata.apps.emailsettings.data.EmailSettingsWebClip of the<br>
updated resource.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>api_version</strong> = '2.0'</dl>
<dl><dt><strong>auth_scopes</strong> = ('https://apps-apis.google.com/a/feeds/user/', 'https://apps-apis.google.com/a/feeds/policies/', 'https://apps-apis.google.com/a/feeds/alias/', 'https://apps-apis.google.com/a/feeds/groups/', 'https://apps-apis.google.com/a/feeds/compliance/audit/', 'https://apps-apis.google.com/a/feeds/migration/', 'https://apps-apis.google.com/a/feeds/emailsettings/2.0/')</dl>
<dl><dt><strong>auth_service</strong> = 'apps'</dl>
<dl><dt><strong>host</strong> = 'apps-apis.google.com'</dl>
<dl><dt><strong>ssl</strong> = True</dl>
<hr>
Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><a name="EmailSettingsClient-Batch"><strong>Batch</strong></a> = batch(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
SpreadsheetsClient, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-Delete"><strong>Delete</strong></a> = delete(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-GetAccessToken"><strong>GetAccessToken</strong></a> = get_access_token(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-GetEntry"><strong>GetEntry</strong></a> = get_entry(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-GetFeed"><strong>GetFeed</strong></a> = get_feed(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-GetNext"><strong>GetNext</strong></a> = get_next(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-GetOAuthToken"><strong>GetOAuthToken</strong></a> = get_oauth_token(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-Post"><strong>Post</strong></a> = post(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-Request"><strong>Request</strong></a> = request(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="EmailSettingsClient-RevokeToken"><strong>RevokeToken</strong></a> = revoke_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-Update"><strong>Update</strong></a> = update(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-batch"><strong>batch</strong></a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
SpreadsheetsClient, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-delete"><strong>delete</strong></a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-get_access_token"><strong>get_access_token</strong></a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-get_entry"><strong>get_entry</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-get_feed"><strong>get_feed</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-get_next"><strong>get_next</strong></a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-get_oauth_token"><strong>get_oauth_token</strong></a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-post"><strong>post</strong></a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="EmailSettingsClient-request"><strong>request</strong></a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="EmailSettingsClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><strong>alt_auth_service</strong> = None</dl>
<hr>
Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><a name="EmailSettingsClient-Get"><strong>Get</strong></a> = get(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-Put"><strong>Put</strong></a> = put(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-get"><strong>get</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="EmailSettingsClient-put"><strong>put</strong></a>(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>auth_token</strong> = None</dl>
<dl><dt><strong>xoauth_requestor_id</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>ACTION_ARCHIVE</strong> = 'ARCHIVE'<br>
<strong>ACTION_DELETE</strong> = 'DELETE'<br>
<strong>ACTION_KEEP</strong> = 'KEEP'<br>
<strong>EMAIL_SETTINGS_URI_TEMPLATE</strong> = '/a/feeds/emailsettings/%s/%s/%s/%s'<br>
<strong>POP_ENABLE_FOR_ALL_MAIL</strong> = 'ALL_MAIL'<br>
<strong>POP_ENABLE_FOR_MAIL_FROM_NOW_ON</strong> = 'MAIL_FROM_NOW_ON'<br>
<strong>SETTING_ID_DELEGATION</strong> = 'delegation'<br>
<strong>SETTING_ID_FILTER</strong> = 'filter'<br>
<strong>SETTING_ID_FORWARDING</strong> = 'forwarding'<br>
<strong>SETTING_ID_GENERAL</strong> = 'general'<br>
<strong>SETTING_ID_IMAP</strong> = 'imap'<br>
<strong>SETTING_ID_LABEL</strong> = 'label'<br>
<strong>SETTING_ID_LANGUAGE</strong> = 'language'<br>
<strong>SETTING_ID_POP</strong> = 'pop'<br>
<strong>SETTING_ID_SENDAS</strong> = 'sendas'<br>
<strong>SETTING_ID_SIGNATURE</strong> = 'signature'<br>
<strong>SETTING_ID_VACATION_RESPONDER</strong> = 'vacation'<br>
<strong>SETTING_ID_WEBCLIP</strong> = 'webclip'<br>
<strong>__author__</strong> = 'Claudio Cherubino <ccherubino@google.com>'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">Claudio Cherubino <ccherubino@google.com></td></tr></table>
</body></html>