NAME

mborg - Command-line interface for Mailbox.org API

VERSION

version 0.100

SYNOPSIS

mborg --user=user@example.com --password=secret login

# Credentials via environment
WWW_MAILBOXORG_USER=user@example.com WWW_MAILBOXORG_PASSWORD=secret mborg login

# Credentials via config file (~/.mailboxrc)
mborg login

mborg account list
mborg account get user@example.com
mborg account add user@example.com secret123 basic
mborg account del user@example.com
mborg account set user@example.com plan=profi memo="Updated"

mborg domain list
mborg domain get example.com
mborg domain add admin@example.com example.com secret123
mborg domain del admin@example.com example.com
mborg domain set example.com password=newsecret

mborg mail list folder=INBOX unseen_only=1
mborg mail find "from:user@example.com"

mborg mailinglist list
mborg mailinglist get admin@example.com list@example.com
mborg mailinglist add admin@example.com list@example.com secret123
mborg mailinglist del admin@example.com list@example.com
mborg mailinglist set admin@example.com list@example.com password=newsecret
mborg mailinglist add_member admin@example.com list@example.com member@example.com
mborg mailinglist del_member admin@example.com list@example.com member@example.com
mborg mailinglist list_members admin@example.com list@example.com

mborg blacklist list admin@example.com
mborg blacklist add admin@example.com spam@example.com
mborg blacklist del admin@example.com spam@example.com

mborg spamprotect status admin@example.com
mborg spamprotect set admin@example.com 1

mborg videochat status admin@example.com
mborg videochat create_room admin@example.com "My Room"
mborg videochat list_rooms admin@example.com
mborg videochat delete_room admin@example.com "My Room"

mborg backup list admin@example.com
mborg backup create admin@example.com
mborg backup restore admin@example.com backup-id
mborg backup delete admin@example.com backup-id

mborg invoice list
mborg invoice get admin@example.com INV-2024-001
mborg invoice download admin@example.com INV-2024-001

mborg passwordreset request user@example.com
mborg passwordreset set user@example.com token-from-email newsecret123

mborg validate email=user@example.com

mborg utils parse_headers "From: user@example.com"
mborg utils parse_date "Mon, 01 Jan 2024 12:00:00 +0000"
mborg utils generate_message_id

mborg system hello
mborg system test
mborg system capabilities

DESCRIPTION

mborg is the command-line interface for WWW::MailboxOrg. It provides access to all Mailbox.org API endpoints via subcommands.

Credentials can be provided via:

--user and --password command-line options
Environment variables WWW_MAILBOXORG_USER and WWW_MAILBOXORG_PASSWORD
Configuration file ~/.mailboxrc with user= and password= entries

NAME

mborg - Command-line interface for WWW::MailboxOrg

OPTIONS

--user, -u: Mailbox.org username or email address.
--password, -p: Mailbox.org password.
--base_url, -b: API base URL. Defaults to https://api.mailbox.org/v1.
--verbose, -v: Be verbose — print progress messages.
--help, -h: Show this help message.
--version, -V: Show version number.

COMMANDS

mborg login

Authenticate with Mailbox.org API and establish a session. Credentials are required (see "OPTIONS").

logout

mborg logout

End the current session.

account

mborg account list
mborg account get <email>
mborg account add <email> <password> <plan>
mborg account del <email>
mborg account set <email> [key=value ...]

Manage Mailbox.org accounts.

list: List all accounts, optionally filtered by account.
get: Get details for a specific account.
add: Create a new account. Required: account, password, plan (basic, profi, profixl, or reseller).
del: Delete an account.
set: Update account settings. At minimum account is required. Additional parameters: password, plan, tarifflimits, address_payment_*, av_contract_accept_name, memo.

domain

mborg domain list [account=<email>]
mborg domain get <domain>
mborg domain add <account> <domain> <password> [key=value ...]
mborg domain del <account> <domain>
mborg domain set <domain> [key=value ...]

Manage domains.

list: List domains, optionally filtered by account.
get: Get details for a specific domain.
add: Add a new domain. Required: account, domain, password. Optional: context_id, create_new_context_id, memo.
del: Delete a domain.
set: Update domain settings. At minimum domain is required. Optional: password, context_id, create_new_context_id, memo.

mail

mborg mail list [key=value ...]
mborg mail find <query>

Email operations.

list: List emails. Options: account, folder, order_by, page, per_page, result_mode, unseen_only.
find: Search emails. Required: query string.

mailinglist

mborg mailinglist list [account=<email>]
mborg mailinglist get <account> <list>
mborg mailinglist add <account> <list> <password> [key=value ...]
mborg mailinglist del <account> <list>
mborg mailinglist set <account> <list> [key=value ...]
mborg mailinglist add_member <account> <list> <email>
mborg mailinglist del_member <account> <list> <email>
mborg mailinglist list_members <account> <list>

Mailing list management.

list: List mailing lists, optionally filtered by account.
get: Get mailing list details.
add: Create a mailing list. Required: account, list, password. Optional: memo.
del: Delete a mailing list.
set: Update mailing list. Required: account, list. Optional: password, memo.
add_member: Add a member to a mailing list. Required: account, list, email.
del_member: Remove a member from a mailing list. Required: account, list, email.
list_members: List all members of a mailing list. Required: account, list.

blacklist

mborg blacklist list <account>
mborg blacklist add <account> <email>
mborg blacklist del <account> <email>

Manage email blacklist entries.

list: List blacklist entries for an account. Required: account.
add: Add an email to the blacklist. Required: account, email.
del: Remove an email from the blacklist. Required: account, email.

spamprotect

mborg spamprotect status <account>
mborg spamprotect set <account> <0|1>

Spam protection management.

status: Get spam protection status. Required: account.
set: Enable or disable spam protection. Required: account, active (0 or 1).

videochat

mborg videochat status <account>
mborg videochat create_room <account> <name>
mborg videochat list_rooms <account>
mborg videochat delete_room <account> <name>

Video chat room management.

status: Get video chat status. Required: account.
create_room: Create a video chat room. Required: account, name.
list_rooms: List video chat rooms. Required: account.
delete_room: Delete a video chat room. Required: account, name.

backup

mborg backup list <account>
mborg backup create <account>
mborg backup restore <account> <backupid>
mborg backup delete <account> <backupid>

Backup operations.

list: List backups for an account. Required: account.
create: Create a backup. Required: account.
restore: Restore a backup. Required: account, backup.
delete: Delete a backup. Required: account, backup.

invoice

mborg invoice list [account=<email>]
mborg invoice get <account> <invoice>
mborg invoice download <account> <invoice>

Invoice operations.

list: List invoices, optionally filtered by account.
get: Get invoice details. Required: account, invoice.
download: Download an invoice. Required: account, invoice.

passwordreset

mborg passwordreset request <account>
mborg passwordreset set <account> <token> <newpassword>

Password reset operations.

request: Request a password reset. Required: account.
set: Set a new password using a reset token. Required: account, token, newpassword.

validate

mborg validate email=<address>

Validate an email address.

email: Validate an email address. Required: email.

utils

mborg utils parse_headers headers=<raw>
mborg utils parse_date date=<string>
mborg utils generate_message_id [account=<email>]

Utility functions.

parse_headers: Parse raw email headers. Required: headers.
parse_date: Parse an email date string. Required: date.
generate_message_id: Generate a message ID. Optional: account.

system

mborg system hello
mborg system test
mborg system capabilities

System information.

hello: Get API hello response.
test: Test API connection.
capabilities: Get API capabilities.

CONFIGURATION

Create a ~/.mailboxrc file in your home directory:

user=user@example.com
password=secret
base_url=https://api.mailbox.org/v1

Lines starting with # are comments.

ENVIRONMENT

All environment variables are namespaced with the WWW_MAILBOXORG_ prefix. Command-line options and the ~/.mailboxrc config file take precedence.

WWW_MAILBOXORG_USER: Mailbox.org username or email address.
WWW_MAILBOXORG_PASSWORD: Mailbox.org password.
WWW_MAILBOXORG_BASE_URL: API base URL. Defaults to https://api.mailbox.org/v1.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-www-mailboxorg/issues.

IRC

Join #perl-help on irc.perl.org or message Getty directly.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install WWW::MailboxOrg, copy and paste the appropriate command in to your terminal.

cpanm

cpanm WWW::MailboxOrg

CPAN shell

perl -MCPAN -e shell
install WWW::MailboxOrg

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

NAME

OPTIONS

COMMANDS

login

logout

account

domain

mail

mailinglist

blacklist

spamprotect

videochat

backup

invoice

passwordreset

validate

utils

system

CONFIGURATION

ENVIRONMENT

SEE ALSO

SUPPORT

Issues

IRC

CONTRIBUTING

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions

Keyboard Shortcuts