Skip to content

email

konigle.cli.comm.email

CLI commands for email communication operations.

accounts()

Email account management commands.

channels()

Email channel management commands.

check_account_status(ctx)

Check the status of email accounts.

check_verification_status(ctx, identity_id)

Check verification status for an email identity.

create_account(ctx, name, from_email, from_name, reply_to_email, reply_to_name)

Create a new email account.

create_channel(ctx, code, channel_type)

Create a new email channel.

create_identity(ctx, value)

Create a new email identity.

create_template(ctx, name, code, subject, body_html, body_text, tags, is_base)

Create a new email template.

delete_account(ctx, account_id, yes)

Delete an email account.

delete_channel(ctx, channel_id, yes)

Delete an email channel.

delete_identity(ctx, identity_id, yes)

Delete an email identity.

delete_template(ctx, template_id, yes)

Delete an email template.

email()

Email communication commands.

get_account(ctx, account_id)

Get an email account by ID.

get_channel(ctx, channel_id)

Get an email channel by ID.

get_identity(ctx, identity_id)

Get an email identity by ID.

get_template(ctx, template_id)

Get an email template by ID.

identities()

Email identity management commands.

list_accounts(ctx, page, page_size)

List email accounts.

list_channels(ctx, page, page_size, search, channel_type, status)

List email channels.

list_identities(ctx, page, page_size, search, identity_type)

List email identities.

list_templates(ctx, page, page_size, search, tags, is_base, ordering)

List email templates.

print_dns_records(records, record_type='DNS', domain_context='')

Print DNS records in a consistent format.

print_verification_help(identity_id, record_type='verification')

Print help text for DNS verification.

send_email(ctx, to_emails, subject, body_html, body_text, from_email, reply_to_email, channel, category, attachments, save_as_template, headers)

Send an email through the Konigle email service.

set_engagement_tracking(ctx, channel_id, enable)

Enable or disable engagement tracking for an email channel.

setup_account(ctx, name, from_email, reply_to_email, identity_value)

Setup a new email account with default channels and identity.

setup_custom_mail_from(ctx, identity_id, mail_from_domain)

Setup custom MAIL FROM domain for an email identity.

templates()

Email template management commands.

update_account(ctx, account_id, name, from_email, from_name, reply_to_email, reply_to_name)

Update an email account.

update_channel(ctx, channel_id, code)

Update an email channel.

update_identity(ctx, identity_id, use_custom_mail_from)

Update an email identity.

update_template(ctx, template_id, name, code, subject, body_html, body_text, tags, is_base)

Update an email template.