Listing mailboxes

How to use API 2.0 to get a list of mailboxes added to your Woodpecker account

Weronika Wróblewska avatar
Written by Weronika Wróblewska
Updated this week

To get a list of all mailboxes added to your Woodpecker account, use the following request:

GET https://api.woodpecker.co/rest/v2/mailboxes

Sample response:

[
{
"id": 123,
"type": "IMAP",
"details": {
"email": "[email protected]",
"provider": "GOOGLE",
"login": "[email protected]",
"server": "imap.gmail.com",
"port": 993,
"private": false
}
},
{
"id": 234,
"type": "SMTP",
"details": {
"email": "[email protected]",
"provider": "MAILGUN",
"login": "jared.dunn",
"server": "smtp.mailgun.org",
"port": 987,
"from_name": "Jared from Pied Piper",
"error": "Connected conditionally.",
"imap_id": 123,
"daily_limit": 500,
"sent_today": 25,
"frequency_from": 90000,
"frequency_to": 140000,
"bcc_crm": "",
"signature": "<div>Here will be your signature wrapped in HTML.</div>",
"open_url": "",
"click_url": "",
"unsubscribe_url": "",
"freeze_account": [ {
"from": "2022-07-06T00:00:00+0200",
"to": "2022-07-06T23:59:59+0200"
},
{
"from": "2022-08-06T00:00:00+0200",
"to": "2022-08-06T23:59:59+0200"
} ],
"in_slot": true,
}
},
{
"id": 345,
"type": "SMTP",
"details": {
"email": "[email protected]",
"provider": "GOOGLE",
"login": "[email protected]",
"server": "smtp.gmail.com",
"port": 654,
"from_name": "Jared from Pied Piper",
"error": "",
"imap_id": 123,
"daily_limit": 500,
"sent_today": 50,
"frequency_from": 90000,
"frequency_to": 140000,
"bcc_crm": "[email protected]",
"signature": "",
"open_url": "",
"click_url": "",
"unsubscribe_url": "",
"freeze_account": "",
"in_slot": false,
}
}
]

Response type data:

  • id - number, SMTP or IMAP ID.

  • imap - JSON object, a set of information about IMAP.

  • smtp - JSON object, a set of information about SMTP.

  • email - string, IMAP/SMTP email address.

  • provider - string, a type of provider (e.g. Google, Exchange, Office 365)

  • login - string, a mailbox login.

  • server - string, SMTP/IMAP server.

  • port - number, SMTP/IMAP port.

  • error - string, indicating wether a mailbox error occured.

  • private - boolean, IMAP setting indicates whether we download all incoming messages (false) or only those related to Woodpecker prospects (true).

  • from_name - string, a name associated with email account.

  • daily_limit - number, a daily sending limit set up in mailbox settings.

  • sent_today - number, number of emails sent from the specific mailbox at the moment of making the request.

  • frequency_from - number, a minimum time period in miliseconds between sending messages.

  • frequency_to - number, a maximum time period in miliseconds between sending messages.

  • bcc_crm - string, CRM email address.

  • signature - string, email signature.

  • open_url - string, custom tracking domain.

  • click_url - string, custom tracking domain.

  • unsubscribe_url - string, custom tracking domain.

  • freeze_account - JSON object, time periods when the email account is going to be freezed.

  • in_slot - boolean, information about whether a specific mailbox is active or not (SMTP only).

  • warm_up - JSON object, includes infromation about warm-up process if a mailbox is in the warm-up mode // deprecated, won't be supported after April 4th.

  • status - string, warm-up status. Available statuses: RUNNING.

  • mode - string, warm-up mode (domain or email).

  • estimated_end - string, estimated end of a warm-up process.

  • imap_id - number, ID of an IMAP associated with the given SMTP. Check Note for more details.

Note:

You can associate multiple SMTPs with one IMAP.


Want to integrate with us?

If you're interested in building a native integration with Woodpecker, fill out this form and we'll get back to you.

Did this answer your question?