1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
|
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package gdata.apps.migration</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>.migration</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/svn/gdata-python-client/src/gdata/apps/migration/__init__.py">/usr/local/svn/gdata-python-client/src/gdata/apps/migration/__init__.py</a></font></td></tr></table>
<p><tt>Contains objects used with Google Apps.</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>Package Contents</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.apps.migration.service.html">service</a><br>
</td><td width="25%" valign=top></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="atom.html#AtomBase">atom.AtomBase</a>(<a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.apps.migration.html#Label">Label</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.apps.migration.html#MailItemProperty">MailItemProperty</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.apps.migration.html#Rfc822Msg">Rfc822Msg</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchEntry">gdata.BatchEntry</a>(<a href="gdata.html#GDataEntry">gdata.GDataEntry</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.apps.migration.html#BatchMailEntry">BatchMailEntry</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchFeed">gdata.BatchFeed</a>(<a href="gdata.html#GDataFeed">gdata.GDataFeed</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.apps.migration.html#BatchMailEventFeed">BatchMailEventFeed</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataEntry">gdata.GDataEntry</a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">gdata.LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.apps.migration.html#MailEntry">MailEntry</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="BatchMailEntry">class <strong>BatchMailEntry</strong></a>(<a href="gdata.html#BatchEntry">gdata.BatchEntry</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A Google Migration flavor of an Atom Entry.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.migration.html#BatchMailEntry">BatchMailEntry</a></dd>
<dd><a href="gdata.html#BatchEntry">gdata.BatchEntry</a></dd>
<dd><a href="gdata.html#GDataEntry">gdata.GDataEntry</a></dd>
<dd><a href="atom.html#Entry">atom.Entry</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">gdata.LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchMailEntry-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, content<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, published<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, rfc822_msg<font color="#909090">=None</font>, mail_item_property<font color="#909090">=None</font>, label<font color="#909090">=None</font>, batch_operation<font color="#909090">=None</font>, batch_id<font color="#909090">=None</font>, batch_status<font color="#909090">=None</font>, extended_property<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="gdata.html#GDataEntry">gdata.GDataEntry</a>:<br>
<dl><dt><a name="BatchMailEntry-GetMediaURL"><strong>GetMediaURL</strong></a>(self)</dt><dd><tt>Returns the URL to the media content, if the entry is a media entry.<br>
Otherwise returns None.</tt></dd></dl>
<dl><dt><a name="BatchMailEntry-IsMedia"><strong>IsMedia</strong></a>(self)</dt><dd><tt>Determines whether or not an entry is a GData Media entry.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataEntry">gdata.GDataEntry</a>:<br>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchMailEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchMailEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchMailEntry-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this object whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">gdata.LinkFinder</a>:<br>
<dl><dt><a name="BatchMailEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="BatchMailEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="BatchMailEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEntry-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="BatchMailEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEntry-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="BatchMailEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</dt></dl>
</td></tr></table> <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="BatchMailEventFeed">class <strong>BatchMailEventFeed</strong></a>(<a href="gdata.html#BatchFeed">gdata.BatchFeed</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A Migration event feed flavor of an Atom Feed.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.migration.html#BatchMailEventFeed">BatchMailEventFeed</a></dd>
<dd><a href="gdata.html#BatchFeed">gdata.BatchFeed</a></dd>
<dd><a href="gdata.html#GDataFeed">gdata.GDataFeed</a></dd>
<dd><a href="atom.html#Feed">atom.Feed</a></dd>
<dd><a href="atom.html#Source">atom.Source</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">gdata.LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchMailEventFeed-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, contributor<font color="#909090">=None</font>, generator<font color="#909090">=None</font>, icon<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, logo<font color="#909090">=None</font>, rights<font color="#909090">=None</font>, subtitle<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, total_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, items_per_page<font color="#909090">=None</font>, interrupted<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="gdata.html#BatchFeed">gdata.BatchFeed</a>:<br>
<dl><dt><a name="BatchMailEventFeed-AddBatchEntry"><strong>AddBatchEntry</strong></a>(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a <a href="gdata.html#BatchEntry">BatchEntry</a> and adding to the feed.<br>
<br>
<br>
If the entry is not a <a href="gdata.html#BatchEntry">BatchEntry</a>, it is converted to a <a href="gdata.html#BatchEntry">BatchEntry</a> so<br>
that the batch specific members will be present.<br>
<br>
The id_url_string can be used in place of an entry if the batch operation<br>
applies to a URL. For example query and delete operations require just<br>
the URL of an entry, no body is sent in the HTTP request. If an<br>
id_url_string is sent instead of an entry, a <a href="gdata.html#BatchEntry">BatchEntry</a> is created and<br>
added to the feed.<br>
<br>
This method also assigns the desired batch id to the entry so that it<br>
can be referenced in the server's response. If the batch_id_string is<br>
None, this method will assign a batch_id to be the index at which this<br>
entry will be in the feed's entry list.<br>
<br>
Args:<br>
entry: <a href="gdata.html#BatchEntry">BatchEntry</a>, atom.Entry, or another Entry flavor (optional) The<br>
entry which will be sent to the server as part of the batch request.<br>
The item must have a valid atom id so that the server knows which<br>
entry this request references.<br>
id_url_string: str (optional) The URL of the entry to be acted on. You<br>
can find this URL in the text member of the atom id for an entry.<br>
If an entry is not sent, this id will be used to construct a new<br>
<a href="gdata.html#BatchEntry">BatchEntry</a> which will be added to the request feed.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. Note that batch_ids should either always be specified or<br>
never, mixing could potentially result in duplicate batch ids.<br>
operation_string: str (optional) The desired batch operation which will<br>
set the batch_operation.type member of the entry. Options are<br>
'insert', 'update', 'delete', and 'query'<br>
<br>
Raises:<br>
MissingRequiredParameters: Raised if neither an id_ url_string nor an<br>
entry are provided in the request.<br>
<br>
Returns:<br>
The added entry.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-AddDelete"><strong>AddDelete</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br>
<br>
This method takes either the url_string which is the atom id of the item<br>
to be deleted, or the entry itself. The atom id of the entry must be<br>
present so that the server knows which entry should be deleted.<br>
<br>
Args:<br>
url_string: str (optional) The URL of the entry to be deleted. You can<br>
find this URL in the text member of the atom id for an entry.<br>
entry: <a href="gdata.html#BatchEntry">BatchEntry</a> (optional) The entry to be deleted.<br>
batch_id_string: str (optional)<br>
<br>
Raises:<br>
MissingRequiredParameters: Raised if neither a url_string nor an entry<br>
are provided in the request.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-AddInsert"><strong>AddInsert</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br>
<br>
If the entry doesn't yet have an operation or a batch id, these will<br>
be set to the insert operation and a batch_id specified as a parameter.<br>
<br>
Args:<br>
entry: <a href="gdata.html#BatchEntry">BatchEntry</a> The entry which will be sent in the batch feed as an<br>
insert request.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. Note that batch_ids should either always be specified or<br>
never, mixing could potentially result in duplicate batch ids.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-AddQuery"><strong>AddQuery</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br>
<br>
This method takes either the url_string which is the query URL<br>
whose results will be added to the result feed. The query URL will<br>
be encapsulated in a <a href="gdata.html#BatchEntry">BatchEntry</a>, and you may pass in the <a href="gdata.html#BatchEntry">BatchEntry</a><br>
with a query URL instead of sending a url_string.<br>
<br>
Args:<br>
url_string: str (optional)<br>
entry: <a href="gdata.html#BatchEntry">BatchEntry</a> (optional)<br>
batch_id_string: str (optional)<br>
<br>
Raises:<br>
MissingRequiredParameters</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-AddUpdate"><strong>AddUpdate</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br>
<br>
Sets the operation type of the entry to insert if it is not already set<br>
and assigns the desired batch id to the entry so that it can be<br>
referenced in the server's response.<br>
<br>
Args:<br>
entry: <a href="gdata.html#BatchEntry">BatchEntry</a> The entry which will be sent to the server as an<br>
update (HTTP PUT) request. The item must have a valid atom id<br>
so that the server knows which entry to replace.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. See also comments for AddInsert.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-GetBatchLink"><strong>GetBatchLink</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataFeed">gdata.GDataFeed</a>:<br>
<dl><dt><strong>generator</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchMailEventFeed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchMailEventFeed-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this object whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">gdata.LinkFinder</a>:<br>
<dl><dt><a name="BatchMailEventFeed-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEventFeed-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEventFeed-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEventFeed-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEventFeed-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="BatchMailEventFeed-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEventFeed-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="BatchMailEventFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchMailEventFeed-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</dt></dl>
</td></tr></table> <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="Label">class <strong>Label</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Migration label element.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.migration.html#Label">Label</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Label-__init__"><strong>__init__</strong></a>(self, label_name<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="Label-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="Label-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="Label-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this object whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
</td></tr></table> <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="MailEntry">class <strong>MailEntry</strong></a>(<a href="gdata.html#GDataEntry">gdata.GDataEntry</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A Google Migration flavor of an Atom Entry.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.migration.html#MailEntry">MailEntry</a></dd>
<dd><a href="gdata.html#GDataEntry">gdata.GDataEntry</a></dd>
<dd><a href="atom.html#Entry">atom.Entry</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">gdata.LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="MailEntry-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, content<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, published<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, rfc822_msg<font color="#909090">=None</font>, mail_item_property<font color="#909090">=None</font>, label<font color="#909090">=None</font>, extended_property<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="gdata.html#GDataEntry">gdata.GDataEntry</a>:<br>
<dl><dt><a name="MailEntry-GetMediaURL"><strong>GetMediaURL</strong></a>(self)</dt><dd><tt>Returns the URL to the media content, if the entry is a media entry.<br>
Otherwise returns None.</tt></dd></dl>
<dl><dt><a name="MailEntry-IsMedia"><strong>IsMedia</strong></a>(self)</dt><dd><tt>Determines whether or not an entry is a GData Media entry.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataEntry">gdata.GDataEntry</a>:<br>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="MailEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="MailEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="MailEntry-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this object whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">gdata.LinkFinder</a>:<br>
<dl><dt><a name="MailEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="MailEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="MailEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="MailEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="MailEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="MailEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="MailEntry-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="MailEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="MailEntry-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="MailEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="MailEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</dt></dl>
</td></tr></table> <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="MailItemProperty">class <strong>MailItemProperty</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Migration mailItemProperty element.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.migration.html#MailItemProperty">MailItemProperty</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="MailItemProperty-__init__"><strong>__init__</strong></a>(self, value<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="MailItemProperty-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="MailItemProperty-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="MailItemProperty-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this object whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
</td></tr></table> <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="Rfc822Msg">class <strong>Rfc822Msg</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Migration rfc822Msg element.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.migration.html#Rfc822Msg">Rfc822Msg</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Rfc822Msg-__init__"><strong>__init__</strong></a>(self, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="Rfc822Msg-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="Rfc822Msg-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="Rfc822Msg-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this object whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-BatchMailEntryFromString"><strong>BatchMailEntryFromString</strong></a>(xml_string)</dt><dd><tt>Parse in the <a href="#BatchMailEntry">BatchMailEntry</a> from the XML definition.</tt></dd></dl>
<dl><dt><a name="-BatchMailEventFeedFromString"><strong>BatchMailEventFeedFromString</strong></a>(xml_string)</dt><dd><tt>Parse in the <a href="#BatchMailEventFeed">BatchMailEventFeed</a> from the XML definition.</tt></dd></dl>
<dl><dt><a name="-LabelFromString"><strong>LabelFromString</strong></a>(xml_string)</dt><dd><tt>Parse in the mailItemProperty from the XML definition.</tt></dd></dl>
<dl><dt><a name="-MailEntryFromString"><strong>MailEntryFromString</strong></a>(xml_string)</dt><dd><tt>Parse in the <a href="#MailEntry">MailEntry</a> from the XML definition.</tt></dd></dl>
<dl><dt><a name="-MailItemPropertyFromString"><strong>MailItemPropertyFromString</strong></a>(xml_string)</dt><dd><tt>Parse in the MailItemProperiy from the XML definition.</tt></dd></dl>
<dl><dt><a name="-Rfc822MsgFromString"><strong>Rfc822MsgFromString</strong></a>(xml_string)</dt><dd><tt>Parse in the Rrc822 message from the XML definition.</tt></dd></dl>
</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>APPS_NAMESPACE</strong> = 'http://schemas.google.com/apps/2006'<br>
<strong>APPS_TEMPLATE</strong> = '{http://schemas.google.com/apps/2006}%s'<br>
<strong>__author__</strong> = 'google-apps-apis@googlegroups.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%">google-apps-apis@googlegroups.com</td></tr></table>
</body></html>
|
