ユーザーのメールエイリアスのリストを取得

get
https://api.box.com/2.0
/users/:user_id/email_aliases

ユーザーのすべてのメールエイリアスを取得します。コレクションにユーザーのプライマリログインは含まれません。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ユーザーのID。

レスポンス

メールエイリアスのコレクションを返します。

予期しないクライアントエラー。

get
ユーザーのメールエイリアスのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/users/12345/email_aliases" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollection<BoxEmailAlias> aliases = await client.UsersManager
    .GetEmailAliasesAsync(userId: "33333");
Java
BoxUser user = new BoxUser(api, "0");
Collection<EmailAlias> emailAliases = user.getEmailAliases();
Python
user_id = '33333'
user = client.user(user_id)
email_aliases = user.get_email_aliases()
for alias in email_aliases:
    print(f'User {user.id} has email alias {alias.email}')
Node
client.users.getEmailAliases('33333')
    .then(emailAliases => {
        /* emailAliases -> {
            total_count: 2,
            entries: 
            [ { type: 'email_alias',
                id: '1234',
                is_confirmed: true,
                email: 'user+foo@example.com' },
                { type: 'email_alias',
                id: '1235',
                is_confirmed: true,
                email: 'user+bar@example.com' } ] }
        */
    });
iOS
client.users.listEmailAliases(userId: "33333") { (result: Result<EntryContainer<User>, BoxSDKError>) in
    guard case let .success(aliasCollection) = result else {
        print("Error retrieving email aliases")
        return
    }

    print("User has \(aliasCollection.totalCount) email aliases:")
    for alias in aliasCollection.entries {
        print("- \(alias.email) (\(alias.isConfirmed ? "Confirmed" : "Not Confirmed"))")
    }
}

レスポンスの例

{
  "entries": [
    {
      "id": "11446498",
      "type": "email_alias",
      "email": "alias@example.com",
      "is_confirmed": true
    }
  ],
  "total_count": 5000
}