• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.forwardingAddresses.html">forwardingAddresses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(userId, body)</a></code></p>
79<p class="firstline">Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(userId, forwardingEmail)</a></code></p>
82<p class="firstline">Deletes the specified forwarding address and revokes any verification that may have been required.</p>
83<p class="toc_element">
84  <code><a href="#get">get(userId, forwardingEmail)</a></code></p>
85<p class="firstline">Gets the specified forwarding address.</p>
86<p class="toc_element">
87  <code><a href="#list">list(userId)</a></code></p>
88<p class="firstline">Lists the forwarding addresses for the specified account.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="create">create(userId, body)</code>
92  <pre>Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted.
93
94This method is only available to service account clients that have been delegated domain-wide authority.
95
96Args:
97  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
98  body: object, The request body. (required)
99    The object takes the form of:
100
101{ # Settings for a forwarding address.
102    "forwardingEmail": "A String", # An email address to which messages can be forwarded.
103    "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
104  }
105
106
107Returns:
108  An object of the form:
109
110    { # Settings for a forwarding address.
111      "forwardingEmail": "A String", # An email address to which messages can be forwarded.
112      "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
113    }</pre>
114</div>
115
116<div class="method">
117    <code class="details" id="delete">delete(userId, forwardingEmail)</code>
118  <pre>Deletes the specified forwarding address and revokes any verification that may have been required.
119
120This method is only available to service account clients that have been delegated domain-wide authority.
121
122Args:
123  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
124  forwardingEmail: string, The forwarding address to be deleted. (required)
125</pre>
126</div>
127
128<div class="method">
129    <code class="details" id="get">get(userId, forwardingEmail)</code>
130  <pre>Gets the specified forwarding address.
131
132Args:
133  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
134  forwardingEmail: string, The forwarding address to be retrieved. (required)
135
136Returns:
137  An object of the form:
138
139    { # Settings for a forwarding address.
140      "forwardingEmail": "A String", # An email address to which messages can be forwarded.
141      "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
142    }</pre>
143</div>
144
145<div class="method">
146    <code class="details" id="list">list(userId)</code>
147  <pre>Lists the forwarding addresses for the specified account.
148
149Args:
150  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
151
152Returns:
153  An object of the form:
154
155    { # Response for the ListForwardingAddresses method.
156    "forwardingAddresses": [ # List of addresses that may be used for forwarding.
157      { # Settings for a forwarding address.
158          "forwardingEmail": "A String", # An email address to which messages can be forwarded.
159          "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
160        },
161    ],
162  }</pre>
163</div>
164
165</body></html>