Retrieve Physical Address

print_mail.virtual_mailboxes.retrieve_address() -> VirtualMailboxRetrieveAddressResponse

GET/print-mail/v1/virtual_mailboxes/{id}/address

Retrieves the physical address of the virtual mailbox.

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class VirtualMailboxRetrieveAddressResponse: …

The address information for a mailbox.

address_line1: str

The address line 1 of the mailbox.

country_code: Literal["US"]

All of the supported countries for virtual mailboxes.

address_line2: Optional[str]

The address line 2 of the mailbox.

city: Optional[str]

The city of the mailbox.

postal_or_zip: Optional[str]

The postal or ZIP code of the mailbox.

province_or_state: Optional[str]

The province or state of the mailbox.

Retrieve Physical Address

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
response = client.print_mail.virtual_mailboxes.retrieve_address(
    "id",
)
print(response.address_line1)

{
  "addressLine1": "145 Mulberry st",
  "city": "New York",
  "provinceOrState": "NY",
  "postalOrZip": "10013",
  "countryCode": "US"
}

Returns Examples

{
  "addressLine1": "145 Mulberry st",
  "city": "New York",
  "provinceOrState": "NY",
  "postalOrZip": "10013",
  "countryCode": "US"
}